This documentation is for development version 0.18.dev0.

mne.channels.Layout

class mne.channels.Layout(box, pos, names, ids, kind)[source]

Sensor layouts.

Layouts are typically loaded from a file using read_layout. Only use this class directly if you’re constructing a new layout.

Parameters:
box : tuple of length 4

The box dimension (x_min, x_max, y_min, y_max).

pos : array, shape=(n_channels, 4)

The positions of the channels in 2d (x, y, width, height).

names : list

The channel names.

ids : list

The channel ids.

kind : str

The type of Layout (e.g. ‘Vectorview-all’).

Methods

__hash__($self, /) Return hash(self).
plot([picks, show]) Plot the sensor positions.
save(fname) Save Layout to disk.
__hash__($self, /)

Return hash(self).

plot(picks=None, show=True)[source]

Plot the sensor positions.

Parameters:
picks : str | list | slice | None

Channels to include. Slices and lists of integers will be interpreted as channel indices. In lists, channel type strings (e.g., ['meg', 'eeg']) will pick channels of those types, channel name strings (e.g., ['MEG0111', 'MEG2623'] will pick the given channels. Can also be the string values “all” to pick all channels, or “data” to pick data channels. None (default) will pick all channels.

show : bool

Show figure if True. Defaults to True.

Returns:
fig : instance of matplotlib.figure.Figure

Figure containing the sensor topography.

Notes

New in version 0.12.0.

save(fname)[source]

Save Layout to disk.

Parameters:
fname : str

The file name (e.g. ‘my_layout.lout’).

See also

read_layout