Coverage for python/lsst/afw/image/maskedImage/maskedImageContinued.py : 54%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# This file is part of afw.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (https://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <https://www.gnu.org/licenses/>.
22__all__ = ["MaskedImage", "VariancePixel"]
24import numpy as np
26from lsst.utils import TemplateMeta
28from ..image.fitsIoWithOptions import imageReadFitsWithOptions, exposureWriteFitsWithOptions
29from ..slicing import supportSlicing
30from ..disableArithmetic import disableImageArithmetic
31from .maskedImage import MaskedImageI, MaskedImageF, MaskedImageD, MaskedImageU, MaskedImageL
34VariancePixel = np.float32
37class MaskedImage(metaclass=TemplateMeta):
39 def set(self, value, mask=None, variance=None):
40 """Assign a tuple of scalars to the entirety of all three planes.
41 """
42 if mask is None and variance is None:
43 try:
44 value, mask, variance = value
45 except TypeError:
46 pass
47 if mask is None:
48 mask = 0
49 if variance is None:
50 variance = 0.0
51 self.image.set(value)
52 self.mask.set(mask)
53 self.variance.set(variance)
55 def _set(self, index, value, origin):
56 """Set the pixel at the given index to a triple (value, mask, variance).
58 Parameters
59 ----------
60 index : `geom.Point2I`
61 Position of the pixel to assign to.
62 value : `tuple`
63 A tuple of (value, mask, variance) scalars.
64 origin : `ImageOrigin`
65 Coordinate system of ``index`` (`PARENT` or `LOCAL`).
66 """
67 self.image[index, origin] = value[0]
68 self.mask[index, origin] = value[1]
69 self.variance[index, origin] = value[2]
71 def _get(self, index, origin):
72 """Return a triple (value, mask, variance) at the given index.
74 Parameters
75 ----------
76 index : `geom.Point2I`
77 Position of the pixel to assign to.
78 origin : `ImageOrigin`
79 Coordinate system of ``index`` (`PARENT` or `LOCAL`).
80 """
81 return (self.image[index, origin],
82 self.mask[index, origin],
83 self.variance[index, origin])
85 def getArrays(self):
86 """Return a tuple (value, mask, variance) numpy arrays."""
87 return (self.image.array if self.image else None,
88 self.mask.array if self.mask else None,
89 self.variance.array if self.variance else None)
91 def convertF(self):
92 return MaskedImageF(self, True)
94 def convertD(self):
95 return MaskedImageD(self, True)
97 def __reduce__(self):
98 from lsst.afw.fits import reduceToFits
99 return reduceToFits(self)
101 def __str__(self):
102 string = "image={},\nmask={}, maskPlaneDict={}\nvariance={}, bbox={}"
103 return string.format(self.image.array,
104 self.mask.array,
105 self.mask.getMaskPlaneDict(),
106 self.variance.array,
107 self.getBBox())
109 def __repr__(self):
110 return "{}.{}=({})".format(self.__module__, self.__class__.__name__, str(self))
112 readFitsWithOptions = classmethod(imageReadFitsWithOptions)
114 writeFitsWithOptions = exposureWriteFitsWithOptions
117MaskedImage.register(np.int32, MaskedImageI)
118MaskedImage.register(np.float32, MaskedImageF)
119MaskedImage.register(np.float64, MaskedImageD)
120MaskedImage.register(np.uint16, MaskedImageU)
121MaskedImage.register(np.uint64, MaskedImageL)
122MaskedImage.alias("I", MaskedImageI)
123MaskedImage.alias("F", MaskedImageF)
124MaskedImage.alias("D", MaskedImageD)
125MaskedImage.alias("U", MaskedImageU)
126MaskedImage.alias("L", MaskedImageL)
128for cls in set(MaskedImage.values()):
129 supportSlicing(cls)
130 disableImageArithmetic(cls)