scippneutron.peaks.FitAssessment#

class scippneutron.peaks.FitAssessment(value)[source]#

Indicates whether the fit was successful or how if failed.

__init__()#

Attributes

`success`	The fit was successful.
`failed`	The fit failed for some reason.
`background_is_better`	The background fit yielded a better result than the background+peak fit.
`peak_too_narrow`	The peak is too narrow given the resolution of the data.
`peak_too_wide`	The peak is too wide given the size of the fit window.
`peak_near_edge`	The peak is too close to the edge of the window.
`peak_points_down`	The peak amplitude is negative.
`p_too_small`	The p-value of the fit is below threshold.
`window_too_narrow`	The fit window does not contain enough points.

background_is_better = 3#: The background fit yielded a better result than the background+peak fit.

failed = 2#: The fit failed for some reason.

p_too_small = 8#: The p-value of the fit is below threshold.

peak_near_edge = 6#: The peak is too close to the edge of the window.

peak_points_down = 7#: The peak amplitude is negative.

peak_too_narrow = 4#: The peak is too narrow given the resolution of the data.

peak_too_wide = 5#: The peak is too wide given the size of the fit window.

success = 1#: The fit was successful.

window_too_narrow = 9#: The fit window does not contain enough points.