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)[source]¶
Plot evoked data as butterfly plot and add topomaps for time points.
Note
Axes to plot in can be passed by the user through
ts_args
ortopomap_args
. In that case bothts_args
andtopomap_args
axes have to be used. Be aware that when the axes are provided, their position may be slightly modified.- Parameters
- evokedinstance of
Evoked
The evoked instance.
- times
float
|array
offloat
| “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 title. If an empty string, a default title is created. Defaults to ‘’. If custom axes are passed make sure to settitle=None
, otherwise some of your axes may be removed during placement of the title axis.- picks
str
|list
|slice
|None
Channels to include. Slices and lists of integers will be interpreted as channel indices. In lists, channel type strings (e.g.,
['meg', 'eeg']
) will pick channels of those types, channel name strings (e.g.,['MEG0111', 'MEG2623']
will pick the given channels. Can also be the string values “all” to pick all channels, or “data” to pick data channels. None (default) will pick all channels. Note that channels ininfo['bads']
will be included if their names or indices are explicitly provided.- exclude
None
|list
ofstr
| ‘bads’ Channels names to exclude from being shown. If
'bads'
, the bad channels are excluded. Defaults toNone
.- showbool
Show figure if
True
. Defaults toTrue
.- ts_args
None
|dict
A dict of
kwargs
that are forwarded tomne.Evoked.plot()
to style the butterfly plot. If they are not in this dict, the following defaults are passed:spatial_colors=True
,zorder='std'
.show
andexclude
are illegal. IfNone
, no customizable arguments will be passed. Defaults toNone
.- topomap_args
None
|dict
A dict of
kwargs
that are forwarded tomne.Evoked.plot_topomap()
to style the topomaps. If it is not in this dict,outlines='skirt'
will be passed.show
,times
,colorbar
are illegal. IfNone
, no customizable arguments will be passed. Defaults toNone
.
- evokedinstance of
- Returns
- figinstance 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.
- figinstance of
Notes
New in version 0.12.0.