mne.channels.get_builtin_montages#

mne.channels.get_builtin_montages(*, descriptions=False)[source]#

Get a list of all standard montages shipping with MNE-Python.

The names of the montages can be passed to make_standard_montage().

Parameters:

descriptionsbool: Whether to return not only the montage names, but also their corresponding descriptions. If True, a list of tuples is returned, where the first tuple element is the montage name and the second is the montage description. If False (default), only the names are returned.

New in v1.1.

Returns:

montageslist of str | list of tuple

If descriptions=False, the names of all builtin montages that can be used by make_standard_montage().

If descriptions=True, a list of tuples (name, description).

Examples using `mne.channels.get_builtin_montages`#