mne_denoise.viz.plot_component_cleaning_summary#

mne_denoise.viz.plot_component_cleaning_summary(scores=None, selected_count=0, patterns=None, info=None, channel_names=None, removed=None, sources=None, sfreq=None, freqs=None, psd_before=None, psd_after=None, line_freq=None, fmax=100.0, segment_info=None, summary_rows=None, title='Component Cleaning Summary', figsize=None, dpi=200, show=True, fname=None)[source]#

Plot a generic component-cleaning dashboard.

Parameters:

scoresarray-like | None: Component score vector.
selected_countint: Number of selected/removed components.
patternsarray-like | None: Component patterns with shape (n_channels, n_components).
infomne.Info | None: Optional MNE info for topomap rendering.
channel_namessequence of str | None: Channel labels used by non-topomap fallback panels.
removedarray-like | None: Removed signal with shape (n_channels, n_times) or (n_epochs, n_channels, n_times).
sourcesarray-like | None: Component source traces with shape (n_components, n_times) or (n_epochs, n_components, n_times).
sfreqfloat | None: Sampling frequency for source/segment time axes.
freqsarray-like | None: Frequency axis for PSD panel.
psd_beforearray-like | None, default=None: PSD values before denoising.
psd_afterarray-like | None, default=None: PSD values after denoising.
line_freqfloat | None: Optional line frequency marker in PSD panel.
fmaxfloat: Upper frequency bound for PSD panel.
segment_infolist[dict] | None: Optional segmented metadata. If provided, segmented panels replace score/removed/source panels.
summary_rowslist[tuple[str, object]] | None: Optional explicit table rows.
titlestr: Figure title.
figsizetuple[float, float] | None: Figure size.
dpiint: Figure resolution.
showbool: Whether to show the figure.
fnamepath-like | None: Optional output path.

Returns:

figmatplotlib.figure.Figure: Figure handle.

Raises:

ValueError: If panel inputs are incompatible with expected dimensions or metadata requirements (for example invalid source/pattern/segment shapes).