mne_denoise.viz.plot_psd_zoom_comparison

mne_denoise.viz.plot_psd_zoom_comparison(freqs_before, psd_before, freqs_after, psd_after, series_name='', title='', zoom_freqs=None, zoom_annotations=None, fmax=125.0, zoom_half_width_hz=8.0, series_colors=None, series_labels=None, fname=None, show=True)

Plot a PSD comparison plus zoomed panels around selected frequencies.

Parameters:

freqs_beforearray-like of shape (n_freqs,)

Frequency vector for the before PSD curve.

freqs_afterarray-like of shape (n_freqs,)

Frequency vector for the after PSD curve.

psd_beforearray-like of shape (n_freqs,)

PSD vector aligned with freqs_before.

psd_afterarray-like of shape (n_freqs,)

PSD vector aligned with freqs_after.

series_namestr

Series key used for optional color/label mapping.

titlestr

Optional figure suptitle.

zoom_freqsarray-like of shape (n_zoom,)

Frequency centers for zoom panels.

zoom_annotationssequence[str] | None

Optional annotation text per zoom panel.

fmaxfloat

Max frequency on the full-spectrum panel.

zoom_half_width_hzfloat

Half-width (Hz) around each zoom_freq.

series_colorsmapping[str, str] | None

Optional color overrides by series name.

series_labelsmapping[str, str] | None

Optional display label overrides by series name.

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 zoom_freqs is empty/non-1D or if zoom_half_width_hz <= 0.