mne.labels_to_stc#
- mne.labels_to_stc(labels, values, tmin=0, tstep=1, subject=None, src=None, verbose=None)[source]#
Convert a set of labels and values to a STC.
This function is meant to work like the opposite of
extract_label_time_course.- Parameters
- labels
Label|BiHemiLabel|list|tuple|str If using a surface or mixed source space, this should be the
Label’s for which to extract the time course. If working with whole-brain volume source estimates, this must be one of:a string path to a FreeSurfer atlas for the subject (e.g., their ‘aparc.a2009s+aseg.mgz’) to extract time courses for all volumes in the atlas
a two-element list or tuple, the first element being a path to an atlas, and the second being a list or dict of
volume_labelsto extract (seemne.setup_volume_source_space()for details).
Changed in version 0.21.0: Support for volume source estimates.
- values
ndarray, shape (n_labels, …) The values in each label. Can be 1D or 2D.
- tmin
float The tmin to use for the STC.
- tstep
float The tstep to use for the STC.
- subject
str The FreeSurfer subject name.
- srcinstance of
SourceSpaces The source spaces for the source time courses. Can be omitted if using a surface source space, in which case the label vertices will determine the output STC vertices. Required if using a volumetric source space.
New in version 0.22.
- verbosebool |
str|int|None Control verbosity of the logging output. If
None, use the default verbosity level. See the logging documentation andmne.verbose()for details. Should only be passed as a keyword argument.
- labels
- Returns
- stcinstance of
SourceEstimate| instance ofVolSourceEstimate The values-in-labels converted to a STC.
- stcinstance of
See also
Notes
Vertices that appear in more than one label will be averaged.
New in version 0.18.
