mne.viz.plot_evoked_joint

mne.viz.plot_evoked_joint(evoked, times='peaks', title='', picks=None, exclude=None, show=True, ts_args=None, topomap_args=None)

Plot evoked data as butterfly plot and add topomaps for selected time points.

Parameters:

evoked : instance of Evoked

The evoked instance.

times : float | array of floats | “auto” | “peaks”.

The time point(s) to plot. If “auto”, 5 evenly spaced topographies between the first and last time instant will be shown. If “peaks”, finds time points automatically by checking for 3 local maxima in Global Field Power. Defaults to “peaks”.

title : str | None

The title. If None, suppress printing channel type. Defaults to ‘’.

picks : array-like of int | None

The indices of channels to plot. If None show all. Defaults to None.

exclude : None | list of str | ‘bads’

Channels names to exclude from being shown. If ‘bads’, the bad channels are excluded. Defaults to None.

show : bool

Show figure if True. Defaults to True.

ts_args : None | dict

A dict of kwargs that are forwarded to evoked.plot to style the butterfly plot. axes and show are ignored. If spatial_colors is not in this dict, spatial_colors=True, and (if it is not in the dict) zorder=’std’ will be passed. Defaults to None.

topomap_args : None | dict

A dict of kwargs that are forwarded to evoked.plot_topomap to style the topomaps. axes and show are ignored. If times is not in this dict, automatic peak detection is used. Beyond that, if None`, no customizable arguments will be passed. Defaults to ``None.

Returns:

fig : instance of matplotlib.figure.Figure | list

The figure object containing the plot. If evoked has multiple channel types, a list of figures, one for each channel type, is returned.

Notes

New in version 0.12.0.