lsst.geom  16.0-2-ge920381
Functions
lsst.geom.testUtils Namespace Reference

Functions

def extraMsg (msg)
 
def assertAnglesAlmostEqual (testCase, ang0, ang1, maxDiff=0.001 *arcseconds, ignoreWrap=True, msg="Angles differ")
 
def assertPairsAlmostEqual (testCase, pair0, pair1, maxDiff=1e-7, msg="Pairs differ")
 
def assertPairListsAlmostEqual (testCase, list0, list1, maxDiff=1e-7, msg=None)
 
def assertSpherePointsAlmostEqual (testCase, sp0, sp1, maxSep=0.001 *arcseconds, msg="")
 
def assertSpherePointListsAlmostEqual (testCase, splist0, splist1, maxSep=0.001 *arcseconds, msg=None)
 
def assertBoxesAlmostEqual (testCase, box0, box1, maxDiff=1e-7, msg="Boxes differ")
 

Function Documentation

◆ assertAnglesAlmostEqual()

def lsst.geom.testUtils.assertAnglesAlmostEqual (   testCase,
  ang0,
  ang1,
  maxDiff = 0.001*arcseconds,
  ignoreWrap = True,
  msg = "Angles differ" 
)
Assert that two `~lsst.afw.geom.Angle`\ s are almost equal, ignoring wrap differences by default

Parameters
----------
testCase : `unittest.TestCase`
    test case the test is part of; an object supporting one method: fail(self, msgStr)
ang0 : `lsst.afw.geom.Angle`
    angle 0
ang1 : `an lsst.afw.geom.Angle`
    angle 1
maxDiff : `an lsst.afw.geom.Angle`
    maximum difference between the two angles
ignoreWrap : `bool`
    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
msg : `str`
    exception message prefix; details of the error are appended after ": "

Raises
------
AssertionError
    Raised if the difference is greater than ``maxDiff``

Definition at line 46 of file testUtils.py.

◆ assertBoxesAlmostEqual()

def lsst.geom.testUtils.assertBoxesAlmostEqual (   testCase,
  box0,
  box1,
  maxDiff = 1e-7,
  msg = "Boxes differ" 
)
Assert that two boxes (`~lsst.afw.geom.Box2D` or `~lsst.afw.geom.Box2I`) are almost equal

Parameters
----------
testCase : `unittest.TestCase`
    test case the test is part of; an object supporting one method: fail(self, msgStr)
box0 : `lsst.afw.geom.Box2D` or `lsst.afw.geom.Box2I`
    box 0
box1 : `lsst.afw.geom.Box2D` or `lsst.afw.geom.Box2I`
    box 1
maxDiff : `float`
    maximum radial separation between the min points and max points
msg : `str`
    exception message prefix; details of the error are appended after ": "

Raises
------
AssertionError
    Raised if the radial difference of the min points or max points is greater than maxDiff

Notes
-----
.. warning::

   Does not compare types, just compares values.

Definition at line 220 of file testUtils.py.

◆ assertPairListsAlmostEqual()

def lsst.geom.testUtils.assertPairListsAlmostEqual (   testCase,
  list0,
  list1,
  maxDiff = 1e-7,
  msg = None 
)
Assert that two lists of Cartesian points are almost equal

Each point can be any indexable pair of two floats, including
Point2D or Extent2D, a list or a tuple.

Parameters
----------
testCase : `unittest.TestCase`
    test case the test is part of; an object supporting one method: fail(self, msgStr)
list0 : `list` of pairs of `float`
    list of pairs 0
list1 : `list` of pairs of `float`
    list of pairs 1
maxDiff : `float`
    maximum radial separation between the two points
msg : `str`
    additional information for the error message; appended after ": "

Raises
------
AssertionError
    Raised if the radial difference is greater than ``maxDiff``

Notes
-----
.. warning::

   Does not compare types, just values.

Definition at line 123 of file testUtils.py.

◆ assertPairsAlmostEqual()

def lsst.geom.testUtils.assertPairsAlmostEqual (   testCase,
  pair0,
  pair1,
  maxDiff = 1e-7,
  msg = "Pairs differ" 
)
Assert that two Cartesian points are almost equal.

Each point can be any indexable pair of two floats, including
Point2D or Extent2D, a list or a tuple.

Parameters
----------
testCase : `unittest.TestCase`
    test case the test is part of; an object supporting one method: fail(self, msgStr)
pair0 : pair of `float`
    pair 0
pair1 : pair of `floats`
    pair 1
maxDiff : `float`
    maximum radial separation between the two points
msg : `str`
    exception message prefix; details of the error are appended after ": "

Raises
------
AssertionError
    Raised if the radial difference is greater than ``maxDiff``

Notes
-----
.. warning::

   Does not compare types, just compares values.

Definition at line 80 of file testUtils.py.

◆ assertSpherePointListsAlmostEqual()

def lsst.geom.testUtils.assertSpherePointListsAlmostEqual (   testCase,
  splist0,
  splist1,
  maxSep = 0.001*arcseconds,
  msg = None 
)
Assert that two lists of `~lsst.afw.geom.SpherePoint`\ s are almost equal

Parameters
----------
testCase : `unittest.TestCase`
    test case the test is part of; an object supporting one method: fail(self, msgStr)
splist0 : `list` of `lsst.afw.geom.SpherePoint`
    list of SpherePoints 0
splist1 : `list` of `lsst.afw.geom.SpherePoint`
    list of SpherePoints 1
maxSep : `lsst.afw.geom.Angle`
    maximum separation
msg : `str`
    exception message prefix; details of the error are appended after ": "

Definition at line 192 of file testUtils.py.

◆ assertSpherePointsAlmostEqual()

def lsst.geom.testUtils.assertSpherePointsAlmostEqual (   testCase,
  sp0,
  sp1,
  maxSep = 0.001*arcseconds,
  msg = "" 
)
Assert that two `~lsst.afw.geom.SpherePoint`\ s are almost equal

Parameters
----------
testCase : `unittest.TestCase`
    test case the test is part of; an object supporting one method: fail(self, msgStr)
sp0 : `lsst.afw.geom.SpherePoint`
    SpherePoint 0
sp1 : `lsst.afw.geom.SpherePoint`
    SpherePoint 1
maxSep : `lsst.afw.geom.Angle`
    maximum separation
msg : `str`
    extra information to be printed with any error message

Definition at line 170 of file testUtils.py.

◆ extraMsg()

def lsst.geom.testUtils.extraMsg (   msg)
Format extra error message, if any

Definition at line 36 of file testUtils.py.