ErrorEstResults

class sherpa.fit.ErrorEstResults(fit: Fit, results, parlist: Sequence[Parameter] | None = None)

Bases: NoNewAttributesAfterInit

The results of an error estimation run.

This object contains the parameter ranges, information on the statistic and optimisation-method used, and other relevant information.

Attributes Summary

datasets	A sequence of the data set ids included in the results.
methodname	The name of the optimisation method used (in lower case).
iterfitname	What iterated-fit scheme was used, if any.
fitname	The name of the method used to fit the data, in lower case.
statname	The name of the statistic used to fit the data, in lower case.
sigma	The error values represent this number of sigma (assuming a Gaussian distribution).
percent	The percentage value for the errors (calculated from the sigma value assuming Gaussian errors).
parnames	The parameter names that were varied in the fit (the thawed parameters in the model expression).
parvals	The parameter values, in the same order as parnames.
parmins	The parameter minimum values, in the same order as parnames.
parmaxes	The parameter maximum values, in the same order as parnames.
nfits	The number of fits performed during the error analysis.
extra_output	The extra_output field from the fit.

Methods Summary

format()

Return a string representation of the error estimates.

Attributes Documentation

datasets: list[int | str] | None

A sequence of the data set ids included in the results.

methodname: str

The name of the optimisation method used (in lower case).

iterfitname: str | None

What iterated-fit scheme was used, if any.

fitname: str

The name of the method used to fit the data, in lower case.

statname: str

The name of the statistic used to fit the data, in lower case.

sigma: float

The error values represent this number of sigma (assuming a Gaussian distribution).

percent: float

The percentage value for the errors (calculated from the sigma value assuming Gaussian errors).

parnames: tuple[str, ...]

The parameter names that were varied in the fit (the thawed parameters in the model expression).

parvals: tuple[float, ...]

The parameter values, in the same order as parnames.

parmins: tuple[float, ...]

The parameter minimum values, in the same order as parnames.

parmaxes: tuple[float, ...]

The parameter maximum values, in the same order as parnames.

nfits: int

The number of fits performed during the error analysis.

extra_output

The extra_output field from the fit.

Methods Documentation

format() → str

Return a string representation of the error estimates.

Returns:

txt – A multi-line representation of the error estimates.

Return type:

str