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 TimeSeries class.

A TimeSeriesControlPanel looks something like this:

_images/timeseriescontrolpanel.png

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 TimeSeriesPanel 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 TimeSeries 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.
__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().

static supportedViews()

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

generateCustomPlotPanelWidgets(groupName)

Overrides PlotControlPanel.generateCustomPlotPanelWidgets().

Adds some widgets for controlling some properties of the TimeSeriesPanel.

generateCustomDataSeriesWidgets(ts, groupName)

Overrides PlotControlPanel.generateCustomDataSeriesWidgets().

If the given TimeSeries is a FEATTimeSeries instance, this method adds some widgets for controlling the FEAT-related settings of the instance.

_TimeSeriesControlPanel__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 TimeSeries instance associated with the overlay may have been re-created.

__module__ = 'fsleyes.controls.timeseriescontrolpanel'