LSSTApplications  20.0.0
LSSTDataManagementBasePackage
_Interval.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/stl.h"
24 #include "pybind11/numpy.h"
25 #include "ndarray/pybind11.h"
26 
27 #include "lsst/geom/Interval.h"
28 #include "lsst/utils/python.h"
29 
30 namespace py = pybind11;
31 using namespace py::literals;
32 
33 namespace lsst {
34 namespace geom {
35 
36 namespace {
37 
38 template <typename PyClass>
39 void declareCommonIntervalInterface(PyClass &cls) {
40  using T = typename PyClass::type;
41  using Element = typename T::Element;
42  cls.def(py::init<>());
43  // It's not clear why py::overload cast doesn't work for the next two
44  // declarations - maybe the templated context matters?
45  cls.def_static("fromSpannedPoints", [](ndarray::Array<Element const, 1> const &elements) {
46  return T::fromSpannedPoints(elements);
47  });
48  cls.def_static("fromSpannedPoints",
49  [](std::vector<Element> const &elements) { return T::fromSpannedPoints(elements); });
50  cls.def(py::init([](py::kwargs kw) -> T {
51  if (kw.size() == 2) {
52  if (kw.contains("min")) {
53  if (kw.contains("max")) {
54  return T::fromMinMax(py::cast<Element>(kw["min"]), py::cast<Element>(kw["max"]));
55  }
56  if (kw.contains("size")) {
57  return T::fromMinSize(py::cast<Element>(kw["min"]), py::cast<Element>(kw["size"]));
58  }
59  }
60  if (kw.contains("max") && kw.contains("size")) {
61  return T::fromMaxSize(py::cast<Element>(kw["max"]), py::cast<Element>(kw["size"]));
62  }
63  if (kw.contains("center") && kw.contains("size")) {
64  return T::fromCenterSize(py::cast<Element>(kw["center"]), py::cast<Element>(kw["size"]));
65  }
66  }
67  PyErr_SetString(PyExc_TypeError,
68  "General constructor requires exactly 2 of the following keyword-only "
69  "arguments: (min, max, center, size).");
70  throw py::error_already_set();
71  }));
72  cls.def(py::init<T const &>());
73  cls.def("__eq__", [](T const &self, T const &other) { return self == other; }, py::is_operator());
74  cls.def("__ne__", [](T const &self, T const &other) { return self != other; }, py::is_operator());
75  cls.def("getMin", &T::getMin);
76  cls.def_property_readonly("min", &T::getMin);
77  cls.def("getMax", &T::getMax);
78  cls.def_property_readonly("max", &T::getMax);
79  cls.def("getSize", &T::getSize);
80  cls.def_property_readonly("size", &T::getSize);
81  cls.def("isEmpty", &T::isEmpty);
82  cls.def("contains", py::overload_cast<T const &>(&T::contains, py::const_));
83  cls.def("contains", py::vectorize(static_cast<bool (T::*)(Element) const noexcept>(&T::contains)));
84  cls.def("__contains__", py::overload_cast<Element>(&T::contains, py::const_));
85  cls.def("__contains__", py::overload_cast<T const &>(&T::contains, py::const_));
86  cls.def("overlaps", &T::overlaps);
87  cls.def("intersects", &T::intersects);
88  cls.def("isDisjointFrom", &T::isDisjointFrom);
89  cls.def("dilatedBy", &T::dilatedBy);
90  cls.def("erodedBy", &T::erodedBy);
91  cls.def("shiftedBy", &T::shiftedBy);
92  cls.def("reflectedAbout", &T::reflectedAbout);
93  cls.def("expandedTo", py::overload_cast<Element>(&T::expandedTo, py::const_));
94  cls.def("expandedTo", py::overload_cast<T const &>(&T::expandedTo, py::const_));
95  cls.def("clippedTo", &T::clippedTo);
96  cls.def("__str__", &T::toString);
97  utils::python::addOutputOp(cls, "__repr__");
98  cls.def("__reduce__", [cls](IntervalD const &self) {
99  return py::make_tuple(cls, make_tuple(py::cast(self.getMin()), py::cast(self.getMax())));
100  });
101 }
102 
103 } // namespace
104 
106  wrappers.wrapType(py::class_<IntervalI, std::shared_ptr<IntervalI>>(wrappers.module, "IntervalI"),
107  [](auto &mod, auto &cls) {
108  py::enum_<IntervalI::EdgeHandlingEnum>(cls, "EdgeHandlingEnum")
109  .value("EXPAND", IntervalI::EdgeHandlingEnum::EXPAND)
110  .value("SHRINK", IntervalI::EdgeHandlingEnum::SHRINK);
111  cls.def(py::init<IntervalD const &, IntervalI::EdgeHandlingEnum>(), "other"_a,
112  "edgeHandling"_a = IntervalI::EdgeHandlingEnum::EXPAND);
113  cls.def("getBegin", &IntervalI::getBegin);
114  cls.def_property_readonly("begin", &IntervalI::getBegin);
115  cls.def("getEnd", &IntervalI::getEnd);
116  cls.def_property_readonly("end", &IntervalI::getEnd);
117  declareCommonIntervalInterface(cls);
118  });
119 
120  wrappers.wrapType(py::class_<IntervalD, std::shared_ptr<IntervalD>>(wrappers.module, "IntervalD"),
121  [](auto &mod, auto &cls) {
122  cls.def(py::init<IntervalI const &>());
123  cls.def("getCenter", &IntervalD::getCenter);
124  cls.def_property_readonly("center", &IntervalD::getCenter);
125  cls.def("isFinite", &IntervalD::isFinite);
126  declareCommonIntervalInterface(cls);
127  });
128 }
129 
130 } // namespace geom
131 } // namespace lsst
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::geom::IntervalI
A 1-d integer coordinate range.
Definition: Interval.h:50
std::make_tuple
T make_tuple(T... args)
std::shared_ptr
STL class.
std::vector< Element >
Interval.h
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
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
astshim.fitsChanContinued.contains
def contains(self, name)
Definition: fitsChanContinued.py:127
other
ItemVariant const * other
Definition: Schema.cc:56
PyClass
py::class_< ProductBoundedField, std::shared_ptr< ProductBoundedField >, BoundedField > PyClass
Definition: productBoundedField.cc:32
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::IntervalD
A floating-point coordinate rectangle geometry.
Definition: Interval.h:413
lsst::geom
Definition: geomOperators.dox:4
type
table::Key< int > type
Definition: Detector.cc:163
lsst::geom::wrapInterval
void wrapInterval(WrapperCollection &wrappers)
Definition: _Interval.cc:105
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::utils.tests.init
def init()
Definition: tests.py:58
lsst.pipe.drivers.constructCalibs.getSize
def getSize(dimList)
Definition: constructCalibs.py:176