mne.read_evokeds¶
- mne.read_evokeds(fname, condition=None, baseline=None, kind='average', proj=True, allow_maxshield=False, verbose=None)[source]¶
Read evoked dataset(s).
- Parameters
- fname
str
The file name, which should end with -ave.fif or -ave.fif.gz.
- condition
int
orstr
|list
ofint
orstr
|None
The index or list of indices of the evoked dataset to read. FIF files can contain multiple datasets. If None, all datasets are returned as a list.
- baseline
None
|tuple
of length 2 The time interval to consider as “baseline” when applying baseline correction. If
None
, do not apply baseline correction. If a tuple(a, b)
, the interval is betweena
andb
(in seconds), including the endpoints. Ifa
isNone
, the beginning of the data is used; and ifb
isNone
, it is set to the end of the interval. If(None, None)
, the entire time interval is used.Note
The baseline
(a, b)
includes both endpoints, i.e. all timepointst
such thata <= t <= b
.Correction is applied to each channel individually in the following way:
Calculate the mean signal of the baseline period.
Subtract this mean from the entire
Evoked
.
If
None
(default), do not apply baseline correction.Note
Note that if the read
Evoked
objects have already been baseline-corrected, the data retrieved from disk will always be baseline-corrected (in fact, only the baseline-corrected version of the data will be saved, so there is no way to undo this procedure). Only after the data has been loaded, a custom (additional) baseline correction may be optionally applied by passing a tuple here. PassingNone
will not remove an existing baseline correction, but merely omit the optional, additional baseline correction.- kind
str
Either ‘average’ or ‘standard_error’, the type of data to read.
- projbool
If False, available projectors won’t be applied to the data.
- allow_maxshieldbool |
str
(defaultFalse
) If True, allow loading of data that has been recorded with internal active compensation (MaxShield). Data recorded with MaxShield should generally not be loaded directly, but should first be processed using SSS/tSSS to remove the compensation signals that may also affect brain activity. Can also be “yes” to load without eliciting a warning.
- verbosebool,
str
,int
, orNone
If not None, override default verbose level (see
mne.verbose()
and Logging documentation for more). If used, it should be passed as a keyword-argument only.
- fname
- Returns
See also
Notes
Changed in version 0.23: If the read
Evoked
objects had been baseline-corrected before saving, this will be reflected in theirbaseline
attribute after reading.