lsst.afw.geom.utils Namespace Reference

Functions
def	assertAnglesNearlyEqual
	Assert that two angles are nearly equal, ignoring wrap differences by default. More...
def	assertPairsNearlyEqual
	Assert that two planar pairs (e.g. More...
def	assertBoxesNearlyEqual
	Assert that two boxes (Box2D or Box2I) are nearly equal. More...

Variables
list	__all__ = ["assertAnglesNearlyEqual", "assertPairsNearlyEqual", "assertBoxesNearlyEqual"]

Function Documentation

def lsst.afw.geom.utils.assertAnglesNearlyEqual	(		testCase,
			ang0,
			ang1,
			maxDiff = 0.001*geomLib.arcseconds,
			ignoreWrap = True,
			msg = "Angles differ"
	)

Assert that two angles are nearly equal, ignoring wrap differences by default.

Parameters

[in]	testCase	unittest.TestCase instance the test is part of; an object supporting one method: fail(self, msgStr)
[in]	ang0	angle 0 (an lsst.afw.geom.Angle)
[in]	ang1	angle 1 (an lsst.afw.geom.Angle)
[in]	maxDiff	maximum difference between the two angles (an lsst.afw.geom.Angle)
[in]	ignoreWrap	ignore wrap when comparing the angles? if True then wrap is ignored, e.g. 0 and 360 degrees are considered equal if False then wrap matters, e.g. 0 and 360 degrees are considered different
[in]	msg	exception message prefix; details of the error are appended after ": "

Exceptions

AssertionError

if the difference is greater than maxDiff

Definition at line 36 of file utils.py.

        ignoreWrap=True, msg="Angles differ"):
    """!Assert that two angles are nearly equal, ignoring wrap differences by default

    @param[in] testCase  unittest.TestCase instance the test is part of;
                        an object supporting one method: fail(self, msgStr)
    @param[in] ang0  angle 0 (an lsst.afw.geom.Angle)
    @param[in] ang1  angle 1 (an lsst.afw.geom.Angle)
    @param[in] maxDiff  maximum difference between the two angles (an lsst.afw.geom.Angle)
    @param[in] ignoreWrap  ignore wrap when comparing the angles?
        - if True then wrap is ignored, e.g. 0 and 360 degrees are considered equal
        - if False then wrap matters, e.g. 0 and 360 degrees are considered different
    @param[in] msg  exception message prefix; details of the error are appended after ": "

    @throw AssertionError if the difference is greater than maxDiff
    """
    measDiff = ang1 - ang0
    if ignoreWrap:
        measDiff.wrapCtr()
    if abs(measDiff) > maxDiff:
        testCase.fail("%s: measured difference %s arcsec > max allowed %s arcsec" %
            (msg, measDiff.asArcseconds(), maxDiff.asArcseconds()))