mne.channels.read_layout#

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

Read layout from a file.

Parameters:

fnamepath-like | str: Either the path to a .lout or .lay file or the name of a built-in layout. c.f. Notes for a list of the available built-in layouts.
pathpath-like | None: The path of the folder containing the Layout file. Defaults to the mne/channels/data/layouts folder inside your mne-python installation.

Deprecated since version v1.4: The kind and path parameters will be removed in version 1.5. Please use the fname parameter instead.
scalebool: Apply useful scaling for out the box plotting using layout.pos. Defaults to True.
kindstr | None: The name of the .lout file (e.g. kind='Vectorview-all' for 'Vectorview-all.lout').

Deprecated since version v1.4: The kind and path parameters will be removed in version 1.5. Please use the fname parameter instead.

Returns:

Examples using `mne.channels.read_layout`#