This documentation is for development version 0.18.dev0.

mne.channels.read_layout

mne.channels.read_layout(kind, path=None, scale=True)[source]

Read layout from a file.

Parameters:
kind : str

The name of the .lout file (e.g. kind=’Vectorview-all’ for ‘Vectorview-all.lout’).

path : str | None

The path of the folder containing the Layout file. Defaults to the mne/channels/data/layouts folder inside your mne-python installation.

scale : bool

Apply useful scaling for out the box plotting using layout.pos. Defaults to True.

Returns:
layout : instance of Layout

The layout.

See also

Layout.save