lsst.afw.coord.utils Namespace Reference

Functions
def	assertCoordsAlmostEqual (testCase, coord0, coord1, maxDiff=0.001 *afwGeom.arcseconds, msg="Coords differ")
	Assert that two coords represent almost the same point on the sky. More...
def	assertCoordListsAlmostEqual (testCase, coordlist0, coordlist1, maxDiff=0.001 *afwGeom.arcseconds, msg=None)
	Assert that two lists of IcrsCoords represent almost the same point on the sky. More...
def	assertCoordsNearlyEqual (args, kwargs)

Variables
list	__all__ = ["assertCoordsAlmostEqual", "assertCoordsNearlyEqual"]

Function Documentation

assertCoordListsAlmostEqual()

def lsst.afw.coord.utils.assertCoordListsAlmostEqual	(		testCase,
			coordlist0,
			coordlist1,
			maxDiff = 0.001*afwGeom.arcseconds,
			msg = None
	)

Assert that two lists of IcrsCoords represent almost the same point on the sky.

Warning

the coordinate systems are not compared; instead both sets of 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]	coordlist0	list of IcrsCoords 0
[in]	coordlist1	list of IcrsCoords 1
[in]	maxDiff	maximum angular separation, an lsst.afw.geom.Angle
[in]	msg	exception message prefix; details of the error are appended after ": "

Definition at line 60 of file utils.py.

def assertCoordListsAlmostEqual(testCase, coordlist0, coordlist1, maxDiff=0.001*afwGeom.arcseconds, msg=None):
    """!Assert that two lists of IcrsCoords represent almost the same point on the sky

    @warning the coordinate systems are not compared; instead both sets of 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] coordlist0  list of IcrsCoords 0
    @param[in] coordlist1  list of IcrsCoords 1
    @param[in] maxDiff  maximum angular separation, an lsst.afw.geom.Angle
    @param[in] msg  exception message prefix; details of the error are appended after ": "
    """
    testCase.assertEqual(len(coordlist0), len(coordlist1), msg=msg)
    sepArr = np.array([sp0.toIcrs().angularSeparation(sp1.toIcrs())
                       for sp0, sp1 in zip(coordlist0, coordlist1)])
    badArr = sepArr > maxDiff
    if np.any(badArr):
        msg = "" if msg is None else msg + ": "
        maxInd = np.argmax(sepArr)
        testCase.fail("%sIcrsCoordLists differ in %s places; max separation is at %s: %s\" > %s\"" %
                      (msg, np.sum(badArr), maxInd, sepArr[maxInd].asArcseconds(),
                       maxDiff.asArcseconds()))


@lsst.utils.tests.inTestCase

assertCoordsAlmostEqual()

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

Assert that two coords represent almost 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 38 of file utils.py.

def assertCoordsAlmostEqual(testCase, coord0, coord1, maxDiff=0.001*afwGeom.arcseconds, msg="Coords differ"):
    """!Assert that two coords represent almost 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()))


@lsst.utils.tests.inTestCase

assertCoordsNearlyEqual()

def lsst.afw.coord.utils.assertCoordsNearlyEqual	(		args,
			kwargs
	)

Definition at line 86 of file utils.py.

def assertCoordsNearlyEqual(*args, **kwargs):
    warnings.warn("Deprecated. Use assertCoordsAlmostEqual",
                  DeprecationWarning, 2)
    assertCoordsAlmostEqual(*args, **kwargs)

Variable Documentation

__all__

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

private

Definition at line 27 of file utils.py.

---

Generated on Sat Apr 7 2018 06:23:35 for LSSTApplications by   1.8.13