specparam.analysis.periodic.threshold_peaks

specparam.analysis.periodic.threshold_peaks(peak_params, threshold, param='PW')[source]

Extract peaks that are above a given threshold value.

Parameters:
peak_params2d array

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

thresholdfloat

A minimum threshold value to apply.

param{‘PW’, ‘BW’}

Which parameter to threshold on. ‘PW’ is power and ‘BW’ is bandwidth.

Returns:
thresholded_peaks2d array

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

Notes

This function can be applied to periodic parameters from an individual model, or a set or parameters from a group.