specparam.data.ModelSettings¶
- class specparam.data.ModelSettings(peak_width_limits, max_n_peaks, min_peak_height, peak_threshold, aperiodic_mode)[source]¶
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.
