mne.read_label

mne.read_label(filename, subject=None, color=None, *, verbose=None)[source]

Read FreeSurfer Label file.

Parameters
filenamestr

Path to label file.

subjectstr | None

Subject which this label belongs to. Should only be specified if it is not specified in the label. It is good practice to set this attribute to avoid combining incompatible labels and SourceEstimates (e.g., ones from other subjects). Note that due to file specification limitations, the subject name isn’t saved to or loaded from files written to disk.

colorNone | matplotlib color

Default label color and alpha (e.g., (1., 0., 0., 1.) for red). Note that due to file specification limitations, the color isn’t saved to or loaded from files written to disk.

verbosebool | str | int | None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more). If used, it should be passed as a keyword-argument only.

Returns
labelLabel

Instance of Label object with attributes:

  • comment: comment from the first line of the label file

  • vertices: vertex indices (0 based, column 1)

  • pos: locations in meters (columns 2 - 4 divided by 1000)

  • values: values at the vertices (column 5)