mne_denoise.viz.plot_signal_diagnostics_summary#
- mne_denoise.viz.plot_signal_diagnostics_summary(signals, *, channel, times, group_order, reference_group, group_colors, group_labels, channel_names=None, channel_label=None, windows=None, title='Signal Diagnostics Summary', show=True, fname=None)[source]#
Plot grouped time-domain signal diagnostics.
- Parameters:
- signalsmapping[str, array-like | MNE object]
Mapping from group name to signal data. Each value must be 2D
(n_channels, n_times)or 3D(n_epochs, n_channels, n_times).- channelint | str
Channel selector. String selectors require explicit
channel_names.- timesarray-like of shape (n_times,)
Explicit time axis.
- channel_namessequence of str | None
Explicit channel names used for string
channelselectors and channel labeling. The function does not infer names from MNE inputs.- channel_labelstr | None
Explicit channel label when
channel_namesis not provided.- group_ordersequence of str
Explicit group plotting order.
- reference_groupstr
Explicit reference group used for the difference panel.
- group_colorsmapping
Explicit color mapping keyed by group.
- group_labelsmapping
Explicit display-label mapping keyed by group.
- windowssequence of tuple[float, float, str] | None
Optional highlighted windows. Each entry must be
(start, stop, label).- titlestr
Figure title.
- showbool
Whether to show the figure.
- fnamepath-like | None
Optional output path.
- Returns:
- figmatplotlib.figure.Figure
Figure handle.
- Raises:
- ValueError
If
signalsis empty,timesis shape-incompatible, channel metadata is insufficient for the requested selector, or group ordering is invalid.