mne.extract_label_time_course¶

mne.
extract_label_time_course
(stcs, labels, src, mode='mean_flip', allow_empty=False, return_generator=False, verbose=None)[source]¶ Extract label time course for lists of labels and source estimates.
This function will extract one time course for each label and source estimate. The way the time courses are extracted depends on the mode parameter (see Notes).
 Parameters
 stcs
SourceEstimate
list
(or generator) ofSourceEstimate
The source estimates from which to extract the time course.
 labels
Label
BiHemiLabel
list
ofLabel
orBiHemiLabel
The labels for which to extract the time course.
 src
list
Source spaces for left and right hemisphere.
 mode
str
Extraction mode, see explanation above.
 allow_emptybool
Instead of emitting an error, return allzero time courses for labels that do not have any vertices in the source estimate.
 return_generatorbool
If True, a generator instead of a list is returned.
 verbosebool,
str
,int
, orNone
If not None, override default verbose level (see
mne.verbose()
and Logging documentation for more).
 stcs
 Returns
Notes
Valid values for mode are:
'mean'
Average within each label.
'mean_flip'
Average within each label with sign flip depending on source orientation.
'pca_flip'
Apply an SVD to the time courses within each label and use the scaled and signflipped first rightsingular vector as the label time course. The scaling is performed such that the power of the label time course is the same as the average pervertex time course power within the label. The sign of the resulting time course is adjusted by multiplying it with “sign(dot(u, flip))” where u is the first leftsingular vector, and flip is a singflip vector based on the vertex normals. This procedure assures that the phase does not randomly change by 180 degrees from one stc to the next.
'max'
Max value within each label.
If encountering a
ValueError
due to mismatch between number of source points in the subject source space and computedstc
object setsrc
argument tofwd['src']
to ensure the source space is compatible between forward and inverse routines.