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
_photoCalib.cc
Go to the documentation of this file.
1 /*
2  * This file is part of afw.
3  *
4  * Developed for the LSST Data Management System.
5  * This product includes software developed by the LSST Project
6  * (https://www.lsst.org).
7  * See the COPYRIGHT file at the top-level directory of this distribution
8  * for details of code ownership.
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program. If not, see <https://www.gnu.org/licenses/>.
22  */
23 
24 #include "pybind11/pybind11.h"
25 #include "pybind11/stl.h"
26 #include "lsst/utils/python.h"
27 
28 #include <memory>
29 
30 #include "ndarray/pybind11.h"
31 
32 #include "lsst/utils/python.h"
33 
37 #include "lsst/afw/table/io/python.h" // for addPersistableMethods
40 
41 namespace py = pybind11;
42 using namespace pybind11::literals;
43 
44 namespace lsst {
45 namespace afw {
46 namespace image {
47 namespace {
48 
49 void declareMeasurement(lsst::utils::python::WrapperCollection &wrappers) {
50  wrappers.wrapType(py::class_<Measurement, std::shared_ptr<Measurement>>(wrappers.module, "Measurement"),
51  [](auto &mod, auto &cls) {
52  cls.def(py::init<double, double>(), "value"_a, "error"_a);
53  cls.def_readonly("value", &Measurement::value);
54  cls.def_readonly("error", &Measurement::error);
55 
56  utils::python::addOutputOp(cls, "__str__");
57  cls.def("__repr__", [](Measurement const &self) {
58  std::ostringstream os;
59  os << "Measurement(" << self << ")";
60  return os.str();
61  });
62  });
63 }
64 
65 void declarePhotoCalib(lsst::utils::python::WrapperCollection &wrappers) {
66  wrappers.wrapType(
67  py::class_<PhotoCalib, std::shared_ptr<PhotoCalib>, typehandling::Storable>(wrappers.module,
68  "PhotoCalib"),
69  [](auto &mod, auto &cls) {
70  /* Constructors */
71  cls.def(py::init<>());
72  cls.def(py::init<double, double, lsst::geom::Box2I>(), "calibrationMean"_a,
73  "calibrationErr"_a = 0.0, "bbox"_a = lsst::geom::Box2I());
74  cls.def(py::init<std::shared_ptr<afw::math::BoundedField>, double>(), "calibration"_a,
75  "calibrationErr"_a = 0.0);
76  cls.def(py::init<double, double, std::shared_ptr<afw::math::BoundedField>, bool>(),
77  "calibrationMean"_a, "calibrationErr"_a, "calibration"_a, "isConstant"_a);
78 
79  table::io::python::addPersistableMethods<PhotoCalib>(cls);
80 
81  /* Members - nanojansky */
82  cls.def("instFluxToNanojansky",
83  (double (PhotoCalib::*)(double, lsst::geom::Point<double, 2> const &) const) &
84  PhotoCalib::instFluxToNanojansky,
85  "instFlux"_a, "point"_a);
86  cls.def("instFluxToNanojansky",
87  (double (PhotoCalib::*)(double) const) & PhotoCalib::instFluxToNanojansky,
88  "instFlux"_a);
89 
90  cls.def("instFluxToNanojansky",
91  (Measurement(PhotoCalib::*)(double, double, lsst::geom::Point<double, 2> const &)
92  const) &
93  PhotoCalib::instFluxToNanojansky,
94  "instFlux"_a, "instFluxErr"_a, "point"_a);
95  cls.def("instFluxToNanojansky",
96  (Measurement(PhotoCalib::*)(double, double) const) & PhotoCalib::instFluxToNanojansky,
97  "instFlux"_a, "instFluxErr"_a);
98 
99  cls.def("instFluxToNanojansky",
100  (Measurement(PhotoCalib::*)(afw::table::SourceRecord const &, std::string const &)
101  const) &
102  PhotoCalib::instFluxToNanojansky,
103  "sourceRecord"_a, "instFluxField"_a);
104 
105  cls.def("instFluxToNanojansky",
106  (ndarray::Array<double, 2, 2>(PhotoCalib::*)(afw::table::SourceCatalog const &,
107  std::string const &) const) &
108  PhotoCalib::instFluxToNanojansky,
109  "sourceCatalog"_a, "instFluxField"_a);
110 
111  cls.def("instFluxToNanojansky",
112  (void (PhotoCalib::*)(afw::table::SourceCatalog &, std::string const &,
113  std::string const &) const) &
114  PhotoCalib::instFluxToNanojansky,
115  "sourceCatalog"_a, "instFluxField"_a, "outField"_a);
116 
117  /* Members - magnitudes */
118  cls.def("instFluxToMagnitude",
119  (double (PhotoCalib::*)(double, lsst::geom::Point<double, 2> const &) const) &
120  PhotoCalib::instFluxToMagnitude,
121  "instFlux"_a, "point"_a);
122  cls.def("instFluxToMagnitude",
123  (double (PhotoCalib::*)(double) const) & PhotoCalib::instFluxToMagnitude,
124  "instFlux"_a);
125 
126  cls.def("instFluxToMagnitude",
127  (Measurement(PhotoCalib::*)(double, double, lsst::geom::Point<double, 2> const &)
128  const) &
129  PhotoCalib::instFluxToMagnitude,
130  "instFlux"_a, "instFluxErr"_a, "point"_a);
131  cls.def("instFluxToMagnitude",
132  (Measurement(PhotoCalib::*)(double, double) const) & PhotoCalib::instFluxToMagnitude,
133  "instFlux"_a, "instFluxErr"_a);
134 
135  cls.def("instFluxToMagnitude",
136  (Measurement(PhotoCalib::*)(afw::table::SourceRecord const &, std::string const &)
137  const) &
138  PhotoCalib::instFluxToMagnitude,
139  "sourceRecord"_a, "instFluxField"_a);
140 
141  cls.def("instFluxToMagnitude",
142  (ndarray::Array<double, 2, 2>(PhotoCalib::*)(afw::table::SourceCatalog const &,
143  std::string const &) const) &
144  PhotoCalib::instFluxToMagnitude,
145  "sourceCatalog"_a, "instFluxField"_a);
146 
147  cls.def("instFluxToMagnitude",
148  (void (PhotoCalib::*)(afw::table::SourceCatalog &, std::string const &,
149  std::string const &) const) &
150  PhotoCalib::instFluxToMagnitude,
151  "sourceCatalog"_a, "instFluxField"_a, "outField"_a);
152 
153  /* from magnitude. */
154  cls.def("magnitudeToInstFlux",
155  py::overload_cast<double, lsst::geom::Point<double, 2> const &>(
156  &PhotoCalib::magnitudeToInstFlux, py::const_),
157  "instFlux"_a, "point"_a);
158  cls.def("magnitudeToInstFlux",
159  py::overload_cast<double>(&PhotoCalib::magnitudeToInstFlux, py::const_),
160  "instFlux"_a);
161 
162  /* utilities */
163  cls.def("getCalibrationMean", &PhotoCalib::getCalibrationMean);
164  cls.def("getCalibrationErr", &PhotoCalib::getCalibrationErr);
165  cls.def("getInstFluxAtZeroMagnitude", &PhotoCalib::getInstFluxAtZeroMagnitude);
166  cls.def("getLocalCalibration", &PhotoCalib::getLocalCalibration, "point"_a);
167 
168  cls.def("computeScaledCalibration", &PhotoCalib::computeScaledCalibration);
169  cls.def("computeScalingTo", &PhotoCalib::computeScalingTo);
170 
171  cls.def("calibrateImage", &PhotoCalib::calibrateImage, "maskedImage"_a,
172  "includeScaleUncertainty"_a = true);
173 
174  cls.def("calibrateCatalog",
175  py::overload_cast<afw::table::SourceCatalog const &,
176  std::vector<std::string> const &>(&PhotoCalib::calibrateCatalog,
177  py::const_),
178  "maskedImage"_a, "fluxFields"_a);
179  cls.def("calibrateCatalog",
180  py::overload_cast<afw::table::SourceCatalog const &>(&PhotoCalib::calibrateCatalog,
181  py::const_),
182  "maskedImage"_a);
183 
184  /* Operators */
185  cls.def("__eq__", &PhotoCalib::operator==, py::is_operator());
186  cls.def("__ne__", &PhotoCalib::operator!=, py::is_operator());
187  utils::python::addOutputOp(cls, "__str__");
188  cls.def("__repr__", [](PhotoCalib const &self) {
189  std::ostringstream os;
190  os << "PhotoCalib(" << self << ")";
191  return os.str();
192  });
193  });
194 }
195 
196 void declareCalib(lsst::utils::python::WrapperCollection &wrappers) {
197  wrappers.wrap([](auto &mod) {
198  /* Utility functions */
199  mod.def("makePhotoCalibFromMetadata",
200  py::overload_cast<daf::base::PropertySet &, bool>(makePhotoCalibFromMetadata), "metadata"_a,
201  "strip"_a = false);
202  mod.def("makePhotoCalibFromCalibZeroPoint",
203  py::overload_cast<double, double>(makePhotoCalibFromCalibZeroPoint), "instFluxMag0"_a,
204  "instFluxMag0Err"_a = false);
205  });
206 }
207 } // namespace
208 void wrapPhotoCalib(lsst::utils::python::WrapperCollection &wrappers) {
209  wrappers.addInheritanceDependency("lsst.afw.typehandling");
210  declareMeasurement(wrappers);
211  declarePhotoCalib(wrappers);
212  declareCalib(wrappers);
213 }
214 } // namespace image
215 } // namespace afw
216 } // namespace lsst
Implementation of the Photometric Calibration class.
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
std::shared_ptr< PhotoCalib > makePhotoCalibFromCalibZeroPoint(double instFluxMag0, double instFluxMag0Err)
Construct a PhotoCalib from the deprecated Calib-style instFluxMag0/instFluxMag0Err values.
Definition: PhotoCalib.cc:613
std::shared_ptr< PhotoCalib > makePhotoCalibFromMetadata(daf::base::PropertySet &metadata, bool strip=false)
Construct a PhotoCalib from FITS FLUXMAG0/FLUXMAG0ERR keywords.
Definition: PhotoCalib.cc:595
void wrapPhotoCalib(lsst::utils::python::WrapperCollection &)
Definition: _photoCalib.cc:208
A base class for image defects.