mne_denoise.viz.plot_psd_overlay

mne_denoise.viz.plot_psd_overlay(freqs_reference, psd_reference, series_psds, focus_freq, fmax=125.0, focus_half_width_hz=10.0, n_harmonics=3, title='', series_order=None, series_colors=None, series_labels=None, fname=None, show=True)

Plot full-spectrum and focused PSD overlays across multiple series.

Parameters:

freqs_referencearray-like of shape (n_freqs,)

Frequency vector for the reference PSD.

psd_referencearray-like of shape (n_freqs,)

Reference PSD values.

series_psdsmapping[str, tuple[array-like, array-like]]

Mapping from series name to (freqs, psd) arrays.

focus_freqfloat

Center frequency for the zoomed overlay panel.

fmaxfloat

Max frequency shown in the full-spectrum panel.

focus_half_width_hzfloat

Half-width (Hz) used for the zoomed panel around focus_freq.

n_harmonicsint

Number of harmonics to mark on the full-spectrum panel.

titlestr

Optional title for the full-spectrum panel.

series_ordersequence[str] | None

Optional plotting order.

series_colorsmapping[str, str] | None

Optional color overrides by series name.

series_labelsmapping[str, str] | None

Optional 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 focus_half_width_hz <= 0.