firecrown.likelihood.gauss_family.statistic.statistic.StatisticsResult

firecrown.likelihood.gauss_family.statistic.statistic.StatisticsResult#

class firecrown.likelihood.gauss_family.statistic.statistic.StatisticsResult(data, theory)[source]#

Bases: object

This is the type returned by the compute method of any Statistic.

Parameters:

Public Methods:

__post_init__()

Make sure the data and theory vectors are of the same shape.

residuals()

Return the residuals -- the difference between data and theory.

__iter__()

Iterate through the data members.

__init__(data, theory)

param data:

__repr__()

Return repr(self).

__eq__(other)

Return self==value.


__eq__(other)#

Return self==value.

__iter__()[source]#

Iterate through the data members.

This is to allow automatic unpacking, as if the StatisticsResult were a tuple of (data, theory).

This method is a temporary measure to help code migrate to the newer, safer interface for Statistic.compute().

__post_init__()[source]#

Make sure the data and theory vectors are of the same shape.

residuals()[source]#

Return the residuals – the difference between data and theory.

Return type:

ndarray[Any, dtype[float64]]