mne.channels.read_montage

mne.channels.read_montage(kind, ch_names=None, path=None, unit='m', transform=False)[source]

Read a generic (built-in) montage.

Individualized (digitized) electrode positions should be read in using read_dig_montage().

In most cases, you should only need to set the kind parameter to load one of the built-in montages (see Notes).

Parameters
kindstr

The name of the montage file without the file extension (e.g. kind=’easycap-M10’ for ‘easycap-M10.txt’). Files with extensions ‘.elc’, ‘.txt’, ‘.csd’, ‘.elp’, ‘.hpts’, ‘.sfp’, ‘.loc’ (‘.locs’ and ‘.eloc’) or .bvef are supported.

ch_nameslist of str | None

If not all electrodes defined in the montage are present in the EEG data, use this parameter to select a subset of electrode positions to load. If None (default), all defined electrode positions are returned.

Note

ch_names are compared to channel names in the montage file after converting them both to upper case. If a match is found, the letter case in the original ch_names is used in the returned montage.

pathstr | None

The path of the folder containing the montage file. Defaults to the mne/channels/data/montages folder in your mne-python installation.

unit‘m’ | ‘cm’ | ‘mm’ | ‘auto’

Unit of the input file. When ‘auto’ the montage is normalized to a sphere of radius equal to the average brain size. Defaults to ‘auto’.

transformbool

If True, points will be transformed to Neuromag space. The fidicuals, ‘nasion’, ‘lpa’, ‘rpa’ must be specified in the montage file. Useful for points captured using Polhemus FastSCAN. Default is False.

Returns
montageinstance of Montage

The montage.

Notes

Built-in montages are not scaled or transformed by default.

Montages can contain fiducial points in addition to electrode channels, e.g. biosemi64 contains 67 locations. In the following table, the number of channels and fiducials is given in parentheses in the description column (e.g. 64+3 means 64 channels and 3 fiducials).

Valid kind arguments are:

Kind

Description

standard_1005

Electrodes are named and positioned according to the international 10-05 system (343+3 locations)

standard_1020

Electrodes are named and positioned according to the international 10-20 system (94+3 locations)

standard_alphabetic

Electrodes are named with LETTER-NUMBER combinations (A1, B2, F4, …) (65+3 locations)

standard_postfixed

Electrodes are named according to the international 10-20 system using postfixes for intermediate positions (100+3 locations)

standard_prefixed

Electrodes are named according to the international 10-20 system using prefixes for intermediate positions (74+3 locations)

standard_primed

Electrodes are named according to the international 10-20 system using prime marks (‘ and ‘’) for intermediate positions (100+3 locations)

biosemi16

BioSemi cap with 16 electrodes (16+3 locations)

biosemi32

BioSemi cap with 32 electrodes (32+3 locations)

biosemi64

BioSemi cap with 64 electrodes (64+3 locations)

biosemi128

BioSemi cap with 128 electrodes (128+3 locations)

biosemi160

BioSemi cap with 160 electrodes (160+3 locations)

biosemi256

BioSemi cap with 256 electrodes (256+3 locations)

easycap-M1

EasyCap with 10-05 electrode names (74 locations)

easycap-M10

EasyCap with numbered electrodes (61 locations)

EGI_256

Geodesic Sensor Net (256 locations)

GSN-HydroCel-32

HydroCel Geodesic Sensor Net and Cz (33+3 locations)

GSN-HydroCel-64_1.0

HydroCel Geodesic Sensor Net (64+3 locations)

GSN-HydroCel-65_1.0

HydroCel Geodesic Sensor Net and Cz (65+3 locations)

GSN-HydroCel-128

HydroCel Geodesic Sensor Net (128+3 locations)

GSN-HydroCel-129

HydroCel Geodesic Sensor Net and Cz (129+3 locations)

GSN-HydroCel-256

HydroCel Geodesic Sensor Net (256+3 locations)

GSN-HydroCel-257

HydroCel Geodesic Sensor Net and Cz (257+3 locations)

mgh60

The (older) 60-channel cap used at MGH (60+3 locations)

mgh70

The (newer) 70-channel BrainVision cap used at MGH (70+3 locations)

New in version 0.9.0.