mne_denoise.viz.plot_narrowband_score_scan

mne_denoise.viz.plot_narrowband_score_scan(frequencies, eigenvalues, peak_freq=None, true_freqs=None, ax=None, show=True, fname=None)

Plot score/eigenvalue profiles from a narrowband scan.

Parameters:

frequenciesarray-like of shape (n_freqs,)

Frequency grid used in the scan.

eigenvaluesarray-like of shape (n_freqs,) | (n_freqs, n_components)

Scan scores. For 2D inputs, the first column is treated as dominant.

peak_freqfloat | None

Optional frequency to highlight with a marker and vertical line.

true_freqssequence of float | None

Optional reference frequencies to mark.

axmatplotlib.axes.Axes | None

Target axes. If None, create a new figure and axes.

showbool

If True, display the figure.

fnamepath-like | None

Optional output path used to save the figure.

Returns:

figmatplotlib.figure.Figure

Figure handle.

Raises:

ValueError

If frequencies is not 1D, if eigenvalues is not 1D/2D, or if their first dimensions do not match.