mne_denoise.viz.plot_grand_average_evokeds#
- mne_denoise.viz.plot_grand_average_evokeds(all_evokeds, channels, time_windows=None, suptitle=None, group_order=None, group_colors=None, group_labels=None, amplitude_scale=1.0, y_label='Amplitude', x_label='Time', time_window_colors=None, time_window_alpha=0.06, panel_title_template='Grand Average at {channel}', figsize=None, fname=None, show=True)[source]#
Plot group-mean evoked responses with optional SEM bands.
- Parameters:
- all_evokedsmapping[str, sequence[mne.Evoked]]
Mapping from group key to subject-level evoked list.
- channelssequence[str]
Channel names to plot.
- time_windowsmapping[str, tuple[float, float]] | None
Optional named windows to shade on each axis.
- suptitlestr | None
Optional figure-level title.
- group_ordersequence[str] | None
Explicit plotting order. If None, first-seen mapping order is used.
- group_colorsmapping[str, str] | None
Optional colors by group key.
- group_labelsmapping[str, str] | None
Optional display labels by group key.
- amplitude_scalefloat
Multiplicative factor applied to evoked amplitudes before plotting.
- y_labelstr
Y-axis label used for all panels.
- x_labelstr
X-axis label used for all panels.
- time_window_colorsmapping[str, str] | None
Optional colors for named
time_windowsentries.- time_window_alphafloat
Alpha used for shaded
time_windows.- panel_title_templatestr
Format string for panel titles. Must support
{channel}.- figsizetuple[float, float] | None
Figure size in inches.
- fnamepath-like | None
Optional output path used to save the figure.
- showbool
If True, display the figure.
- Returns:
- figmatplotlib.figure.Figure
Figure handle.
- Raises:
- ValueError
If required groups/channels are missing or lists are empty.