mne.viz.plot_montage

mne.viz.plot_montage(montage, *, scale=None, scale_factor=None, show_names=True, kind='topomap', show=True, sphere=None, axes=None, verbose=None)

Plot a montage.

Parameters:

montageinstance of DigMontage

The montage to visualize.

scalefloat

Determines the scale of the channel points and labels; values < 1 will scale down, whereas values > 1 will scale up. Default to None, which implies 1.

scale_factorfloat

Determines the size of the points. Deprecated, use scale instead.

show_namesbool | list

Whether to display all channel names. If a list, only the channel names in the list are shown. Defaults to True.

kindstr

Whether to plot the montage as ‘3d’ or ‘topomap’ (default).

showbool

Show figure if True.

spherefloat | array_like | instance of ConductorModel | None | ‘auto’ | ‘eeglab’

The sphere parameters to use for the head outline. Can be array-like of shape (4,) to give the X/Y/Z origin and radius in meters, or a single float to give just the radius (origin assumed 0, 0, 0). Can also be an instance of a spherical ConductorModel to use the origin and radius from that object. If 'auto' the sphere is fit to digitization points. If 'eeglab' the head circle is defined by EEG electrodes 'Fpz', 'Oz', 'T7', and 'T8' (if 'Fpz' is not present, it will be approximated from the coordinates of 'Oz'). None (the default) is equivalent to 'auto' when enough extra digitization points are available, and (0, 0, 0, 0.095) otherwise.

New in v0.20.

Changed in version 1.1: Added 'eeglab' option.

axesinstance of Axes | instance of Axes3D | None

Axes to draw the sensors to. If kind='3d', axes must be an instance of Axes3D. If None (default), a new axes will be created.

New in v1.4.

verbosebool | str | int | None

Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.

Returns:

figinstance of matplotlib.figure.Figure

The figure object.