specparam.analysis.get_band_peak_event¶
- specparam.analysis.get_band_peak_event(event, band, threshold=None, thresh_param='PW', attribute='peak_params')[source]¶
Extract peaks from a band of interest from an event model object.
- Parameters:
- eventSpectralTimeEventModel
Object to extract peak data from.
- 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 power 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.
- attribute{‘peak_params’, ‘gaussian_params’}
Which attribute of peak data to extract data from.
- Returns:
- peaks3d array
Array of peak data, organized as [n_events, n_time_windows, n_peak_params].