eelbrain.pipeline.MneExperiment.load_epochs_stc¶
-
MneExperiment.
load_epochs_stc
(subjects=None, baseline=True, src_baseline=False, cat=None, keep_epochs=False, morph=False, mask=False, data_raw=False, vardef=None, samplingrate=None, decim=None, pad=0, ndvar=True, reject=True, **state)¶ Load a Dataset with stcs for single epochs
- Parameters
subjects (str | 1 | -1) – Subject(s) for which to load data. Can be a single subject name or a group name such as
'all'
.1
to use the current subject;-1
for the current group. Default is current subject (or group ifgroup
is specified). Warning: loading single trial data for multiple subjects at once uses a lot of memory, which can lead to a periodically unresponsive terminal).baseline (
Union
[bool
,Tuple
[Optional
[float
],Optional
[float
]]]) – Apply baseline correction using this period in sensor space. True to use the epoch’s baseline specification (default).src_baseline (
Union
[bool
,Tuple
[Optional
[float
],Optional
[float
]]]) – Apply baseline correction using this period in source space. True to use the epoch’s baseline specification. The default is to not apply baseline correction.cat (
Optional
[Sequence
[Union
[str
,Tuple
[str
, …]]]]) – Only load data for these cells (cells of model).keep_epochs (bool | 'ndvar' | 'both') – Keep the sensor space data in the Dataset that is returned (default False; True to keep
mne.Epochs
object;'ndvar'
to keepNDVar
;'both'
to keep both).morph (
bool
) – Morph the source estimates to the common_brain (default False).mask (
Union
[bool
,str
]) – Discard data that is labelledunknown
by the parcellation. Parcellation name (str
) to specify a parcellation,True
to use the state-parc` state parameter. Only applies whenndvar=True
, defaultFalse
.data_raw (
bool
) – Keep themne.io.Raw
instance inds.info['raw']
(default False).vardef (
Optional
[str
]) – Name of a test defining additional variables.samplingrate (
Optional
[int
]) – Samplingrate in Hz for the analysis (default is specified in epoch definition).decim (
Optional
[int
]) – Data decimation factor (alternative tosamplingrate
).pad (
float
) – Pad the epoch’s data by extendingtmin
andtmax
(specifypad
time in seconds).ndvar (
bool
) – Add the source estimates asNDVar
named “src” instead of a list ofmne.SourceEstimate
objects named “stc” (default True).reject (bool | 'keep') – Reject bad trials. If
True
(default), bad trials are removed from the Dataset. Set toFalse
to ignore the trial rejection. Setreject='keep'
to load the rejection (added it to the events as'accept'
variable), but keep bad trails... –
Applicable State Parameters:
- Returns
epochs_dataset – Dataset containing single trial data (epochs).
- Return type