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:
boxtuple of length 4

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

posarray, shape=(n_channels, 4)

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

nameslist

The channel names.

idslist

The channel ids.

kindstr

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

Methods

plot([picks, show_axes, show])

Plot the sensor positions.

save(fname)

Save Layout to disk.

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

Plot the sensor positions.

Parameters:
pickslist | slice | None

Channels to include. Slices and lists of integers will be interpreted as channel indices. None (default) will pick all channels. Note that channels in info['bads'] will be included if their indices are explicitly provided.

show_axesbool

Show layout axes if True. Defaults to False.

showbool

Show figure if True. Defaults to True.

Returns:
figinstance of matplotlib.figure.Figure

Figure containing the sensor topography.

Notes

New in version 0.12.0.

Examples using plot:

Working with sensor locations

Working with sensor locations
save(fname)[source]#

Save Layout to disk.

Parameters:
fnamestr

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

See also

read_layout

Examples using save:

Working with sensor locations

Working with sensor locations

Examples using mne.channels.Layout#

Working with sensor locations

Working with sensor locations

Visualizing epoched data

Visualizing epoched data

How to convert 3D electrode positions to a 2D image

How to convert 3D electrode positions to a 2D image