assertFloatsAlmostEqual

lsst.utils.tests.assertFloatsAlmostEqual(testCase, lhs, rhs, rtol=2.220446049250313e-16, atol=2.220446049250313e-16, relTo=None, printFailures=True, plotOnFailure=False, plotFileName=None, invert=False, msg=None)[source]

Highly-configurable floating point comparisons for scalars and arrays.

The test assertion will fail if all elements lhs and rhs are not equal to within the tolerances specified by rtol and atol. More precisely, the comparison is:

abs(lhs - rhs) <= relTo*rtol OR abs(lhs - rhs) <= atol

If rtol or atol is None, that term in the comparison is not performed at all.

When not specified, relTo is the elementwise maximum of the absolute values of lhs and rhs. If set manually, it should usually be set to either lhs or rhs, or a scalar value typical of what is expected.

Parameters:

testCase : unittest.TestCase

Instance the test is part of.

lhs : scalar or array-like

LHS value(s) to compare; may be a scalar or array-like of any dimension

rhs : scalar or array-like

RHS value(s) to compare; may be a scalar or array-like of any dimension

rtol : float or None

Relative tolerance for comparison; defaults to double-precision epsilon.

atol : float or None

Absolute tolerance for comparison; defaults to double-precision epsilon.

relTo : float

Value to which comparison with rtol is relative.

printFailures : bool

Upon failure, print all inequal elements as part of the message.

plotOnFailure : bool

Upon failure, plot the originals and their residual with matplotlib. Only 2-d arrays are supported.

plotFileName : str

Filename to save the plot to. If None, the plot will be displayed in a window.

invert : bool

If True, invert the comparison and fail only if any elements are equal. Used to implement assertFloatsNotEqual, which should generally be used instead for clarity.

msg : str

String to append to the error message when assert fails.