lsst.afw.coord.utils Namespace Reference

Functions
def	assertCoordsNearlyEqual
	Assert that two coords represent nearly the same point on the sky. More...

Variables
list	__all__ = ["assertCoordsNearlyEqual"]

Function Documentation

def lsst.afw.coord.utils.assertCoordsNearlyEqual	(		testCase,
			coord0,
			coord1,
			maxDiff = 0.001*afwGeom.arcseconds,
			msg = "Coords differ"
	)

Assert that two coords represent nearly the same point on the sky.

Warning

the coordinate systems are not compared; instead both angles are converted to ICRS and the angular separation measured.

Parameters

[in]	testCase	unittest.TestCase instance the test is part of; an object supporting one method: fail(self, msgStr)
[in]	coord0	coord 0 (an lsst.afw.geom.Coord)
[in]	coord1	coord 1 (an lsst.afw.geom.Coord)
[in]	maxDiff	maximum angular separation between the two coords (an lsst.afw.geom.Angle)
[in]	msg	exception message prefix; details of the error are appended after ": "

Exceptions

AssertionError

if the unwrapped difference is greater than maxDiff

Definition at line 33 of file utils.py.

def assertCoordsNearlyEqual(testCase, coord0, coord1, maxDiff=0.001*afwGeom.arcseconds, msg="Coords differ"):
    """!Assert that two coords represent nearly the same point on the sky

    @warning the coordinate systems are not compared; instead both angles are converted to ICRS
    and the angular separation measured.

    @param[in] testCase  unittest.TestCase instance the test is part of;
                        an object supporting one method: fail(self, msgStr)
    @param[in] coord0  coord 0 (an lsst.afw.geom.Coord)
    @param[in] coord1  coord 1 (an lsst.afw.geom.Coord)
    @param[in] maxDiff  maximum angular separation between the two coords (an lsst.afw.geom.Angle)
    @param[in] msg  exception message prefix; details of the error are appended after ": "

    @throw AssertionError if the unwrapped difference is greater than maxDiff
    """
    measDiff = coord0.toIcrs().angularSeparation(coord1.toIcrs())
    if measDiff > maxDiff:
        testCase.fail("%s: measured angular separation %s arcsec > max allowed %s arcsec" %
            (msg, measDiff.asArcseconds(), maxDiff.asArcseconds()))

Variable Documentation

list lsst.afw.coord.utils.__all__ = ["assertCoordsNearlyEqual"]

Definition at line 30 of file utils.py.