fsleyes.plotting.timeseries
¶
This module provides a number of DataSeries
sub-classes which
are use by the TimeSeriesPanel
. The following classes are provided:
A |
|
A |
|
An |
|
|
|
An |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
-
class
fsleyes.plotting.timeseries.
VoxelTimeSeries
(*args, **kwargs)[source]¶ Bases:
fsleyes.plotting.dataseries.VoxelDataSeries
A
VoxelTimeSeries
is aVoxelDataSeries
which represents time series data.-
__module__
= 'fsleyes.plotting.timeseries'¶
-
-
class
fsleyes.plotting.timeseries.
ComplexTimeSeries
(overlay, overlayList, displayCtx, plotPanel)[source]¶ Bases:
fsleyes.plotting.timeseries.VoxelTimeSeries
A
VoxelTimeSeries
to display time series from 4D complex images. ThegetData()
method returns the real component of the data..The
extraSeries()
method returns additional series based on the values of theplotImaginary
,plotMagnitude
andplotPhase
properties. TheextraSeries()
method will return instances of the following classes:An
ImaginaryTimeSeries
represents the imaginary component of a complex-valued image.An
MagnitudeTimeSeries
represents the magnitude of a complex-valued image.An
PhaseTimeSeries
represents the phase of a complex-valued image.-
plotReal
= <MagicMock name='mock.Boolean()' id='4121089192'>¶ If
True
, thegetData()
method will return the real component time series data.
-
plotImaginary
= <MagicMock name='mock.Boolean()' id='4121089192'>¶ If
True
, theextraSeries()
method will return anImaginaryTimeSeries
instance, containing the imaginary component data.
-
plotMagnitude
= <MagicMock name='mock.Boolean()' id='4121089192'>¶ If
True
, theextraSeries()
method will return aMagnitudeTimeSeries
instance, containing the complex magnitude.
-
plotPhase
= <MagicMock name='mock.Boolean()' id='4121089192'>¶ If
True
, theextraSeries()
method will return aPhaseTimeSeries
instance, containing the complex phase.
-
__init__
(overlay, overlayList, displayCtx, plotPanel)[source]¶ Create a
ComplexTimeSeries
. All arguments are passed through to theVoxelTimeSeries
constructor.
-
getData
()[source]¶ If
plotReal
is true, returns the real component of the complex data. Otherwise returns(None, None)
.
-
extraSeries
()[source]¶ Returns a list of additional series to be plotted, based on the values of the
plotImaginary
,plotMagnitude
andplotPhase
properties.
-
__module__
= 'fsleyes.plotting.timeseries'¶
-
-
class
fsleyes.plotting.timeseries.
ImaginaryTimeSeries
(*args, **kwargs)[source]¶ Bases:
fsleyes.plotting.timeseries.VoxelTimeSeries
An
ImaginaryTimeSeries
represents the imaginary component of a complex-valued image.ImaginaryTimeSeries
instances are created byComplexTimeSeries
instances.-
__module__
= 'fsleyes.plotting.timeseries'¶
-
-
class
fsleyes.plotting.timeseries.
MagnitudeTimeSeries
(*args, **kwargs)[source]¶ Bases:
fsleyes.plotting.timeseries.VoxelTimeSeries
An
MagnitudeTimeSeries
represents the magnitude of a complex-valued image.MagnitudeTimeSeries
instances are created byComplexTimeSeries
instances.-
__module__
= 'fsleyes.plotting.timeseries'¶
-
-
class
fsleyes.plotting.timeseries.
PhaseTimeSeries
(*args, **kwargs)[source]¶ Bases:
fsleyes.plotting.timeseries.VoxelTimeSeries
An
PhaseTimeSeries
represents the phase of a complex-valued image.PhaseTimeSeries
instances are created byComplexTimeSeries
instances.-
__module__
= 'fsleyes.plotting.timeseries'¶
-
-
class
fsleyes.plotting.timeseries.
FEATTimeSeries
(*args, **kwargs)[source]¶ Bases:
fsleyes.plotting.timeseries.VoxelTimeSeries
A
VoxelTimeSeries
class for use withFEATImage
instances, containing some extra FEAT specific options.The
FEATTimeSeries
class acts as a container for severalTimeSeries
instances, each of which represent some part of a FEAT analysis. The data returned by a call togetData()
on aFEATTimeSeries
instance returns the fMRI time series data (filtered_func_data
in the.feat
directory).The
extraSeries()
method may be used to retrieve a list of all the otherTimeSeries
instances which are associated with theFEATTimeSeries
instance - all of theseDataSeries
instances, in addition to thisFEATTimeSeries
instasnce, should be plotted.For example, if the
plotData
andplotFullModelFit
settings areTrue
, theextraSeries()
method will return a list containing oneTimeSeries
instance, containing the full model fit, for the voxel in question.The following classes are used to represent the various parts of a FEAT analysis:
A
TimeSeries
class which represents the time course of an EV from a FEAT analysis.A
VoxelTimeSeries
class which represents the time course of the residuals from a FEAT analysis at a specific voxel.A
VoxelTimeSeries
class which represents the partial model fit of an EV or contrast from a FEAT analysis at a specific voxel.A
TimeSeries
class which represents the time course for a model fit from a FEAT analysis at a specific voxel.-
plotData
= <MagicMock name='mock.Boolean()' id='4121089192'>¶ If
True
, the FEAT input data is plotted.
-
plotResiduals
= <MagicMock name='mock.Boolean()' id='4121089192'>¶ If
True
, the FEAT model residuals are plotted.
-
plotEVs
= <MagicMock name='mock.List()' id='4119207600'>¶ A list of
Boolean
properties, one for each EV in the FEAT analysis. For elements that areTrue
, the corresponding FEAT EV time course is plotted.
-
plotPEFits
= <MagicMock name='mock.List()' id='4119207600'>¶ A list of
Boolean
properties, one for each EV in the FEAT analysis. For elements that areTrue
, the model fit for the corresponding FEAT EV is plotted.
-
plotCOPEFits
= <MagicMock name='mock.List()' id='4119207600'>¶ A list of
Boolean
properties, one for each EV in the FEAT analysis. For elements that areTrue
, the model fit for the corresponding FEAT contrast is plotted.
-
plotPartial
= <MagicMock name='mock.Choice()' id='4120585216'>¶ Plot the raw data, after regression against a chosen EV or contrast. The options are populated in the
__init__()
method.
-
__init__
(*args, **kwargs)[source]¶ Create a
FEATTimeSeries
.All arguments are passed through to the
VoxelTimeSeries
constructor.
-
plotFullModelFit
= <MagicMock name='mock.Boolean()' id='4121089192'>¶ If
True
, the FEAT full model fit is plotted.
-
getData
()[source]¶ Returns the fMRI time series data at the current voxel. Or, if
plotData
isFalse
, returns(None, None)
.
-
extraSeries
()[source]¶ Returns a list containing all of the
TimeSeries
instances which should be plotted in place of thisFEATTimeSeries
.
-
getModelTimeSeries
= <MagicMock name='mock.utils.deprecated.deprecated()()' id='4119240680'>¶
-
_FEATTimeSeries__createModelTs
(tsType, *args, **kwargs)¶ Creates a
TimeSeries
instance of the giventsType
, and sets its display settings according to those of thisFEATTimeSeries
.- Parameters
tsType – The type to create, e.g.
FEATModelFitTimeSeries
,FEATEVTimeSeries
, etc.args – Passed to the
tsType
constructor.kwargs – Passed to the
tsType
constructor.
-
_FEATTimeSeries__getContrast
(fitType, idx)¶ Returns a contrast vector for the given model fit type, and index.
- Parameters
fitType – either
'full'
,'pe'
, or'cope'
. If'full'
, theidx
argument is ignored.idx – The EV or contrast index for
'pe'
or'cope'
model fits.
-
_FEATTimeSeries__plotCOPEFitChanged
(*a)¶ Called when the
plotCOPEFits
setting changes.If necessary, creates and caches one or more
FEATModelFitTimeSeries
instances.
-
_FEATTimeSeries__plotEVChanged
(*a)¶ Called when the
plotEVs
setting changes.If necessary, creates and caches one or more
FEATEVTimeSeries
instances.
-
_FEATTimeSeries__plotFullModelFitChanged
(*a)¶ Called when the
plotFullModelFit
setting changes.If necessary, creates and caches a
FEATModelFitTimeSeries
instance.
-
_FEATTimeSeries__plotPEFitChanged
(*a)¶ Called when the
plotPEFits
setting changes.If necessary, creates and caches one or more
FEATModelFitTimeSeries
instances.
-
_FEATTimeSeries__plotPartialChanged
(*a)¶ Called when the
plotPartial
setting changes.If necessary, creates and caches a
FEATPartialFitTimeSeries
instance.
-
_FEATTimeSeries__plotResidualsChanged
(*a)¶ Called when the
plotResiduals
setting changes.If necessary, creates and caches a
FEATResidualTimeSeries
instance.
-
__module__
= 'fsleyes.plotting.timeseries'¶
-
-
class
fsleyes.plotting.timeseries.
FEATPartialFitTimeSeries
(overlay, overlayList, displayCtx, plotPanel, parentTs, contrast, fitType, idx)[source]¶ Bases:
fsleyes.plotting.timeseries.VoxelTimeSeries
A
VoxelTimeSeries
class which represents the partial model fit of an EV or contrast from a FEAT analysis at a specific voxel. Instances of this class are created by theFEATTimeSeries
class.-
__init__
(overlay, overlayList, displayCtx, plotPanel, parentTs, contrast, fitType, idx)[source]¶ Create a
FEATPartialFitTimeSeries
.- Parameters
overlay – The
FEATImage
instance to extract the data from.overlayList – The
OverlayList
instance.displayCtx – The
DisplayContext
instance.plotPanel – The
TimeSeriesPanel
which owns thisFEATPartialFitTimeSeries
.parentTs – The
FEATTimeSeries
instance that has created thisFEATPartialFitTimeSeries
.contrast – The contrast vector to calculate the partial model fit for.
fitType – The model fit type, either
'full'
,'pe'
or'cope'
.idx – If the model fit type is
'pe'
or'cope'
, the EV/contrast index.
-
dataAtCurrentVoxel
()[source]¶ Returns the partial model fit for the voxel and model fit type specified in the constructop.
See the
FEATImage.partialFit()
method.
-
__module__
= 'fsleyes.plotting.timeseries'¶
-
-
class
fsleyes.plotting.timeseries.
FEATEVTimeSeries
(overlay, overlayList, displayCtx, plotPanel, parentTs, idx)[source]¶ Bases:
fsleyes.plotting.dataseries.DataSeries
A
TimeSeries
class which represents the time course of an EV from a FEAT analysis. Instances of this class are created by theFEATTimeSeries
class.-
__init__
(overlay, overlayList, displayCtx, plotPanel, parentTs, idx)[source]¶ Create a
FEATEVTimeSeries
.- Parameters
overlay – The
FEATImage
instance to extract the data from.overlayList – The
OverlayList
instance.displayCtx – The
DisplayContext
instance.plotPanel – The
TimeSeriesPanel
which owns thisFEATEVTimeSeries
.parentTs – The
FEATTimeSeries
instance that has created thisFEATEVTimeSeries
.idx – The EV index.
-
__module__
= 'fsleyes.plotting.timeseries'¶
-
-
class
fsleyes.plotting.timeseries.
FEATResidualTimeSeries
(overlay, overlayList, displayCtx, plotPanel, parentTs)[source]¶ Bases:
fsleyes.plotting.timeseries.VoxelTimeSeries
A
VoxelTimeSeries
class which represents the time course of the residuals from a FEAT analysis at a specific voxel. Instances of this class are created by theFEATTimeSeries
class.-
__init__
(overlay, overlayList, displayCtx, plotPanel, parentTs)[source]¶ Create a
FEATResidualTimeSeries
.- Parameters
overlay – The
FEATImage
instance to extract the data from.overlayList – The
OverlayList
instance.displayCtx – The
DisplayContext
instance.plotPanel – The
TimeSeriesPanel
which owns thisFEATResidualTimeSeries
.parentTs – The
FEATTimeSeries
instance that has created thisFEATResidualTimeSeries
.
-
__module__
= 'fsleyes.plotting.timeseries'¶
-
-
class
fsleyes.plotting.timeseries.
FEATModelFitTimeSeries
(overlay, overlayList, displayCtx, plotPanel, parentTs, contrast, fitType, idx)[source]¶ Bases:
fsleyes.plotting.timeseries.VoxelTimeSeries
A
TimeSeries
class which represents the time course for a model fit from a FEAT analysis at a specific voxel. Instances of this class are created by theFEATTimeSeries
class.-
__init__
(overlay, overlayList, displayCtx, plotPanel, parentTs, contrast, fitType, idx)[source]¶ Create a
FEATModelFitTimeSeries
.- Parameters
overlay – The
FEATImage
instance to extract the data from.overlayList – The
OverlayList
instance.displayCtx – The
DisplayContext
instance.plotPanel – The
TimeSeriesPanel
which owns thisFEATModelFitTimeSeries
.parentTs – The
FEATTimeSeries
instance that has created thisFEATModelFitTimeSeries
.contrast – The contrast vector to calculate the partial model fit for.
fitType – The model fit type, either
'full'
,'pe'
or'cope'
.idx – If the model fit type is
'pe'
or'cope'
,
-
__module__
= 'fsleyes.plotting.timeseries'¶
-
-
class
fsleyes.plotting.timeseries.
MelodicTimeSeries
(overlay, overlayList, displayCtx, plotPanel)[source]¶ Bases:
fsleyes.plotting.dataseries.DataSeries
A
DataSeries
class which encapsulates the time course for one component of aMelodicImage
. ThegetData()
method returns the time course of the component specified by the currentNiftiOpts.volume
.-
__module__
= 'fsleyes.plotting.timeseries'¶
-
__init__
(overlay, overlayList, displayCtx, plotPanel)[source]¶ Create a
MelodicTimeSeries
.- Parameters
overlay – A
MelodicImage
overlay.overlayList – The
OverlayList
instance.displayCtx – The
DisplayContext
instance.plotPanel – The
TimeSeriesPanel
which owns thisMelodicTimeSeries
.
-
-
class
fsleyes.plotting.timeseries.
MeshTimeSeries
(overlay, overlayList, displayCtx, plotPanel)[source]¶ Bases:
fsleyes.plotting.dataseries.DataSeries
A
MeshTimeSeries
object encapsulates the time course for aMesh
overlay which has some time series vertex data associated with it. See theMeshOpts.vertexData
property.-
_MeshTimeSeries__haveData
()¶ Returns
True
if there is currently time series data to show for thisMeshTimeSeries
,False
otherwise.
-
__module__
= 'fsleyes.plotting.timeseries'¶
-
__init__
(overlay, overlayList, displayCtx, plotPanel)[source]¶ Create a
MeshTimeSeries
instance.- Parameters
overlay – The
Mesh
instance to extract the data from.overlayList – The
OverlayList
instance.displayCtx – The
DisplayContext
instance.plotPanel – The
TimeSeriesPanel
which owns thisTimeSeries
.
-