fooof.data.FOOOFSettings

class fooof.data.FOOOFSettings

User defined settings for the fitting algorithm.

Parameters

peak_width_limitstuple of (float, float)

Limits on possible peak width, in Hz, as (lower_bound, upper_bound).

max_n_peaksint

Maximum number of peaks to fit.

min_peak_heightfloat

Absolute threshold for detecting peaks, in units of the input data.

peak_thresholdfloat

Relative threshold for detecting peaks, in units of standard deviation of the input data.

aperiodic_mode{‘fixed’, ‘knee’}

Which approach to take for fitting the aperiodic component.

Notes

This object is a data object, based on a NamedTuple, with immutable data attributes.