StatInfoResults

class sherpa.fit.StatInfoResults(statname: str, statval: float, numpoints: int, model, dof: int, qval: float | None = None, rstat: float | None = None)

Bases: NoNewAttributesAfterInit

A summary of the current statistic value for one or more data sets.

Attributes Summary

name	The name of the data set, or sets.
ids	The data set ids (it may be a tuple or array) included in the results.
bkg_ids	The background data set ids (it may be a tuple or array) included in the results, if any.
statname	The name of the statistic function.
statval	The statistic value.
numpoints	The number of bins used in the fits.
dof	The number of degrees of freedom in the fit (the number of bins minus the number of free parameters).
qval	The Q-value (probability) that one would observe the reduced statistic value, or a larger value, if the assumed model is true and the current model parameters are the true parameter values.
rstat	The reduced statistic value (the statval field divided by dof).

Methods Summary

format()

Return a string representation of the statistic.

Attributes Documentation

name: str

The name of the data set, or sets.

ids: Sequence[int | str] | None

The data set ids (it may be a tuple or array) included in the results.

bkg_ids: Sequence[int | str] | None

The background data set ids (it may be a tuple or array) included in the results, if any.

statname: str

The name of the statistic function.

statval: float

The statistic value.

numpoints: int

The number of bins used in the fits.

dof: int

The number of degrees of freedom in the fit (the number of bins minus the number of free parameters).

qval: float | None

The Q-value (probability) that one would observe the reduced statistic value, or a larger value, if the assumed model is true and the current model parameters are the true parameter values. This will be None if the value can not be calculated with the current statistic (e.g. the Cash statistic).

rstat: float | None

The reduced statistic value (the statval field divided by dof). This is not calculated for all statistics.

Methods Documentation

format() → str

Return a string representation of the statistic.

Returns:

txt – A multi-line representation of the statistic value or values.

Return type:

str