StatInfoResults

class sherpa.fit.StatInfoResults(statname, statval, numpoints, model, dof, qval=None, rstat=None)[source]

Bases: sherpa.utils.NoNewAttributesAfterInit

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

name

The name of the data set, or sets.

Type:str
ids

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

Type:sequence of int or str
bkg_ids

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

Type:sequence of int or str, or None
statname

The name of the statistic function.

Type:str
statval

The statistic value.

Type:number
numpoints

The number of bins used in the fits.

Type:int
dof

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

Type:int
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. This will be None if the value can not be calculated with the current statistic (e.g. the Cash statistic).

Type:number or None
rstat

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

Type:number of None

Methods Summary

format() Return a string representation of the statistic.

Methods Documentation

format()[source]

Return a string representation of the statistic.

Returns:txt – A multi-line representation of the statistic value or values.
Return type:str