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)

Bases: fsleyes.controls.plotcontrolpanel.PlotControlPanel

The TimeSeriesControlPanel is a PlotContrlPanel which allows the user to configure a TimeSeriesPanel. It contains controls which are linked to the properties of the TimeSeriesPanel, (which include properties defined on the PlotPanel base class), and the DataSeries 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 the TimeSeriesPanel 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 the FEATTimeSeries class.

static supportedViews()

Overrides ControlMixin.supportedViews(). The TimeSeriesControlPanel is only intended to be added to TimeSeriesPanel views.

static defaultLayout()

Returns a dictionary containing layout settings to be passed to ViewPanel.togglePanel.

__init__(*args, **kwargs)

Create a TimeSeriesControlPanel. All arguments are passed through to the PlotControlPanel.__init__() method.

destroy()

Must be called when this TimeSeriesControlPanel is no longer needed. Removes some property listeners, and calls PlotControlPanel.destroy().

generateCustomPlotPanelWidgets(groupName)

Overrides PlotControlPanel.generateCustomPlotPanelWidgets().

Adds some widgets for controlling some properties of the TimeSeriesPanel.

generateCustomDataSeriesWidgets(ts, groupName)

Overrides PlotControlPanel.generateCustomDataSeriesWidgets().

Adds some widgets to the widget list for certain time series types.

__generateFeatWidgets(ts, groupName)

Called by generateCustomDataSeriesWidgets(). Generates widgets for FEATTimeSeries options, and adds them to the widget list.

__generateComplexWidgets(ts, groupName)

Called by generateCustomDataSeriesWidgets(). Generates widgets for ComplexTimeSeries options, and adds them to the widget list.

__plotMelodicICsChanged(*a)

Called when the TimeSeriesPanel.plotMelodicICs property changes. If the current overlay is a MelodicImage, re-generates the widgets in the current time course section, as the DataSeries instance associated with the overlay may have been re-created.

__module__ = 'fsleyes.controls.timeseriescontrolpanel'