fsleyes.controls.timeseriescontrolpanel
¶
This module provides the TimeSeriesControlPanel
a FSLeyes
control which allows the user to configure a TimeSeriesPanel
.
-
class
fsleyes.controls.timeseriescontrolpanel.
TimeSeriesControlPanel
(*args, **kwargs)[source]¶ Bases:
fsleyes.controls.plotcontrolpanel.PlotControlPanel
The
TimeSeriesControlPanel
is aPlotContrlPanel
which allows the user to configure aTimeSeriesPanel
. It contains controls which are linked to the properties of theTimeSeriesPanel
, (which include properties defined on thePlotPanel
base class), and theDataSeries
class.A
TimeSeriesControlPanel
looks something like this:The settings shown on a
TimeSeriesControlPanel
are organised into three or four sections:The Time series plot settings section has controls which are linked to properties of the
PlotCanvas
class.The General plot settings section has controls which are linked to properties of the
PlotPanel
base class.The Settings for the current time course section has controls which are linked to properties of the
DataSeries
class. These properties define how the current time course is displayed (see theTimeSeriesPanel
class documentation).The FEAT plot settings is only shown if the currently selected overlay is a
FEATImage
. It has controls which are linked to properties of theFEATTimeSeries
class.
-
static
supportedViews
()[source]¶ Overrides
ControlMixin.supportedViews()
. TheTimeSeriesControlPanel
is only intended to be added toTimeSeriesPanel
views.
-
static
defaultLayout
()[source]¶ Returns a dictionary containing layout settings to be passed to
ViewPanel.togglePanel
.
-
__init__
(*args, **kwargs)[source]¶ Create a
TimeSeriesControlPanel
. All arguments are passed through to thePlotControlPanel.__init__()
method.
-
destroy
()[source]¶ Must be called when this
TimeSeriesControlPanel
is no longer needed. Removes some property listeners, and callsPlotControlPanel.destroy()
.
-
generateCustomPlotPanelWidgets
(groupName)[source]¶ Overrides
PlotControlPanel.generateCustomPlotPanelWidgets()
.Adds some widgets for controlling some properties of the
TimeSeriesPanel
.
-
generateCustomDataSeriesWidgets
(ts, groupName)[source]¶ Overrides
PlotControlPanel.generateCustomDataSeriesWidgets()
.Adds some widgets to the widget list for certain time series types.
-
__generateFeatWidgets
(ts, groupName)¶ Called by
generateCustomDataSeriesWidgets()
. Generates widgets forFEATTimeSeries
options, and adds them to the widget list.
-
__generateComplexWidgets
(ts, groupName)¶ Called by
generateCustomDataSeriesWidgets()
. Generates widgets forComplexTimeSeries
options, and adds them to the widget list.
-
__plotMelodicICsChanged
(*a)¶ Called when the
TimeSeriesPanel.plotMelodicICs
property changes. If the current overlay is aMelodicImage
, re-generates the widgets in the current time course section, as theDataSeries
instance associated with the overlay may have been re-created.
-
__module__
= 'fsleyes.controls.timeseriescontrolpanel'¶