mne.read_labels_from_annot

mne.read_labels_from_annot(subject, parc='aparc', hemi='both', surf_name='white', annot_fname=None, regexp=None, subjects_dir=None, verbose=None)[source]

Read labels from a FreeSurfer annotation file.

Note: Only cortical labels will be returned.

Parameters
subjectstr

The subject for which to read the parcellation.

parcstr

The parcellation to use, e.g., ‘aparc’ or ‘aparc.a2009s’.

hemistr

The hemisphere from which to read the parcellation, can be ‘lh’, ‘rh’, or ‘both’.

surf_namestr

Surface used to obtain vertex locations, e.g., ‘white’, ‘pial’

annot_fnamestr or None

Filename of the .annot file. If not None, only this file is read and ‘parc’ and ‘hemi’ are ignored.

regexpstr

Regular expression or substring to select particular labels from the parcellation. E.g. ‘superior’ will return all labels in which this substring is contained.

subjects_dirstr, or None

Path to SUBJECTS_DIR if it is not set in the environment.

verbosebool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

Returns
labelslist of Label

The labels, sorted by label name (ascending).