LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
_exposure.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 "ndarray/pybind11.h"
26 
27 #include <memory>
28 
29 #include "lsst/utils/python.h"
30 
31 #include "lsst/afw/detection/Psf.h" // forward-declared by Exposure.h
32 #include "lsst/afw/fits.h"
33 #include "lsst/geom/Box.h"
34 #include "lsst/geom/Point.h"
35 #include "lsst/afw/geom/polygon/Polygon.h" // forward-declared by Exposure.h
36 #include "lsst/afw/geom/SkyWcs.h" // forward-declared by Transform.h
37 #include "lsst/afw/image/ApCorrMap.h" // forward-declared by Exposure.h
38 #include "lsst/afw/image/PhotoCalib.h" // forward-declared by Exposure.h
39 #include "lsst/afw/image/VisitInfo.h" // forward-declared by Exposure.h
40 #include "lsst/afw/image/TransmissionCurve.h" // forward-declared by Exposure.h
41 #include "lsst/afw/cameraGeom/Detector.h" // forward-declared by Exposure.h
44 #include "lsst/afw/table/Catalog.h"
49 
50 namespace py = pybind11;
51 using namespace pybind11::literals;
52 
53 namespace lsst {
54 namespace afw {
55 namespace table {
56 
57 using utils::python::WrapperCollection;
58 
59 namespace {
60 
61 using PyExposureRecord = py::class_<ExposureRecord, std::shared_ptr<ExposureRecord>, BaseRecord>;
62 using PyExposureTable = py::class_<ExposureTable, std::shared_ptr<ExposureTable>, BaseTable>;
63 using PyExposureCatalog =
64  py::class_<ExposureCatalogT<ExposureRecord>, std::shared_ptr<ExposureCatalogT<ExposureRecord>>,
65  SortedCatalogT<ExposureRecord>>;
66 
67 PyExposureRecord declareExposureRecord(WrapperCollection &wrappers) {
68  return wrappers.wrapType(PyExposureRecord(wrappers.module, "ExposureRecord"), [](auto &mod, auto &cls) {
69  cls.def("getId", &ExposureRecord::getId);
70  cls.def("setId", &ExposureRecord::setId, "id"_a);
71  cls.def("getBBox", &ExposureRecord::getBBox);
72  cls.def("setBBox", &ExposureRecord::setBBox, "bbox"_a);
73  cls.def("getTable", &ExposureRecord::getTable);
74  cls.def_property_readonly("table", &ExposureRecord::getTable);
75  cls.def("contains",
76  (bool (ExposureRecord::*)(lsst::geom::SpherePoint const &, bool) const) &
77  ExposureRecord::contains,
78  "coord"_a, "includeValidPolygon"_a = false);
79  cls.def("contains",
80  (bool (ExposureRecord::*)(lsst::geom::Point2D const &, geom::SkyWcs const &, bool) const) &
81  ExposureRecord::contains,
82  "point"_a, "wcs"_a, "includeValidPolygon"_a = false);
83  cls.def("getWcs", &ExposureRecord::getWcs);
84  cls.def("setWcs", &ExposureRecord::setWcs, "wcs"_a);
85  cls.def("getPsf", &ExposureRecord::getPsf);
86  cls.def("setPsf", &ExposureRecord::setPsf, "psf"_a);
87 
88  cls.def("getPhotoCalib", &ExposureRecord::getPhotoCalib);
89  cls.def("setPhotoCalib", &ExposureRecord::setPhotoCalib, "photoCalib"_a);
90  cls.def("getApCorrMap", &ExposureRecord::getApCorrMap);
91  cls.def("setApCorrMap", &ExposureRecord::setApCorrMap, "apCorrMap"_a);
92  cls.def("getValidPolygon", &ExposureRecord::getValidPolygon);
93 
94  // Workaround for DM-10289.
95  cls.def("setValidPolygon",
96  [](ExposureRecord &self, py::object polygon) {
97  if (polygon.is(py::none())) {
98  self.setValidPolygon(nullptr);
99  } else {
100  self.setValidPolygon(py::cast<std::shared_ptr<afw::geom::polygon::Polygon>>(polygon));
101  }
102  },
103  "polygon"_a);
104 
105  cls.def("getVisitInfo", &ExposureRecord::getVisitInfo);
106  cls.def("setVisitInfo", &ExposureRecord::setVisitInfo, "visitInfo"_a);
107  cls.def("getTransmissionCurve", &ExposureRecord::getTransmissionCurve);
108  cls.def("setTransmissionCurve", &ExposureRecord::setTransmissionCurve, "transmissionCurve"_a);
109  cls.def("getDetector", &ExposureRecord::getDetector);
110  cls.def("setDetector", &ExposureRecord::setDetector, "detector"_a);
111  });
112 }
113 
114 PyExposureTable declareExposureTable(WrapperCollection &wrappers) {
115  return wrappers.wrapType(PyExposureTable(wrappers.module, "ExposureTable"), [](auto &mod, auto &cls) {
116  cls.def_static("make", &ExposureTable::make);
117  cls.def_static("makeMinimalSchema", &ExposureTable::makeMinimalSchema);
118  cls.def_static("checkSchema", &ExposureTable::checkSchema, "schema"_a);
119 
120  cls.def_static("getIdKey", &ExposureTable::getIdKey);
121  cls.def_static("getBBoxMinKey", &ExposureTable::getBBoxMinKey);
122  cls.def_static("getBBoxMaxKey", &ExposureTable::getBBoxMaxKey);
123 
124  cls.def("clone", &ExposureTable::clone);
125  cls.def("makeRecord", &ExposureTable::makeRecord);
126  cls.def("copyRecord", (std::shared_ptr<ExposureRecord>(ExposureTable::*)(BaseRecord const &)) &
127  ExposureTable::copyRecord);
128  cls.def("copyRecord", (std::shared_ptr<ExposureRecord>(ExposureTable::*)(BaseRecord const &,
129  SchemaMapper const &)) &
130  ExposureTable::copyRecord);
131  });
132 }
133 
134 PyExposureCatalog declareExposureCatalog(WrapperCollection &wrappers) {
135  using Catalog = ExposureCatalogT<ExposureRecord>;
136  table::python::declareSortedCatalog<ExposureRecord>(wrappers, "Exposure", true);
137 
138  // We need py::dynamic_attr() in class definition to support our Python-side caching
139  // of the associated ColumnView.
140  return wrappers.wrapType(
141  PyExposureCatalog(wrappers.module, "ExposureCatalog", py::dynamic_attr()),
142  [](auto &mod, auto &cls) {
143  cls.def(py::init<Schema const &>(), "schema"_a);
144  cls.def(py::init<std::shared_ptr<ExposureTable> const &>(),
145  "table"_a = std::shared_ptr<ExposureTable>());
146  cls.def(py::init<Catalog const &>(), "other"_a);
147  // Constructor taking C++ iterators not wrapped; we recommend .extend() (defined in pure
148  // Python) instead.
149  cls.def_static("readFits", (Catalog(*)(std::string const &, int, int)) & Catalog::readFits,
150  "filename"_a, "hdu"_a = fits::DEFAULT_HDU, "flags"_a = 0);
151  cls.def_static("readFits", (Catalog(*)(fits::MemFileManager &, int, int)) & Catalog::readFits,
152  "manager"_a, "hdu"_a = fits::DEFAULT_HDU, "flags"_a = 0);
153  // readFits taking Fits objects not wrapped, because Fits objects are not wrapped.
154 
155  cls.def("subset",
156  (Catalog(Catalog::*)(ndarray::Array<bool const, 1> const &) const) & Catalog::subset,
157  "mask"_a);
158  cls.def("subset",
159  (Catalog(Catalog::*)(std::ptrdiff_t, std::ptrdiff_t, std::ptrdiff_t) const) &
160  Catalog::subset,
161  "startd"_a, "stopd"_a, "step"_a);
162  cls.def("subsetContaining",
163  (Catalog(Catalog::*)(lsst::geom::SpherePoint const &, bool) const) &
164  Catalog::subsetContaining,
165  "coord"_a, "includeValidPolygon"_a = false);
166  cls.def("subsetContaining",
167  (Catalog(Catalog::*)(lsst::geom::Point2D const &, geom::SkyWcs const &, bool) const) &
168  Catalog::subsetContaining,
169  "point"_a, "wcs"_a, "includeValidPolygon"_a = false);
170  });
171 };
172 
173 } // anonymous namespace
174 
175 void wrapExposure(WrapperCollection &wrappers) {
176  // wrappers.addSignatureDependency("lsst.afw.geom");
177  // TODO: afw.geom, afw.image, and afw.detection cannot be imported due to
178  // circular dependencies until at least afw.image uses WrapperCollection
179  // in DM-20703
180 
181  auto clsExposureRecord = declareExposureRecord(wrappers);
182  auto clsExposureTable = declareExposureTable(wrappers);
183  auto clsExposureColumnView = table::python::declareColumnView<ExposureRecord>(wrappers, "Exposure");
184  auto clsExposureCatalog = declareExposureCatalog(wrappers);
185 
186  clsExposureRecord.attr("Table") = clsExposureTable;
187  clsExposureRecord.attr("ColumnView") = clsExposureColumnView;
188  clsExposureRecord.attr("Catalog") = clsExposureCatalog;
189  clsExposureTable.attr("Record") = clsExposureRecord;
190  clsExposureTable.attr("ColumnView") = clsExposureColumnView;
191  clsExposureTable.attr("Catalog") = clsExposureCatalog;
192  clsExposureCatalog.attr("Record") = clsExposureRecord;
193  clsExposureCatalog.attr("Table") = clsExposureTable;
194  clsExposureCatalog.attr("ColumnView") = clsExposureColumnView;
195 }
196 
197 } // namespace table
198 } // namespace afw
199 } // namespace lsst
Implementation of the Photometric Calibration class.
void wrapExposure(WrapperCollection &wrappers)
Definition: _exposure.cc:175
A base class for image defects.