fsleyes.profiles.timeseriesprofile
¶
This module provides the TimeSeriesProfile
class, an interaction
profile for the TimeSeriesPanel
.
-
class
fsleyes.profiles.timeseriesprofile.
TimeSeriesProfile
(viewPanel, overlayList, displayCtx)[source]¶ Bases:
fsleyes.profiles.plotprofile.PlotProfile
The
TimeSeriesProfile
is aPlotProfile
for use with theTimeSeriesPanel
.In addition to the
panzoom
mode provided by thePlotProfile
class, theTimeSeriesProfile
class implements avolume
mode, in which the user is able to click/drag on a plot to change theVolumeOpts.volume
for the currently selected overlay.-
static
supportedView
()[source]¶ Returns the
TimeSeriesPanel
class.
-
static
tempModes
()[source]¶ Returns the temporary mode map for the
TimeSeriesProfile
, which controls the use of modifier keys to temporarily enter other interaction modes.
-
__init__
(viewPanel, overlayList, displayCtx)[source]¶ Create a
TimeSeriesProfile
.- Parameters
viewPanel – A
TimeSeriesPanel
instance.overlayList – The
OverlayList
instance.displayCtx – The
DisplayContext
instance.
-
__volumeModeCompatible
()¶ Returns
True
if a volume line can currently be shown,False
otherwise.
-
__updateVolume
(volumeLine, xvalue)¶ Called by the
volume
event handlers. Updates the givenvolumeLine
artist (assumed to be amatplotlib.Line2D
instance) so that it is located at the givenxvalue
. Also updates theVolumeOpts.volume
property of the currently selected overlay accordingly.
-
_volumeModeLeftMouseDown
(ev, canvas, mousePos, canvasPos)[source]¶ Adds a vertical line to the plot at the current volume.
-
_volumeModeLeftMouseDrag
(ev, canvas, mousePos, canvasPos)[source]¶ Updates the position of the vertical volume line.
-
__module__
= 'fsleyes.profiles.timeseriesprofile'¶
-
static