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
_exposureContinued.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 
22 __all__ = ["Exposure"]
23 
24 from lsst.utils.deprecated import deprecate_pybind11
25 import numpy as np
26 
27 from lsst.utils import TemplateMeta
28 
29 from ..image._slicing import supportSlicing
30 from ..image._disableArithmetic import disableImageArithmetic
31 from ..image._fitsIoWithOptions import imageReadFitsWithOptions, exposureWriteFitsWithOptions
32 from ._exposure import ExposureI, ExposureF, ExposureD, ExposureU, ExposureL
33 
34 
35 class Exposure(metaclass=TemplateMeta):
36 
37  def _set(self, index, value, origin):
38  """Set the pixel at the given index to a triple (value, mask, variance).
39 
40  Parameters
41  ----------
42  index : `geom.Point2I`
43  Position of the pixel to assign to.
44  value : `tuple`
45  A tuple of (value, mask, variance) scalars.
46  origin : `ImageOrigin`
47  Coordinate system of ``index`` (`PARENT` or `LOCAL`).
48  """
49  self.maskedImage._set(index, value=value, origin=origin)
50 
51  def _get(self, index, origin):
52  """Return a triple (value, mask, variance) at the given index.
53 
54  Parameters
55  ----------
56  index : `geom.Point2I`
57  Position of the pixel to assign to.
58  origin : `ImageOrigin`
59  Coordinate system of ``index`` (`PARENT` or `LOCAL`).
60  """
61  return self.maskedImage._get(index, origin=origin)
62 
63  def __reduce__(self):
64  from lsst.afw.fits import reduceToFits
65  return reduceToFits(self)
66 
67  def convertF(self):
68  return ExposureF(self, deep=True)
69 
70  def convertD(self):
71  return ExposureD(self, deep=True)
72 
73  def getImage(self):
74  return self.maskedImage.image
75 
76  def setImage(self, image):
77  self.maskedImage.image = image
78 
79  image = property(getImage, setImage)
80 
81  def getMask(self):
82  return self.maskedImage.mask
83 
84  def setMask(self, mask):
85  self.maskedImage.mask = mask
86 
87  mask = property(getMask, setMask)
88 
89  def getVariance(self):
90  return self.maskedImage.variance
91 
92  def setVariance(self, variance):
93  self.maskedImage.variance = variance
94 
95  variance = property(getVariance, setVariance)
96 
97  readFitsWithOptions = classmethod(imageReadFitsWithOptions)
98 
99  writeFitsWithOptions = exposureWriteFitsWithOptions
100 
101 
102 Exposure.register(np.int32, ExposureI)
103 Exposure.register(np.float32, ExposureF)
104 Exposure.register(np.float64, ExposureD)
105 Exposure.register(np.uint16, ExposureU)
106 Exposure.register(np.uint64, ExposureL)
107 Exposure.alias("I", ExposureI)
108 Exposure.alias("F", ExposureF)
109 Exposure.alias("D", ExposureD)
110 Exposure.alias("U", ExposureU)
111 Exposure.alias("L", ExposureL)
112 
113 for cls in set(Exposure.values()):
114  supportSlicing(cls)
116 
117  cls.getFilter = deprecate_pybind11(
118  cls.getFilter,
119  reason="Replaced by getFilterLabel. Will be removed after v22.",
120  version="v22.0")
121 
122  cls.setFilter = deprecate_pybind11(
123  cls.setFilter,
124  reason="Replaced by setFilterLabel. Will be removed after v22.",
125  version="v22.0")
daf::base::PropertySet * set
Definition: fits.cc:912
afw::image::Exposure< float > ExposureF
Definition: VeresModel.cc:36