mne.viz.plot_dipole_locations¶

mne.viz.plot_dipole_locations(dipoles, trans, subject, subjects_dir=None, bgcolor=(1, 1, 1), opacity=0.3, brain_color=(1, 1, 0), fig_name=None, fig_size=(600, 600), mode=None, scale_factor=0.01, colors=None, coord_frame=’mri’, idx=’gof’, show_all=True, ax=None, block=False, show=True, verbose=None)[source]¶

Plot dipole locations.

If mode is set to ‘cone’ or ‘sphere’, only the location of the first time point of each dipole is shown else use the show_all parameter.

The option mode=’orthoview’ was added in version 0.14.

Warning

Using mode with option ‘cone’ or ‘sphere’ will be deprecated in version 0.15.

Parameters:

Parameters:	dipoles : list of instances of Dipole \| Dipole The dipoles to plot. trans : dict The mri to head trans. subject : str The subject name corresponding to FreeSurfer environment variable SUBJECT. subjects_dir : None \| str The path to the freesurfer subjects reconstructions. It corresponds to Freesurfer environment variable SUBJECTS_DIR. The default is None. bgcolor : tuple of length 3 Background color in 3D. opacity : float in [0, 1] Opacity of brain mesh. brain_color : tuple of length 3 Brain color. fig_name : str Mayavi figure name. fig_size : tuple of length 2 Mayavi figure size. mode : str Should be `'cone'` or `'sphere'` or `'orthoview'` to specify how the dipoles should be shown. If orthoview then matplotlib is used otherwise it is mayavi. New in version 0.14.0. scale_factor : float The scaling applied to amplitudes for the plot. colors: list of colors \| None Color to plot with each dipole. If None default colors are used. coord_frame : str Coordinate frame to use, ‘head’ or ‘mri’. Defaults to ‘mri’. New in version 0.14.0. idx : int \| ‘gof’ \| ‘amplitude’ Index of the initially plotted dipole. Can also be ‘gof’ to plot the dipole with highest goodness of fit value or ‘amplitude’ to plot the dipole with the highest amplitude. The dipoles can also be browsed through using up/down arrow keys or mouse scroll. Defaults to ‘gof’. Only used if mode equals ‘orthoview’. New in version 0.14.0. show_all : bool Whether to always plot all the dipoles. If True (default), the active dipole is plotted as a red dot and it’s location determines the shown MRI slices. The the non-active dipoles are plotted as small blue dots. If False, only the active dipole is plotted. Only used if mode equals ‘orthoview’. New in version 0.14.0. ax : instance of matplotlib Axes3D \| None Axes to plot into. If None (default), axes will be created. Only used if mode equals ‘orthoview’. New in version 0.14.0. block : bool Whether to halt program execution until the figure is closed. Defaults to False. Only used if mode equals ‘orthoview’. New in version 0.14.0. show : bool Show figure if True. Defaults to True. Only used if mode equals ‘orthoview’. New in version 0.14.0. verbose : bool, str, int, or None If not None, override default verbose level (see `mne.verbose()` and Logging documentation for more).
Returns:	fig : instance of mlab.Figure or matplotlib Figure The mayavi figure or matplotlib Figure.

dipoles : list of instances of Dipole | Dipole

The dipoles to plot.

trans : dict

The mri to head trans.

subject : str

The subject name corresponding to FreeSurfer environment variable SUBJECT.

subjects_dir : None | str

The path to the freesurfer subjects reconstructions. It corresponds to Freesurfer environment variable SUBJECTS_DIR. The default is None.

bgcolor : tuple of length 3

Background color in 3D.

opacity : float in [0, 1]

Opacity of brain mesh.

brain_color : tuple of length 3

Brain color.

fig_name : str

Mayavi figure name.

fig_size : tuple of length 2

Mayavi figure size.

mode : str

Should be 'cone' or 'sphere' or 'orthoview' to specify how the dipoles should be shown. If orthoview then matplotlib is used otherwise it is mayavi.

New in version 0.14.0.

scale_factor : float

The scaling applied to amplitudes for the plot.

colors: list of colors | None

Color to plot with each dipole. If None default colors are used.

coord_frame : str

Coordinate frame to use, ‘head’ or ‘mri’. Defaults to ‘mri’.

New in version 0.14.0.

idx : int | ‘gof’ | ‘amplitude’

Index of the initially plotted dipole. Can also be ‘gof’ to plot the dipole with highest goodness of fit value or ‘amplitude’ to plot the dipole with the highest amplitude. The dipoles can also be browsed through using up/down arrow keys or mouse scroll. Defaults to ‘gof’. Only used if mode equals ‘orthoview’.

New in version 0.14.0.

show_all : bool

Whether to always plot all the dipoles. If True (default), the active dipole is plotted as a red dot and it’s location determines the shown MRI slices. The the non-active dipoles are plotted as small blue dots. If False, only the active dipole is plotted. Only used if mode equals ‘orthoview’.

New in version 0.14.0.

ax : instance of matplotlib Axes3D | None

Axes to plot into. If None (default), axes will be created. Only used if mode equals ‘orthoview’.

New in version 0.14.0.

block : bool

Whether to halt program execution until the figure is closed. Defaults to False. Only used if mode equals ‘orthoview’.

New in version 0.14.0.

show : bool

Show figure if True. Defaults to True. Only used if mode equals ‘orthoview’.

New in version 0.14.0.

verbose : bool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

Returns:

fig : instance of mlab.Figure or matplotlib Figure

The mayavi figure or matplotlib Figure.

Notes

New in version 0.9.0.

Examples using `mne.viz.plot_dipole_locations`¶

Compute Rap-Music on evoked data

mne.viz.plot_dipole_locations¶

Examples using mne.viz.plot_dipole_locations¶

Examples using `mne.viz.plot_dipole_locations`¶