fsleyes.plotting.dataseries

This module provides the DataSeries class, the base class for classes used by PlotPanel views for plotting data.

class fsleyes.plotting.dataseries.DataSeries(overlay, overlayList, displayCtx, plotPanel)

Bases: __main__.MockClass

A DataSeries instance encapsulates some data to be plotted by a PlotPanel, with the data extracted from an overlay in the OverlayList.

Sub-class implementations must:

The overlay is accessible as an instance attribute, confusingly called overlay.

Note

Some DataSeries instances may not be associated with an overlay (e.g. series imported loaded a text file). In this case, the overlay attribute will be None.

Each``DataSeries`` instance is plotted as a line, with the line style defined by properties on the DataSeries instance, such as colour, lineWidth etc.

colour = <MagicMock name='mock.Colour()' id='139845842273280'>

Line colour.

enabled = <MagicMock name='mock.Boolean()' id='139845844115072'>

Draw or not draw?

alpha = <MagicMock name='mock.Real()' id='139845842337520'>

Line transparency.

label = <MagicMock name='mock.String()' id='139845843558864'>

Line label (used in the plot legend).

lineWidth = <MagicMock name='mock.Choice()' id='139845843612560'>

Line width.

lineStyle = <MagicMock name='mock.Choice()' id='139845843612560'>

Line style.

__init__(overlay, overlayList, displayCtx, plotPanel)

Create a DataSeries.

Parameters:
  • overlay – The overlay from which the data to be plotted is retrieved. May be None.
  • overlayList – The OverlayList instance.
  • displayCtx – The DisplayContext instance.
  • plotPanel – The PlotPanel that owns this DataSeries.
__del__()

Prints a log message.

__hash__()

Returns a hash for this DataSeries instance.

name

Returns a unique name for this DataSeries instance.

overlay

Returns the overlay associated with this DataSeries instance.

overlayList

Returns the OverlayList.

__module__ = 'fsleyes.plotting.dataseries'
displayCtx

Returns the DisplayContext.

plotPanel

Returns the PlotPanel that owns this DataSeries instance.

destroy()

This method must be called when this DataSeries instance is no longer needed. This implementation may be overridden by sub-classes which need to perform any clean-up operations. Sub-class implementations should call this implementation.

redrawProperties()

Returns a list of all properties which, when their values change, should result in this DataSeries being re-plotted. This method may be overridden by sub-classes.

setData(xdata, ydata)

Set the data to be plotted. This method is irrelevant if a DataSeries sub-class has overridden getData().

getData()

This method should be overridden by sub-classes. It must return the data to be plotted, as a tuple of the form:

(xdata, ydata)

where xdata and ydata are sequences containing the x/y data to be plotted.

The default implementation returns the data that has been set via the setData() method.