Create a FreeSurfer annotation from a list of labels.
list
with instances of mne.Label
The labels to create a parcellation from.
str
The FreeSurfer subject name.
str
| None
The parcellation name to use.
Overwrite files if they already exist.
None
The path to the directory containing the FreeSurfer subjects
reconstructions. If None
, defaults to the SUBJECTS_DIR
environment
variable.
str
| None
Filename of the .annot file. If not None, only this file is written and ‘parc’ and ‘subject’ are ignored.
str
Colormap to use to generate label colors for labels that do not have a color specified.
The hemisphere(s) for which to write *.annot files (only applies if annot_fname is not specified; default is ‘both’).
If True (default), labels will be sorted by name before writing.
New in version 0.21.0.
str
The table name to use for the colortable.
New in version 0.21.0.
str
| int
| None
Control verbosity of the logging output. If None
, use the default
verbosity level. See the logging documentation and
mne.verbose()
for details. Should only be passed as a keyword
argument.
See also
Notes
Vertices that are not covered by any of the labels are assigned to a label named “unknown”.