fooof.analysis.periodic.get_band_peak¶
- fooof.analysis.periodic.get_band_peak(peak_params, band, select_highest=True, threshold=None, thresh_param='PW')[source]¶
Extract peaks within a given band of interest.
- Parameters
- peak_params2d array
Peak parameters, with shape of [n_peaks, 3].
- bandtuple of (float, float)
Frequency range for the band of interest. Defined as: (lower_frequency_bound, upper_frequency_bound).
- select_highestbool, optional, default: True
Whether to return single peak (if True) or all peaks within the range found (if False). If True, returns the highest peak within the search range.
- thresholdfloat, optional
A minimum threshold value to apply.
- thresh_param{‘PW’, ‘BW’}
Which parameter to threshold on. ‘PW’ is power and ‘BW’ is bandwidth.
- Returns
- band_peaks1d or 2d array
Peak data. Each row is a peak, as [CF, PW, BW].