Measurement.compare_residuals

giant.ufo.measurements:

abstract static Measurement.compare_residuals(first, second)[source]

This compares residuals computed using these measurement models.

If this returns True, then first is smaller than or equal to second (according to the definition of the residuals for this measurement). If False, then ``first is larger than second. This is used to check for divergence.

Parameters:

  • first (Sequence | ndarray | Real) – The first residual

  • second (Sequence | ndarray | Real) – The second residual

Returns:

True if the first residual <= second residual otherwise False

Return type:

bool