fsleyes.profiles.timeseriesprofile

This module provides the TimeSeriesProfile class, an interaction profile for the TimeSeriesPanel.

class fsleyes.profiles.timeseriesprofile.TimeSeriesProfile(viewPanel, overlayList, displayCtx)

Bases: fsleyes.profiles.plotprofile.PlotProfile

The TimeSeriesProfile is a PlotProfile for use with the TimeSeriesPanel.

In addition to the panzoom mode provided by the PlotProfile class, the TimeSeriesProfile class implements a volume mode, in which the user is able to click/drag on a plot to change the VolumeOpts.volume for the currently selected overlay.

__init__(viewPanel, overlayList, displayCtx)

Create a TimeSeriesProfile.

Parameters:
_volumeModeLeftMouseDown(ev, canvas, mousePos, canvasPos)

Adds a vertical line to the plot at the current volume.

_volumeModeLeftMouseDrag(ev, canvas, mousePos, canvasPos)

Updates the position of the vertical volume line.

_volumeModeLeftMouseUp(ev, canvas, mousePos, canvasPos)

Removes the vertical volume line.

_TimeSeriesProfile__updateVolume(volumeLine, xvalue)

Called by the volume event handlers. Updates the given volumeLine artist (assumed to be a matplotlib.Line2D instance) so that it is located at the given xvalue. Also updates the VolumeOpts.volume property of the currently selected overlay accordingly.

_TimeSeriesProfile__volumeModeCompatible()

Returns True if a volume line can currently be shown, False otherwise.

__module__ = 'fsleyes.profiles.timeseriesprofile'