scippneutron.peaks.FitRequirements#
- class scippneutron.peaks.FitRequirements(*, min_p_value=0.01, max_peak_width_factor=1.0, min_peak_width_factor=1.0)[source]#
Requirements that fitted models must satisfy to be considered successful.
- __init__(*, min_p_value=0.01, max_peak_width_factor=1.0, min_peak_width_factor=1.0)#
Methods
__init__(*[, min_p_value, ...])Attributes
Minimum for the p-value of the fit.
Maximum allowed width of peaks relative to fit window.
Minimum allowed width of peaks relative to coordinate spacing.
-
max_peak_width_factor:
float# Maximum allowed width of peaks relative to fit window.
The full width at half maximum of fitted peaks must satisfy
\[\mathsf{FWHM} < \mathsf{max\_peak\_width\_factor} \cdot \mathsf{window\_width}\]
-
min_p_value:
float# Minimum for the p-value of the fit.
See
FitResult.p_value.
-
min_peak_width_factor:
float# Minimum allowed width of peaks relative to coordinate spacing.
The full width at half maximum of fitted peaks must satisfy
\[\mathsf{FWHM} < \mathsf{min\_peak\_width\_factor} \cdot \Delta_{\mathsf{coord}}\]where \(\Delta_{\mathsf{coord}}\) is the spacing of the coordinate around the peak center.