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
or
topomap_args
. In that case both ts_args
and
topomap_args
axes have to be used. Be aware that when the
axes are provided, their position may be slightly modified.
Evoked
The evoked instance.
float
| array
of float
| “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"
.
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 set title=None
, otherwise some of your
axes may be removed during placement of the title axis.
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 in
info['bads']
will be included if their names or indices are
explicitly provided.
None
| list
of str
| ‘bads’Channels names to exclude from being shown. If 'bads'
, the
bad channels are excluded. Defaults to None
.
Show figure if True
. Defaults to True
.
None
| dict
A dict of kwargs
that are forwarded to mne.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
and exclude
are illegal.
If None
, no customizable arguments will be passed.
Defaults to None
.
None
| dict
A dict of kwargs
that are forwarded to
mne.Evoked.plot_topomap()
to style the topomaps.
If it is not in this dict, outlines='skirt'
will be passed.
show
, times
, colorbar
are illegal.
If None
, no customizable arguments will be passed.
Defaults to None
.
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.