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
_detector.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 <memory>
25 #include <string>
26 
27 #include "pybind11/pybind11.h"
28 #include <lsst/utils/python.h>
29 
30 #include "pybind11/stl.h"
31 
32 #include "ndarray/pybind11.h"
33 
34 #include "lsst/utils/python.h"
37 #include "lsst/geom.h"
42 
43 namespace py = pybind11;
44 using namespace py::literals;
45 
46 namespace lsst {
47 namespace afw {
48 namespace cameraGeom {
49 
50 namespace {
51 
52 using PyDetectorBase = py::class_<DetectorBase, std::shared_ptr<DetectorBase>>;
53 using PyDetector = py::class_<Detector, DetectorBase, std::shared_ptr<Detector>, typehandling::Storable>;
54 using PyDetectorBuilder = py::class_<Detector::Builder, DetectorBase, std::shared_ptr<Detector::Builder>>;
55 using PyDetectorPartialRebuilder = py::class_<Detector::PartialRebuilder, Detector::Builder,
57 using PyDetectorInCameraBuilder =
58  py::class_<Detector::InCameraBuilder, Detector::Builder, std::shared_ptr<Detector::InCameraBuilder>>;
59 
60 // Declare Detector methods overloaded on one coordinate system class
61 template <typename SysT, typename PyClass>
62 void declare1SysMethods(PyClass &cls) {
63  cls.def("getCorners",
64  (std::vector<lsst::geom::Point2D>(Detector::*)(SysT const &) const) & Detector::getCorners,
65  "cameraSys"_a);
66  cls.def("getCenter", (lsst::geom::Point2D(Detector::*)(SysT const &) const) & Detector::getCenter,
67  "cameraSys"_a);
68  cls.def("hasTransform", (bool (Detector::*)(SysT const &) const) & Detector::hasTransform, "cameraSys"_a);
69 }
70 
71 // Declare Detector methods templated on two coordinate system classes
72 template <typename FromSysT, typename ToSysT, typename PyClass>
73 void declare2SysMethods(PyClass &cls) {
74  cls.def("getTransform",
75  (std::shared_ptr<geom::TransformPoint2ToPoint2>(Detector::*)(FromSysT const &, ToSysT const &)
76  const) &
77  Detector::getTransform,
78  "fromSys"_a, "toSys"_a);
79  cls.def("transform",
80  (lsst::geom::Point2D(Detector::*)(lsst::geom::Point2D const &, FromSysT const &, ToSysT const &)
81  const) &
83  "point"_a, "fromSys"_a, "toSys"_a);
84  cls.def("transform",
86  FromSysT const &, ToSysT const &) const) &
88  "points"_a, "fromSys"_a, "toSys"_a);
89 }
90 
91 void declareDetectorBase(lsst::utils::python::WrapperCollection &wrappers) {
92  wrappers.wrapType(PyDetectorBase(wrappers.module, "DetectorBase"), [](auto &mod, auto &cls) {
93  cls.def("getName", &DetectorBase::getName);
94  cls.def("getId", &DetectorBase::getId);
95  cls.def("getType", &DetectorBase::getType);
96  cls.def("getPhysicalType", &DetectorBase::getPhysicalType);
97  cls.def("getSerial", &DetectorBase::getSerial);
98  cls.def("getBBox", &DetectorBase::getBBox);
99  cls.def("getOrientation", &DetectorBase::getOrientation);
100  cls.def("getPixelSize", &DetectorBase::getPixelSize);
101  cls.def("hasCrosstalk", &DetectorBase::hasCrosstalk);
102  cls.def("getCrosstalk", &DetectorBase::getCrosstalk);
103  cls.def("getNativeCoordSys", &DetectorBase::getNativeCoordSys);
104  cls.def("makeCameraSys",
105  py::overload_cast<CameraSys const &>(&DetectorBase::makeCameraSys, py::const_),
106  "cameraSys"_a);
107  cls.def("makeCameraSys",
108  py::overload_cast<CameraSysPrefix const &>(&DetectorBase::makeCameraSys, py::const_),
109  "cameraSysPrefix"_a);
110  });
111 }
112 
113 void declareDetectorBuilder(PyDetector &parent);
114 void declareDetectorPartialRebuilder(PyDetector &parent);
115 void declareDetectorInCameraBuilder(PyDetector &parent);
116 
117 void declareDetector(lsst::utils::python::WrapperCollection &wrappers) {
118  wrappers.wrapType(PyDetector(wrappers.module, "Detector"), [](auto &mod, auto &cls) {
119  declareDetectorBuilder(cls);
120  declareDetectorPartialRebuilder(cls);
121  declareDetectorInCameraBuilder(cls);
122  cls.def("rebuild", &Detector::rebuild);
123  declare1SysMethods<CameraSys>(cls);
124  declare1SysMethods<CameraSysPrefix>(cls);
125  declare2SysMethods<CameraSys, CameraSys>(cls);
126  declare2SysMethods<CameraSys, CameraSysPrefix>(cls);
127  declare2SysMethods<CameraSysPrefix, CameraSys>(cls);
128  declare2SysMethods<CameraSysPrefix, CameraSysPrefix>(cls);
129  cls.def("getTransformMap", &Detector::getTransformMap);
130  cls.def("getAmplifiers", &Detector::getAmplifiers);
131  // __iter__ defined in pure-Python extension
132  cls.def(
133  "__getitem__",
134  [](Detector const &self, std::ptrdiff_t i) {
135  return self[utils::python::cppIndex(self.size(), i)];
136  },
137  "i"_a);
138  cls.def("__getitem__", py::overload_cast<std::string const &>(&Detector::operator[], py::const_),
139  "name"_a);
140  cls.def("__len__", &Detector::size);
142  });
143 }
144 
145 void declareDetectorBuilder(PyDetector &parent) {
146  PyDetectorBuilder cls(parent, "Builder");
147  cls.def("setBBox", &Detector::Builder::setBBox);
148  cls.def("setType", &Detector::Builder::setType);
149  cls.def("setSerial", &Detector::Builder::setSerial);
150  cls.def("setPhysicalType", &Detector::Builder::setPhysicalType);
151  cls.def("setCrosstalk", &Detector::Builder::setCrosstalk);
152  cls.def("unsetCrosstalk", &Detector::Builder::unsetCrosstalk);
153  cls.def("getAmplifiers", &Detector::Builder::getAmplifiers);
154  cls.def(
155  "__getitem__",
156  [](Detector::Builder const &self, std::ptrdiff_t i) {
157  return self[utils::python::cppIndex(self.size(), i)];
158  },
159  "i"_a);
160  cls.def("__getitem__", py::overload_cast<std::string const &>(&Detector::Builder::operator[], py::const_),
161  "name"_a);
162  cls.def("append", &Detector::Builder::append);
163  cls.def("clear", &Detector::Builder::clear);
164  cls.def("__len__", &Detector::Builder::size);
165 }
166 
167 void declareDetectorPartialRebuilder(PyDetector &parent) {
168  PyDetectorPartialRebuilder cls(parent, "PartialRebuilder");
169  cls.def(py::init<Detector const &>(), "detector"_a);
170  cls.def("finish", &Detector::PartialRebuilder::finish);
171 }
172 
173 void declareDetectorInCameraBuilder(PyDetector &parent) {
174  PyDetectorInCameraBuilder cls(parent, "InCameraBuilder");
175  cls.def("setOrientation", &Detector::InCameraBuilder::setOrientation);
176  cls.def("setPixelSize", &Detector::InCameraBuilder::setPixelSize);
177  cls.def("setTransformFromPixelsTo",
178  py::overload_cast<CameraSysPrefix const &,
180  &Detector::InCameraBuilder::setTransformFromPixelsTo),
181  "toSys"_a, "transform"_a);
182  cls.def("setTransformFromPixelsTo",
183  py::overload_cast<CameraSys const &, std::shared_ptr<afw::geom::TransformPoint2ToPoint2 const>>(
184  &Detector::InCameraBuilder::setTransformFromPixelsTo),
185  "toSys"_a, "transform"_a);
186  cls.def("discardTransformFromPixelsTo",
187  py::overload_cast<CameraSysPrefix const &>(
188  &Detector::InCameraBuilder::discardTransformFromPixelsTo),
189  "toSys"_a);
190  cls.def("discardTransformFromPixelsTo",
191  py::overload_cast<CameraSys const &>(&Detector::InCameraBuilder::discardTransformFromPixelsTo),
192  "toSys"_a);
193 }
194 } // namespace
195 void wrapDetector(lsst::utils::python::WrapperCollection &wrappers) {
196  wrappers.addInheritanceDependency("lsst.afw.typehandling");
197  wrappers.wrapType(py::enum_<DetectorType>(wrappers.module, "DetectorType"), [](auto &mod, auto &enm) {
198  enm.value("SCIENCE", DetectorType::SCIENCE);
199  enm.value("FOCUS", DetectorType::FOCUS);
200  enm.value("GUIDER", DetectorType::GUIDER);
201  enm.value("WAVEFRONT", DetectorType::WAVEFRONT);
202  });
203  declareDetectorBase(wrappers);
204  declareDetector(wrappers);
205 }
206 } // namespace cameraGeom
207 } // namespace afw
208 } // namespace lsst
table::Key< int > transform
std::shared_ptr< FrameSet > append(FrameSet const &first, FrameSet const &second)
Construct a FrameSet that performs two transformations in series.
Definition: functional.cc:33
void wrapDetector(lsst::utils::python::WrapperCollection &)
Definition: _detector.cc:195
py::class_< PixelAreaBoundedField, std::shared_ptr< PixelAreaBoundedField >, BoundedField > PyClass
void addPersistableMethods(pybind11::class_< Class, Args... > &cls)
Add table::io::Persistable and PersistableFacade methods to the pybind11 wrapper for a class.
Definition: python.h:56
std::size_t cppIndex(std::ptrdiff_t size, std::ptrdiff_t i)
Compute a C++ index from a Python index (negative values count from the end) and range-check.
Definition: python.h:124
A base class for image defects.