specparam.analysis.periodic.get_highest_peak

specparam.analysis.periodic.get_highest_peak(peak_params)

Extract the highest power peak.

Parameters:

peak_params2d array

Peak parameters, with shape of [n_peaks, 3].

Returns:

1d array

Peak data. The row is a peak, as [CF, PW, BW].

Notes

This function returns the singular highest power peak from the input set, and as such is defined to work on periodic parameters from a single model fit.