- mne.viz.plot_tfr_topomap(tfr, tmin=None, tmax=None, fmin=0.0, fmax=inf, *, ch_type=None, baseline=None, mode='mean', sensors=True, show_names=False, mask=None, mask_params=None, contours=6, outlines='head', sphere=None, image_interp='cubic', extrapolate='auto', border='mean', res=64, size=2, cmap=None, vlim=(None, None), cnorm=None, colorbar=True, cbar_fmt='%1.1e', units=None, axes=None, show=True)#
Plot topographic maps of specific time-frequency intervals of TFR data.
The AverageTFR object.
- tmin, tmax
First and last times to include, in seconds.
Noneuses the first or last time present in the data. Default is
tmin=None, tmax=None(all times).
- fmin, fmax
The lower- and upper-bound on frequencies of interest. Default is
fmin=0, fmax=np.inf(spans all frequencies present in the data).
- ch_type‘mag’ | ‘grad’ | ‘planar1’ | ‘planar2’ | ‘eeg’ |
The channel type to plot. For
'grad', the gradiometers are collected in pairs and the mean for each pair is plotted. If
Nonethe first available channel type from order shown above is used. Defaults to
listof length 2
The time interval to apply rescaling / baseline correction. If None do not apply it. If baseline is (a, b) the interval is between “a (s)” and “b (s)”. If a is None the beginning of the data is used and if b is None then b is set to the end of the interval. If baseline is equal to (None, None) the whole time interval is used.
- mode‘mean’ | ‘ratio’ | ‘logratio’ | ‘percent’ | ‘zscore’ | ‘zlogratio’ |
Perform baseline correction by
subtracting the mean baseline power (‘mean’)
dividing by the mean baseline power (‘ratio’)
dividing by the mean baseline power and taking the log (‘logratio’)
subtracting the mean baseline power followed by dividing by the mean baseline power (‘percent’)
subtracting the mean baseline power and dividing by the standard deviation of the baseline power (‘zscore’)
dividing by the mean baseline power, taking the log, and dividing by the standard deviation of the baseline power (‘zlogratio’)
If None no baseline correction is applied.
Whether to add markers for sensor locations. If
str, should be a valid matplotlib format string (e.g.,
'r+'for red plusses, see the Notes section of
True(the default), black circles will be used.
True, show channel names next to each sensor marker. If callable, channel names will be formatted using the callable; e.g., to delete the prefix ‘MEG ‘ from all channel names, pass the function
lambda x: x.replace('MEG ', ''). If
None, only non-masked sensor names will be shown.
bool, shape (n_channels, n_times) |
Array indicating channel-time combinations to highlight with a distinct plotting style (useful for, e.g. marking which channels at which times a statistical test of the data reaches significance). Array elements set to
Truewill be plotted with the parameters given in
mask_params. Defaults to
None, equivalent to an array of all
Additional plotting parameters for plotting significant sensors. Default (None) equals:
dict(marker='o', markerfacecolor='w', markeredgecolor='k', linewidth=0, markersize=4)
The number of contour lines to draw. If
0, no contours will be drawn. If a positive integer, that number of contour levels are chosen using the matplotlib tick locator (may sometimes be inaccurate, use array for accuracy). If array-like, the array values are used as the contour levels. The values should be in µV for EEG, fT for magnetometers and fT/m for gradiometers. If
colorbar=True, the colorbar will have ticks corresponding to the contour levels. Default is
- outlines‘head’ |
The outlines to be drawn. If ‘head’, the default head scheme will be drawn. If dict, each key refers to a tuple of x and y positions, the values in ‘mask_pos’ will serve as image mask. Alternatively, a matplotlib patch object can be passed for advanced masking options, either directly or as a function that returns patches (required for multi-axis plots). If None, nothing will be drawn. Defaults to ‘head’.
float| array_like | instance of
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
ConductorModelto 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'is not present, it will be approximated from the coordinates of
None(the default) is equivalent to
'auto'when enough extra digitization points are available, and (0, 0, 0, 0.095) otherwise.
New in version 0.20.
Changed in version 1.1: Added
The image interpolation to be used. Options are
'cubic'(default) to use
Extrapolate to four points placed to form a square encompassing all data points, where each side of the square is three times the range of the data in the respective dimension.
'local'(default for MEG sensors)
Extrapolate only to nearby points (approximately to points closer than median inter-electrode distance). This will also set the mask to be polygonal based on the convex hull of the sensors.
'head'(default for non-MEG sensors)
Extrapolate out to the edges of the clipping circle. This will be on the head circle when the sensors are contained within the head circle, but it can extend beyond the head when sensors are plotted outside the head circle.
Changed in version 0.21:
The default was changed to
'local'for MEG sensors.
'local'was changed to use a convex hull mask
'head'was changed to extrapolate out to the clipping circle.
Value to extrapolate to on the topomap borders. If
'mean'(default), then each extrapolated point has the average value of its neighbours.
New in version 0.20.
The resolution of the topomap image (number of pixels along each side).
Side length of each subplot in inches.
- cmapmatplotlib colormap | (colormap,
bool) | ‘interactive’ |
Colormap to use. If
tuple, the first value indicates the colormap to use and the second value is a boolean defining interactivity. In interactive mode the colors are adjustable by clicking and dragging the colorbar with left and right mouse button. Left mouse button moves the scale up and down and right mouse button adjusts the range. Hitting space bar resets the range. Up and down arrows can be used to change the colormap. If
'Reds'is used for data that is either all-positive or all-negative, and
'RdBu_r'is used otherwise.
'interactive'is equivalent to
(None, True). Defaults to
Interactive mode works smoothly only for a small amount of topomaps. Interactive mode is disabled by default for more than 2 topomaps.
tupleof length 2
Colormap limits to use. If a
tupleof floats, specifies the lower and upper bounds of the colormap (in that order); providing
Nonefor either entry will set the corresponding boundary at the min/max of the data. Defaults to
New in version 1.2.
How to normalize the colormap. If
None, standard linear normalization is performed. If not
vmaxwill be ignored. See Matplotlib docs for more details on colormap normalization, and the ERDs example for an example of its use.
New in version 1.2.
Plot a colorbar in the rightmost column of the figure.
Formatting string for colorbar tick labels. See Format Specification Mini-Language for details.
The units of the channel type; used for the colorbar label. Ignored if
Nonethe label will be “AU” indicating arbitrary units. Default is
- axesinstance of
The axes to plot to. If
None, a new
Figurewill be created. Default is
Show the figure if
The figure containing the topography.