PlotAccessor.event_current¶
Module: pl.py
Visualize events generated by detect_events on a single current trace.
Parameters¶
sample_id(str | None): Trace id; None selects first trace.current(str):rawordenoise.start_event(int): 1-based start event index (inclusive).end_event(int): 1-based end event index (inclusive intent).start_ms(float): Fallback start time when selected range has no events.end_ms(float): Fallback end time when selected range has no events.ylim(tuple[float, float] | None): Optional y-axis range.width(float): Figure width.height(float): Figure height.
Notes¶
- The selected event range is highlighted with red vertical dashed lines at each event start/end.
- Reads events from
analysis.eventsgenerated byanalysis.detect_events(...). - If
analysis.eventsis empty, this method triggersanalysis.detect_events(...)automatically.
Returns¶
matplotlib Axes