LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
_maskedImageContinued.py
Go to the documentation of this file.
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/>.
21 import numpy as np
22 
23 from lsst.utils import TemplateMeta
24 from ._maskedImage import MaskedImageI, MaskedImageF, MaskedImageD, MaskedImageU, MaskedImageL
25 
26 from ..image._fitsIoWithOptions import imageReadFitsWithOptions, exposureWriteFitsWithOptions
27 from ..image._slicing import supportSlicing
28 from ..image._disableArithmetic import disableImageArithmetic
29 
30 __all__ = ["MaskedImage", "VariancePixel"]
31 
32 
33 VariancePixel = np.float32
34 
35 
36 class MaskedImage(metaclass=TemplateMeta):
37 
38  def set(self, value, mask=None, variance=None):
39  """Assign a tuple of scalars to the entirety of all three planes.
40  """
41  if mask is None and variance is None:
42  try:
43  value, mask, variance = value
44  except TypeError:
45  pass
46  if mask is None:
47  mask = 0
48  if variance is None:
49  variance = 0.0
50  self.image.set(value)
51  self.mask.set(mask)
52  self.variance.set(variance)
53 
54  def _set(self, index, value, origin):
55  """Set the pixel at the given index to a triple (value, mask, variance).
56 
57  Parameters
58  ----------
59  index : `geom.Point2I`
60  Position of the pixel to assign to.
61  value : `tuple`
62  A tuple of (value, mask, variance) scalars.
63  origin : `ImageOrigin`
64  Coordinate system of ``index`` (`PARENT` or `LOCAL`).
65  """
66  self.image[index, origin] = value[0]
67  self.mask[index, origin] = value[1]
68  self.variance[index, origin] = value[2]
69 
70  def _get(self, index, origin):
71  """Return a triple (value, mask, variance) at the given index.
72 
73  Parameters
74  ----------
75  index : `geom.Point2I`
76  Position of the pixel to assign to.
77  origin : `ImageOrigin`
78  Coordinate system of ``index`` (`PARENT` or `LOCAL`).
79  """
80  return (self.image[index, origin],
81  self.mask[index, origin],
82  self.variance[index, origin])
83 
84  def getArrays(self):
85  """Return a tuple (value, mask, variance) numpy arrays."""
86  return (self.image.array if self.image else None,
87  self.mask.array if self.mask else None,
88  self.variance.array if self.variance else None)
89 
90  def convertF(self):
91  return MaskedImageF(self, True)
92 
93  def convertD(self):
94  return MaskedImageD(self, True)
95 
96  def __reduce__(self):
97  from lsst.afw.fits import reduceToFits
98  return reduceToFits(self)
99 
100  def __str__(self):
101  string = "image={},\nmask={}, maskPlaneDict={}\nvariance={}, bbox={}"
102  return string.format(self.image.array,
103  self.mask.array,
104  self.mask.getMaskPlaneDict(),
105  self.variance.array,
106  self.getBBox())
107 
108  def __repr__(self):
109  return "{}.{}=({})".format(self.__module__, self.__class__.__name__, str(self))
110 
111  readFitsWithOptions = classmethod(imageReadFitsWithOptions)
112 
113  writeFitsWithOptions = exposureWriteFitsWithOptions
114 
115 
116 MaskedImage.register(np.int32, MaskedImageI)
117 MaskedImage.register(np.float32, MaskedImageF)
118 MaskedImage.register(np.float64, MaskedImageD)
119 MaskedImage.register(np.uint16, MaskedImageU)
120 MaskedImage.register(np.uint64, MaskedImageL)
121 MaskedImage.alias("I", MaskedImageI)
122 MaskedImage.alias("F", MaskedImageF)
123 MaskedImage.alias("D", MaskedImageD)
124 MaskedImage.alias("U", MaskedImageU)
125 MaskedImage.alias("L", MaskedImageL)
126 
127 for cls in set(MaskedImage.values()):
128  supportSlicing(cls)
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174