LSSTApplications  20.0.0
LSSTDataManagementBasePackage
box3d.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 #include "pybind11/pybind11.h"
23 
24 #include <memory>
25 
26 #include "lsst/sphgeom/Box3d.h"
29 
30 namespace py = pybind11;
31 using namespace pybind11::literals;
32 
33 namespace lsst {
34 namespace sphgeom {
35 namespace {
36 
37 PYBIND11_MODULE(box3d, mod) {
38  py::module::import("lsst.sphgeom.interval1d");
39  py::module::import("lsst.sphgeom.vector3d");
40 
41  py::class_<Box3d, std::shared_ptr<Box3d>> cls(mod, "Box3d");
42 
43  cls.def_static("empty", &Box3d::empty);
44  cls.def_static("full", &Box3d::full);
45  cls.def_static("aroundUnitSphere", &Box3d::aroundUnitSphere);
46 
47  cls.def(py::init<>());
48  cls.def(py::init<Vector3d const &>(), "vector"_a);
49  cls.def(py::init<Vector3d const &, Vector3d const &>(), "vector1"_a,
50  "vector2"_a);
51  cls.def(py::init<Vector3d const &, double, double, double>(), "center"_a,
52  "halfWidth"_a, "halfHeight"_a, "halfDepth"_a);
53  cls.def(py::init<Interval1d const &, Interval1d const &,
54  Interval1d const &>(),
55  "x"_a, "y"_a, "z"_a);
56  cls.def(py::init<Box3d const &>(), "box3d"_a);
57 
58  cls.def("__eq__",
59  (bool (Box3d::*)(Box3d const &) const) & Box3d::operator==,
60  py::is_operator());
61  cls.def("__eq__",
62  (bool (Box3d::*)(Vector3d const &) const) & Box3d::operator==,
63  py::is_operator());
64  cls.def("__ne__",
65  (bool (Box3d::*)(Box3d const &) const) & Box3d::operator!=,
66  py::is_operator());
67  cls.def("__ne__",
68  (bool (Box3d::*)(Vector3d const &) const) & Box3d::operator!=,
69  py::is_operator());
70  cls.def("__contains__",
71  (bool (Box3d::*)(Vector3d const &) const) & Box3d::contains,
72  py::is_operator());
73  cls.def("__contains__",
74  (bool (Box3d::*)(Box3d const &) const) & Box3d::contains,
75  py::is_operator());
76  cls.def("__len__", [](Box3d const &self) { return py::int_(3); });
77  cls.def("__getitem__", [](Box3d const &self, py::int_ row) {
78  return self(static_cast<int>(python::convertIndex(3, row)));
79  });
80 
81  cls.def("x", &Box3d::x);
82  cls.def("y", &Box3d::y);
83  cls.def("z", &Box3d::z);
84  cls.def("isEmpty", &Box3d::isEmpty);
85  cls.def("isFull", &Box3d::isFull);
86  cls.def("getCenter", &Box3d::getCenter);
87  cls.def("getWidth", &Box3d::getWidth);
88  cls.def("getHeight", &Box3d::getHeight);
89  cls.def("getDepth", &Box3d::getDepth);
90 
91  cls.def("contains",
92  (bool (Box3d::*)(Vector3d const &) const) & Box3d::contains);
93  cls.def("contains",
94  (bool (Box3d::*)(Box3d const &) const) & Box3d::contains);
95  cls.def("isDisjointFrom",
96  (bool (Box3d::*)(Vector3d const &) const) & Box3d::isDisjointFrom);
97  cls.def("isDisjointFrom",
98  (bool (Box3d::*)(Box3d const &) const) & Box3d::isDisjointFrom);
99  cls.def("intersects",
100  (bool (Box3d::*)(Vector3d const &) const) & Box3d::intersects);
101  cls.def("intersects",
102  (bool (Box3d::*)(Box3d const &) const) & Box3d::intersects);
103  cls.def("isWithin",
104  (bool (Box3d::*)(Vector3d const &) const) & Box3d::isWithin);
105  cls.def("isWithin",
106  (bool (Box3d::*)(Box3d const &) const) & Box3d::isWithin);
107 
108  cls.def("clipTo", (Box3d & (Box3d::*)(Vector3d const &)) & Box3d::clipTo);
109  cls.def("clipTo", (Box3d & (Box3d::*)(Box3d const &)) & Box3d::clipTo);
110  cls.def("clippedTo",
111  (Box3d(Box3d::*)(Vector3d const &) const) & Box3d::clippedTo);
112  cls.def("clippedTo",
113  (Box3d(Box3d::*)(Box3d const &) const) & Box3d::clippedTo);
114  cls.def("expandTo",
115  (Box3d & (Box3d::*)(Vector3d const &)) & Box3d::expandTo);
116  cls.def("expandTo", (Box3d & (Box3d::*)(Box3d const &)) & Box3d::expandTo);
117  cls.def("expandedTo",
118  (Box3d(Box3d::*)(Vector3d const &) const) & Box3d::expandedTo);
119  cls.def("expandedTo",
120  (Box3d(Box3d::*)(Box3d const &) const) & Box3d::expandedTo);
121 
122  cls.def("dilateBy", (Box3d & (Box3d::*)(double)) & Box3d::dilateBy,
123  "radius"_a);
124  cls.def("dilateBy",
125  (Box3d & (Box3d::*)(double, double, double)) & Box3d::dilateBy,
126  "width"_a, "height"_a, "depth"_a);
127  cls.def("dilatedBy", (Box3d(Box3d::*)(double) const) & Box3d::dilatedBy,
128  "radius"_a);
129  cls.def("dilatedBy",
130  (Box3d(Box3d::*)(double, double, double) const) & Box3d::dilatedBy,
131  "width"_a, "height"_a, "depth"_a);
132  cls.def("erodeBy", (Box3d & (Box3d::*)(double)) & Box3d::erodeBy,
133  "radius"_a);
134  cls.def("erodeBy",
135  (Box3d & (Box3d::*)(double, double, double)) & Box3d::erodeBy,
136  "width"_a, "height"_a, "depth"_a);
137  cls.def("erodedBy", (Box3d(Box3d::*)(double) const) & Box3d::erodedBy,
138  "radius"_a);
139  cls.def("erodedBy",
140  (Box3d(Box3d::*)(double, double, double) const) & Box3d::erodedBy,
141  "width"_a, "height"_a, "depth"_a);
142 
143  cls.def("relate",
144  (Relationship(Box3d::*)(Vector3d const &) const) & Box3d::relate);
145  cls.def("relate",
146  (Relationship(Box3d::*)(Box3d const &) const) & Box3d::relate);
147 
148  cls.def("__str__", [](Box3d const &self) {
149  return py::str("[{!s},\n"
150  " {!s},\n"
151  " {!s}]")
152  .format(self.x(), self.y(), self.z());
153  });
154  cls.def("__repr__", [](Box3d const &self) {
155  return py::str("Box3d({!r},\n"
156  " {!r},\n"
157  " {!r})")
158  .format(self.x(), self.y(), self.z());
159  });
160  cls.def("__reduce__", [cls](Box3d const &self) {
161  return py::make_tuple(cls,
162  py::make_tuple(self.x(), self.y(), self.z()));
163  });
164 }
165 
166 } // <anonymous>
167 } // sphgeom
168 } // lsst
y
int y
Definition: SpanSet.cc:49
Box3d.h
This file declares a class for representing axis-aligned bounding boxes in ℝ³.
utils.h
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
astshim.fitsChanContinued.contains
def contains(self, name)
Definition: fitsChanContinued.py:127
z
double z
Definition: Match.cc:44
x
double x
Definition: ChebyshevBoundedField.cc:277
lsst::sphgeom::detail::relate
Relationship relate(VertexIterator const begin, VertexIterator const end, Box const &b)
Definition: ConvexPolygonImpl.h:258
lsst::sphgeom::Relationship
std::bitset< 3 > Relationship
Relationship describes how two sets are related.
Definition: Relationship.h:35
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
row
int row
Definition: CR.cc:145
relationship.h
pybind11
Definition: _GenericMap.cc:40
lsst::utils.tests.init
def init()
Definition: tests.py:58
lsst::afw::cameraGeom::PYBIND11_MODULE
PYBIND11_MODULE(camera, mod)
Definition: camera.cc:133