LSSTApplications  20.0.0
LSSTDataManagementBasePackage
cameraSys.cc
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * See COPYRIGHT file at the top of the source tree.
4  *
5  * This product includes software developed by the
6  * LSST Project (http://www.lsst.org/).
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <https://www.lsstcorp.org/LegalNotices/>.
21  */
22 
23 #include <string>
24 
25 #include <pybind11/pybind11.h>
26 //#include <pybind11/stl.h>
27 
28 #include "lsst/utils/python.h"
29 
31 
32 namespace py = pybind11;
33 using namespace py::literals;
34 
35 namespace lsst {
36 namespace afw {
37 namespace cameraGeom {
38 
39 namespace {
46 template <typename CppClass, typename PyClass>
47 void declareCommonSysMethods(PyClass &cls) {
48  /* Operators */
49  cls.def("__eq__", [](CppClass const &self, CppClass const &other) { return self == other; },
50  py::is_operator());
51  cls.def("__ne__", [](CppClass const &self, CppClass const &other) { return self != other; },
52  py::is_operator());
53  utils::python::addOutputOp(cls, "__str__");
54  utils::python::addOutputOp(cls, "__repr__");
56 
57  /* Methods */
58  cls.def("getSysName", &CppClass::getSysName);
59 }
60 }
61 
62 PYBIND11_MODULE(cameraSys, mod) {
63  /* Module level */
64  py::class_<CameraSysPrefix> clsCameraSysPrefix(mod, "CameraSysPrefix");
65  py::class_<CameraSys> clsCameraSys(mod, "CameraSys");
66 
67  // The following must come after the associated pybind11 class is declared
68  // (e.g. FOCAL_PLANE is a CameraSys, so clsCameraSys must have been declared
69  mod.attr("FOCAL_PLANE") = py::cast(FOCAL_PLANE);
70  mod.attr("FIELD_ANGLE") = py::cast(FIELD_ANGLE);
71  mod.attr("PIXELS") = py::cast(PIXELS);
72  mod.attr("TAN_PIXELS") = py::cast(TAN_PIXELS);
73  mod.attr("ACTUAL_PIXELS") = py::cast(ACTUAL_PIXELS);
74 
75  /* Member types and enums */
76  declareCommonSysMethods<CameraSysPrefix>(clsCameraSysPrefix);
77  declareCommonSysMethods<CameraSys>(clsCameraSys);
78 
79  /* Constructors */
80  clsCameraSysPrefix.def(py::init<std::string const &>(), "sysName"_a);
81  clsCameraSys.def(py::init<std::string const &, std::string const &>(), "sysName"_a,
82  "detectorName"_a = "");
83  clsCameraSys.def(py::init<CameraSysPrefix const &, std::string const &>(), "sysPrefix"_a,
84  "detectorName"_a = "");
85 
86  /* Operators */
87 
88  /* Members */
89  clsCameraSys.def("getDetectorName", &CameraSys::getDetectorName);
90  clsCameraSys.def("hasDetectorName", &CameraSys::hasDetectorName);
91 }
92 }
93 }
94 }
lsst::utils::python::addOutputOp
void addOutputOp(PyClass &cls, std::string const &method)
Add __str__ or __repr__ method implemented by operator<<.
Definition: python.h:87
lsst::utils::python::addHash
void addHash(PyClass &cls)
Add __hash__ method implemented by std::hash.
Definition: python.h:104
lsst::afw::cameraGeom::TAN_PIXELS
CameraSysPrefix const TAN_PIXELS
Tangent-plane pixels on the detector (x, y unbinned pixels)
Definition: CameraSys.cc:36
lsst::afw
Definition: imageAlgorithm.dox:1
CameraSys.h
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
lsst::afw::cameraGeom::ACTUAL_PIXELS
CameraSysPrefix const ACTUAL_PIXELS
The actual pixels where the photon lands and electrons are generated (x,y unbinned) This takes into a...
Definition: CameraSys.cc:38
other
ItemVariant const * other
Definition: Schema.cc:56
PyClass
py::class_< ProductBoundedField, std::shared_ptr< ProductBoundedField >, BoundedField > PyClass
Definition: productBoundedField.cc:32
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
python.h
lsst::afw::cameraGeom::FOCAL_PLANE
CameraSys const FOCAL_PLANE
Focal plane coordinates: Position on a 2-d planar approximation to the focal plane (x,...
Definition: CameraSys.cc:30
lsst::afw::cameraGeom::PYBIND11_MODULE
PYBIND11_MODULE(cameraSys, mod)
Definition: cameraSys.cc:62
lsst::afw::cameraGeom::FIELD_ANGLE
CameraSys const FIELD_ANGLE
Field angle coordinates: Angle of a principal ray relative to the optical axis (x,...
Definition: CameraSys.cc:32
pybind11
Definition: _GenericMap.cc:40
lsst::afw::cameraGeom::PIXELS
CameraSysPrefix const PIXELS
Pixel coordinates: Nominal position on the entry surface of a given detector (x, y unbinned pixels).
Definition: CameraSys.cc:34