LSSTApplications  20.0.0
LSSTDataManagementBasePackage
_AffineTransform.cc
Go to the documentation of this file.
1 /*
2  * Developed for the LSST Data Management System.
3  * This product includes software developed by the LSST Project
4  * (https://www.lsst.org).
5  * See the COPYRIGHT file at the top-level directory of this distribution
6  * for details of code ownership.
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 GNU General Public License
19  * along with this program. If not, see <https://www.gnu.org/licenses/>.
20  */
21 
22 #include "pybind11/pybind11.h"
23 #include "pybind11/eigen.h"
24 #include "pybind11/stl.h"
25 
26 #include "ndarray/pybind11.h"
27 
29 #include "lsst/utils/python.h"
30 
31 namespace py = pybind11;
32 using namespace pybind11::literals;
33 
34 namespace lsst {
35 namespace geom {
36 
38  wrappers.wrapType(
39  py::class_<AffineTransform, std::shared_ptr<AffineTransform>>(wrappers.module, "AffineTransform"),
40  [](auto & mod, auto & cls) mutable {
41 
42  // Parameters enum is really only used as integer constants.
43  cls.attr("XX") = py::cast(int(AffineTransform::Parameters::XX));
44  cls.attr("YX") = py::cast(int(AffineTransform::Parameters::YX));
45  cls.attr("XY") = py::cast(int(AffineTransform::Parameters::XY));
46  cls.attr("YY") = py::cast(int(AffineTransform::Parameters::YY));
47  cls.attr("X") = py::cast(int(AffineTransform::Parameters::X));
48  cls.attr("Y") = py::cast(int(AffineTransform::Parameters::Y));
49 
50  /* Constructors */
51  cls.def(py::init<>());
52  cls.def(py::init<Eigen::Matrix3d const &>(), "matrix"_a);
53  cls.def(py::init<Eigen::Matrix2d const &>(), "linear"_a);
54  cls.def(py::init<Eigen::Vector2d const &>(), "translation"_a);
55  cls.def(py::init<Eigen::Matrix2d const &, Eigen::Vector2d const &>(),
56  "linear"_a, "translation"_a);
57  cls.def(py::init<LinearTransform const &>(), "linear"_a);
58  cls.def(py::init<Extent2D const &>(), "translation"_a);
59  cls.def(py::init<LinearTransform const &, Extent2D const &>(), "linear"_a, "translation"_a);
60 
61  /* Operators and special methods */
62  cls.def("__mul__", &AffineTransform::operator*, py::is_operator());
63  cls.def("__call__",
64  py::overload_cast<Point2D const &>(&AffineTransform::operator(), py::const_));
65  cls.def("__call__",
66  py::overload_cast<Extent2D const &>(&AffineTransform::operator(), py::const_));
67  cls.def("__call__",
68  // We use pybind11's wrappers for the Python C API to
69  // delegate to other wrapped methods because:
70  // - defining this in pure Python is tricky because it's
71  // an overload, not a standalone method;
72  // - we'd rather not add a new pure-Python file just for
73  // this;
74  // - using py::vectorize internal to the method would
75  // involve defining a new internal callable every time
76  // this method is called.
77  // The other viable alternative would be to define
78  // applyX and applyY as Python callables with py::vectorize
79  // outside the lambda as C++ local variables, and then
80  // capture them by value in the lambda. This just seems
81  // slightly cleaner, as it's closer to how one would
82  // implement this in pure Python, if it wasn't an overload.
83  [](py::object self, py::object x, py::object y) {
84  return py::make_tuple(self.attr("applyX")(x, y),
85  self.attr("applyY")(x, y));
86  },
87  "x"_a, "y"_a);
88  cls.def("__setitem__", [](AffineTransform &self, int i, double value) {
89  if (i < 0 || i > 5) {
90  PyErr_Format(PyExc_IndexError, "Invalid index for AffineTransform: %d", i);
91  throw py::error_already_set();
92  }
93  self[i] = value;
94  });
95  cls.def("__getitem__", [](AffineTransform const &self, int row, int col) {
96  if (row < 0 || row > 2 || col < 0 || col > 2) {
97  PyErr_Format(PyExc_IndexError, "Invalid index for AffineTransform: %d, %d", row, col);
98  throw py::error_already_set();
99  }
100  return (self.getMatrix())(row, col);
101  });
102  cls.def("__getitem__", [](AffineTransform const &self, int i) {
103  if (i < 0 || i > 5) {
104  PyErr_Format(PyExc_IndexError, "Invalid index for AffineTransform: %d", i);
105  throw py::error_already_set();
106  }
107  return self[i];
108  });
109  cls.def("__str__", [](AffineTransform const &self) {
110  return py::str(py::cast(self.getMatrix())); }
111  );
112  cls.def("__repr__", [](AffineTransform const &self) {
113  return py::str("AffineTransform(\n{}\n)").format(py::cast(self.getMatrix()));
114  });
115  cls.def("__reduce__", [cls](AffineTransform const &self) {
116  return py::make_tuple(cls, py::make_tuple(py::cast(self.getMatrix())));
117  });
118 
119  /* Members */
120  cls.def("inverted", &AffineTransform::inverted);
121  cls.def("isIdentity", &AffineTransform::isIdentity);
122  cls.def("getTranslation", (Extent2D & (AffineTransform::*)()) & AffineTransform::getTranslation);
123  cls.def("getLinear", (LinearTransform & (AffineTransform::*)()) & AffineTransform::getLinear);
124  cls.def("getMatrix", &AffineTransform::getMatrix);
125  cls.def("getParameterVector", &AffineTransform::getParameterVector);
126  cls.def("setParameterVector", &AffineTransform::setParameterVector);
127  cls.def("applyX", py::vectorize(&AffineTransform::applyX), "x"_a, "y"_a);
128  cls.def("applyY", py::vectorize(&AffineTransform::applyY), "x"_a, "y"_a);
129  cls.def_static("makeScaling", py::overload_cast<double>(&AffineTransform::makeScaling));
130  cls.def_static("makeScaling", py::overload_cast<double, double>(&AffineTransform::makeScaling));
131  cls.def_static("makeRotation", &AffineTransform::makeRotation, "angle"_a);
132  cls.def_static("makeTranslation", &AffineTransform::makeTranslation, "translation"_a);
133 
134  /* Non-members */
135  mod.def("makeAffineTransformFromTriple", makeAffineTransformFromTriple);
136  }
137  );
138 }
139 
140 } // namespace geom
141 } // namespace lsst
lsst::geom::wrapAffineTransform
void wrapAffineTransform(utils::python::WrapperCollection &wrappers)
Definition: _AffineTransform.cc:37
std::shared_ptr
STL class.
lsst::geom::LinearTransform
A 2D linear coordinate transformation.
Definition: LinearTransform.h:69
AffineTransform.h
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
lsst::geom::AffineTransform
An affine coordinate transformation consisting of a linear transformation and an offset.
Definition: AffineTransform.h:75
lsst::utils::python::WrapperCollection::wrapType
PyType wrapType(PyType cls, ClassWrapperCallback function, bool setModuleName=true)
Add a type (class or enum) wrapper, deferring method and other attribute definitions until finish() i...
Definition: python.h:391
lsst::utils::python::WrapperCollection
A helper class for subdividing pybind11 module across multiple translation units (i....
Definition: python.h:242
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
python.h
lsst::geom
Definition: geomOperators.dox:4
row
int row
Definition: CR.cc:145
col
int col
Definition: CR.cc:144
pybind11
Definition: _GenericMap.cc:40
lsst::utils::python::WrapperCollection::module
pybind11::module module
The module object passed to the PYBIND11_MODULE block that contains this WrapperCollection.
Definition: python.h:448
lsst::geom::makeAffineTransformFromTriple
AffineTransform makeAffineTransformFromTriple(Point2D const &p1, Point2D const &p2, Point2D const &p3, Point2D const &q1, Point2D const &q2, Point2D const &q3)
Definition: AffineTransform.cc:88
lsst::geom::Extent< double, 2 >