mne.channels.Montage

class mne.channels.Montage(pos, ch_names, kind, selection, nasion=None, lpa=None, rpa=None)[source]

Montage for standard EEG electrode locations.

Warning

Montages should typically be loaded from a file using mne.channels.read_montage() instead of instantiating this class directly.

Parameters
posarray, shape (n_channels, 3)

The positions of the channels in 3d given in meters.

ch_nameslist

The channel names.

kindstr

The type of montage (e.g. ‘standard_1005’).

selectionarray of int

The indices of the selected channels in the montage file.

See also

DigMontage
read_montage
read_dig_montage

Notes

New in version 0.9.0.

Methods

__hash__(self, /)

Return hash(self).

get_pos2d(self)

Return positions converted to 2D.

plot(self[, scale_factor, show_names, kind, …])

Plot a montage.
__hash__(self, /)

Return hash(self).

get_pos2d(self)[source]

Return positions converted to 2D.

plot(self, scale_factor=20, show_names=True, kind='topomap', show=True)[source]

Plot a montage.

Parameters
scale_factorfloat

Determines the size of the points.

show_namesbool

Whether to show the channel names.

kindstr

Whether to plot the montage as ‘3d’ or ‘topomap’ (default).

showbool

Show figure if True.

Returns
figinstance of matplotlib.figure.Figure

The figure object.

Examples using mne.channels.Montage