Table Of Contents

Previous topic

mvpa.datasets.base

Next topic

mvpa.datasets.eep

This Page

Quick search

mvpa.datasets.channel

Dataset handling data structured in channels.

The comprehensive API documentation for this module, including all technical details, is available in the Epydoc-generated API reference for mvpa.datasets.channel (for developers).

ChannelDataset

class mvpa.datasets.channel.ChannelDataset(samples=None, dsattr=None, t0=None, dt=None, channelids=None, **kwargs)

Bases: mvpa.datasets.mapped.MappedDataset

Dataset handling data structured into channels.

Channels are assumes to contain several timepoints, thus this Dataset stores some additional properties (reference time t0, temporal distance of two timepoints dt and channelids (names)).

Initialize ChannelDataset.

Parameters:
  • samples (ndarray) – Three-dimensional array: (samples x channels x timepoints).
  • t0 (float) – Reference time of the first timepoint. Can be used to preserve information about the onset of some stimulation. Preferably in seconds.
  • dt (float) – Temporal distance between two timepoints. Has to be given in seconds. Otherwise samplingrate property will not return Hz.
  • channelids (list) – List of channel names.
channelids
List of channel IDs
dt
Time difference between two samples (in seconds).
samplingrate
Yeah, sampling rate.
substractBaseline(t=None)

Substract mean baseline signal from the each timepoint.

The baseline is determined by computing the mean over all timepoints specified by t.

The samples of the dataset are modified in-place and nothing is returned.

Parameters:
  • t (int | float | None) – If an integer, t denotes the number of timepoints in the from the start of each sample to be used to compute the baseline signal. If a floating point value, t is the duration of the baseline window from the start of each sample in whatever unit corresponding to the datasets samplingrate. Finally, if None the t0 property of the dataset is used to determine t as it would have been specified as duration.
t0
Temporal position of first sample in the timeseries (in seconds) – possibly relative to stimulus onset.

See also

Derived classes might provide additional methods via their base classes. Please refer to the list of base classes (if it exists) at the begining of the ChannelDataset documentation.

Full API documentation of ChannelDataset in module mvpa.datasets.channel.