mne.morph_labels#
- mne.morph_labels(labels, subject_to, subject_from=None, subjects_dir=None, surf_name='white', verbose=None)[source]#
Morph a set of labels.
This is useful when morphing a set of non-overlapping labels (such as those obtained with
read_labels_from_annot()
) from one subject to another.- Parameters:
- labels
list
The labels to morph.
- subject_to
str
The subject to morph labels to.
- subject_from
str
|None
The subject to morph labels from. Can be None if the labels have the
.subject
property defined.- subjects_dirpath-like |
None
The path to the directory containing the FreeSurfer subjects reconstructions. If
None
, defaults to theSUBJECTS_DIR
environment variable.- surf_name
str
Surface used to obtain vertex locations, e.g.,
'white'
,'pial'
.- verbose
bool
|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:
- labels
list
The morphed labels.
- labels
See also
Notes
This does not use the same algorithm as Freesurfer, so the results morphing (e.g., from
'fsaverage'
to your subject) might not match what Freesurfer produces duringrecon-all
.New in version 0.18.