LSST Applications g02d81e74bb+86cf3d8bc9,g180d380827+7a4e862ed4,g2079a07aa2+86d27d4dc4,g2305ad1205+e1ca1c66fa,g29320951ab+012e1474a1,g295015adf3+341ea1ce94,g2bbee38e9b+0e5473021a,g337abbeb29+0e5473021a,g33d1c0ed96+0e5473021a,g3a166c0a6a+0e5473021a,g3ddfee87b4+c429d67c83,g48712c4677+f88676dd22,g487adcacf7+27e1e21933,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+b41db86c35,g5a732f18d5+53520f316c,g64a986408d+86cf3d8bc9,g858d7b2824+86cf3d8bc9,g8a8a8dda67+585e252eca,g99cad8db69+84912a7fdc,g9ddcbc5298+9a081db1e4,ga1e77700b3+15fc3df1f7,ga8c6da7877+a2b54eae19,gb0e22166c9+60f28cb32d,gba4ed39666+c2a2e4ac27,gbb8dafda3b+6681f309db,gc120e1dc64+f0fcc2f6d8,gc28159a63d+0e5473021a,gcf0d15dbbd+c429d67c83,gdaeeff99f8+f9a426f77a,ge6526c86ff+0433e6603d,ge79ae78c31+0e5473021a,gee10cc3b42+585e252eca,gff1a9f87cc+86cf3d8bc9,w.2024.17
LSST Data Management Base Package
|
Functions | |
makeGaussianNoiseMaskedImage (dimensions, sigma, variance=1.0) | |
makeRampImage (bbox, start=0, stop=None, imageClass=ImageF) | |
Make an image whose values are a linear ramp. | |
assertImagesAlmostEqual (testCase, image0, image1, skipMask=None, rtol=1.0e-05, atol=1e-08, msg="Images differ") | |
Assert that two images are almost equal, including non-finite values. | |
assertImagesEqual (*args, **kwds) | |
Assert that two images are exactly equal, including non-finite values. | |
assertMasksEqual (testCase, mask0, mask1, skipMask=None, msg="Masks differ") | |
Assert that two masks are equal. | |
assertMaskedImagesAlmostEqual (testCase, maskedImage0, maskedImage1, doImage=True, doMask=True, doVariance=True, skipMask=None, rtol=1.0e-05, atol=1e-08, msg="Masked images differ") | |
Assert that two masked images are nearly equal, including non-finite values. | |
assertMaskedImagesEqual (*args, **kwds) | |
Assert that two masked images are exactly equal, including non-finite values. | |
imagesDiffer (image0, image1, skipMask=None, rtol=1.0e-05, atol=1e-08) | |
Compare the pixels of two image or mask arrays; return True if close, False otherwise. | |
lsst.afw.image.testUtils.assertImagesAlmostEqual | ( | testCase, | |
image0, | |||
image1, | |||
skipMask = None, | |||
rtol = 1.0e-05, | |||
atol = 1e-08, | |||
msg = "Images differ" ) |
Assert that two images are almost equal, including non-finite values.
[in] | testCase | unittest.TestCase instance the test is part of; an object supporting one method: fail(self, msgStr) |
[in] | image0 | image 0, an lsst.afw.image.Image, lsst.afw.image.Mask, or transposed numpy array (see warning) |
[in] | image1 | image 1, an lsst.afw.image.Image, lsst.afw.image.Mask, or transposed numpy array (see warning) |
[in] | skipMask | mask of pixels to skip, or None to compare all pixels; an lsst.afw.image.Mask, lsst.afw.image.Image, or transposed numpy array (see warning); all non-zero pixels are skipped |
[in] | rtol | maximum allowed relative tolerance; more info below |
[in] | atol | maximum allowed absolute tolerance; more info below |
[in] | msg | exception message prefix; details of the error are appended after ": " |
The images are nearly equal if all pixels obey: |val1 - val0| <= rtol*|val1| + atol or, for float types, if nan/inf/-inf pixels match.
self.failureException | (usually AssertionError) if any of the following are true for un-skipped pixels:
|
TypeError | if the dimensions of image0, image1 and skipMask do not match, or any are not of a numeric data type. |
Definition at line 74 of file testUtils.py.
lsst.afw.image.testUtils.assertImagesEqual | ( | * | args, |
** | kwds ) |
Assert that two images are exactly equal, including non-finite values.
All arguments are forwarded to assertAnglesAlmostEqual aside from atol and rtol, which are set to zero.
Definition at line 117 of file testUtils.py.
lsst.afw.image.testUtils.assertMaskedImagesAlmostEqual | ( | testCase, | |
maskedImage0, | |||
maskedImage1, | |||
doImage = True, | |||
doMask = True, | |||
doVariance = True, | |||
skipMask = None, | |||
rtol = 1.0e-05, | |||
atol = 1e-08, | |||
msg = "Masked images differ" ) |
Assert that two masked images are nearly equal, including non-finite values.
[in] | testCase | unittest.TestCase instance the test is part of; an object supporting one method: fail(self, msgStr) |
[in] | maskedImage0 | masked image 0 (an lsst.afw.image.MaskedImage or collection of three transposed numpy arrays: image, mask, variance) |
[in] | maskedImage1 | masked image 1 (an lsst.afw.image.MaskedImage or collection of three transposed numpy arrays: image, mask, variance) |
[in] | doImage | compare image planes if True |
[in] | doMask | compare mask planes if True |
[in] | doVariance | compare variance planes if True |
[in] | skipMask | mask of pixels to skip, or None to compare all pixels; an lsst.afw.image.Mask, lsst.afw.image.Image, or transposed numpy array; all non-zero pixels are skipped |
[in] | rtol | maximum allowed relative tolerance; more info below |
[in] | atol | maximum allowed absolute tolerance; more info below |
[in] | msg | exception message prefix; details of the error are appended after ": " |
The mask planes must match exactly. The image and variance planes are nearly equal if all pixels obey: |val1 - val0| <= rtol*|val1| + atol or, for float types, if nan/inf/-inf pixels match.
self.failureException | (usually AssertionError) if any of the following are true for un-skipped pixels:
|
TypeError | if the dimensions of maskedImage0, maskedImage1 and skipMask do not match, either image or variance plane is not of a numeric data type, either mask plane is not of an integer type (unsigned or signed), or skipMask is not of a numeric data type. |
Definition at line 156 of file testUtils.py.
lsst.afw.image.testUtils.assertMaskedImagesEqual | ( | * | args, |
** | kwds ) |
Assert that two masked images are exactly equal, including non-finite values.
All arguments are forwarded to assertMaskedImagesAlmostEqual aside from atol and rtol, which are set to zero.
Definition at line 254 of file testUtils.py.
lsst.afw.image.testUtils.assertMasksEqual | ( | testCase, | |
mask0, | |||
mask1, | |||
skipMask = None, | |||
msg = "Masks differ" ) |
Assert that two masks are equal.
[in] | testCase | unittest.TestCase instance the test is part of; an object supporting one method: fail(self, msgStr) |
[in] | mask0 | mask 0, an lsst.afw.image.Mask, lsst.afw.image.Image, or transposed numpy array (see warning) |
[in] | mask1 | mask 1, an lsst.afw.image.Mask, lsst.afw.image.Image, or transposed numpy array (see warning) |
[in] | skipMask | mask of pixels to skip, or None to compare all pixels; an lsst.afw.image.Mask, lsst.afw.image.Image, or transposed numpy array (see warning); all non-zero pixels are skipped |
[in] | msg | exception message prefix; details of the error are appended after ": " |
self.failureException | (usually AssertionError) if any any un-skipped pixels differ |
TypeError | if the dimensions of mask0, mask1 and skipMask do not match, or any are not of a numeric data type. |
Definition at line 127 of file testUtils.py.
lsst.afw.image.testUtils.imagesDiffer | ( | image0, | |
image1, | |||
skipMask = None, | |||
rtol = 1.0e-05, | |||
atol = 1e-08 ) |
Compare the pixels of two image or mask arrays; return True if close, False otherwise.
[in] | image0 | image 0, an lsst.afw.image.Image, lsst.afw.image.Mask, or transposed numpy array (see warning) |
[in] | image1 | image 1, an lsst.afw.image.Image, lsst.afw.image.Mask, or transposed numpy array (see warning) |
[in] | skipMask | mask of pixels to skip, or None to compare all pixels; an lsst.afw.image.Mask, lsst.afw.image.Image, or transposed numpy array (see warning); all non-zero pixels are skipped |
[in] | rtol | maximum allowed relative tolerance; more info below |
[in] | atol | maximum allowed absolute tolerance; more info below |
The images are nearly equal if all pixels obey: |val1 - val0| <= rtol*|val1| + atol or, for float types, if nan/inf/-inf pixels match.
TypeError | if the dimensions of image0, image1 and skipMask do not match, or any are not of a numeric data type. |
Definition at line 263 of file testUtils.py.
lsst.afw.image.testUtils.makeGaussianNoiseMaskedImage | ( | dimensions, | |
sigma, | |||
variance = 1.0 ) |
Make a gaussian noise MaskedImageF Inputs: - dimensions: dimensions of output array (cols, rows) - sigma; sigma of image plane's noise distribution - variance: constant value for variance plane
Definition at line 34 of file testUtils.py.
lsst.afw.image.testUtils.makeRampImage | ( | bbox, | |
start = 0, | |||
stop = None, | |||
imageClass = ImageF ) |
Make an image whose values are a linear ramp.
[in] | bbox | bounding box of image (an lsst.geom.Box2I) |
[in] | start | starting ramp value, inclusive |
[in] | stop | ending ramp value, inclusive; if None, increase by integer values |
[in] | imageClass | type of image (e.g. lsst.afw.image.ImageF) |
Definition at line 51 of file testUtils.py.