mne.BiHemiLabel#

class mne.BiHemiLabel(lh, rh, name=None, color=None)[source]#

A freesurfer/MNE label with vertices in both hemispheres.

Parameters:
lhLabel

Label for the left hemisphere.

rhLabel

Label for the right hemisphere.

nameNone | str

Name for the label.

colorNone | color

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.

Attributes:
lhLabel

Label for the left hemisphere.

rhLabel

Label for the right hemisphere.

nameNone | str

A name for the label. It is OK to change that attribute manually.

subjectstr | None

The name of the subject.

Methods

__add__(other)

Add labels.

__len__()

Return the number of vertices.

__sub__(other)

Subtract labels.
__add__(other)[source]#

Add labels.

Parameters:
otherinstance of Label | instance of BiHemiLabel

The label to add.

Returns:
labelinstance of BiHemiLabel

The union of the two labels.

__len__()[source]#

Return the number of vertices.

Returns:
n_verticesint

The number of vertices.

__sub__(other)[source]#

Subtract labels.

Parameters:
otherinstance of Label | instance of BiHemiLabel

The label to subtract.

Returns:
labelinstance of Label | instance of BiHemiLabel

The vertices of this label that are not in other (a Label if only one hemisphere remains).