mne.viz.plot_brain_colorbar

mne.viz.plot_brain_colorbar(ax, clim, colormap='auto', transparent=True, orientation='vertical', label='Activation', bgcolor='0.5')

Plot a colorbar that corresponds to a brain activation map.

Parameters:

axinstance of Axes

The Axes to plot into.

climstr | dict

Colorbar properties specification. If ‘auto’, set clim automatically based on data percentiles. If dict, should contain:

kind‘value’ | ‘percent’

Flag to specify type of limits.

limslist | np.ndarray | tuple of float, 3 elements

Lower, middle, and upper bounds for colormap.

pos_limslist | np.ndarray | tuple of float, 3 elements

Lower, middle, and upper bound for colormap. Positive values will be mirrored directly across zero during colormap construction to obtain negative control points.

Note

Only one of lims or pos_lims should be provided. Only sequential colormaps should be used with lims, and only divergent colormaps should be used with pos_lims.

colormapstr | matplotlib.colors.Colormap

Name of colormap to use or a custom Matplotlib colormap instance. If passing a custom colormap, it must be an instance of matplotlib.colors.Colormap (e.g., matplotlib.colors.ListedColormap).

transparentbool | None

If True: use a linear transparency between fmin and fmid and make values below fmin fully transparent (symmetrically for divergent colormaps). None will choose automatically based on colormap type.

orientationstr

Orientation of the colorbar, can be “vertical” or “horizontal”.

labelstr

The colorbar label.

bgcolorcolor

The color behind the colorbar (for alpha blending).

Returns:

cbarinstance of ColorbarBase

The colorbar.

Notes

New in v0.19.

Examples using mne.viz.plot_brain_colorbar

Make figures more publication ready

Make figures more publication ready