LSSTApplications  20.0.0
LSSTDataManagementBasePackage
region.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/Box.h"
27 #include "lsst/sphgeom/Box3d.h"
28 #include "lsst/sphgeom/Circle.h"
30 #include "lsst/sphgeom/Ellipse.h"
31 #include "lsst/sphgeom/Region.h"
33 
36 
37 namespace py = pybind11;
38 using namespace pybind11::literals;
39 
40 namespace lsst {
41 namespace sphgeom {
42 namespace {
43 
44 PYBIND11_MODULE(region, mod) {
45  py::class_<Region, std::unique_ptr<Region>> cls(mod, "Region");
46 
47  // clone() is wrapped by Region subclasses. It returns wrapper
48  // objects specific to the subclass, rather than a generic one.
49  cls.def("clone", [](Region const &self) { return self.clone().release(); });
50  cls.def("getBoundingBox", &Region::getBoundingBox);
51  cls.def("getBoundingBox3d", &Region::getBoundingBox3d);
52  cls.def("getBoundingCircle", &Region::getBoundingCircle);
53  cls.def("contains", &Region::contains, "unitVector"_a);
54  cls.def("__contains__", &Region::contains, "unitVector"_a,
55  py::is_operator());
56  // The per-subclass relate() overloads are used to implement
57  // double-dispatch in C++, and are not needed in Python.
58  cls.def("relate",
59  (Relationship(Region::*)(Region const &) const) & Region::relate,
60  "region"_a);
61  cls.def("encode", &python::encode);
62 
63  cls.def_static(
64  "decode",
65  [](py::bytes bytes) {
66  uint8_t const *buffer = reinterpret_cast<uint8_t const *>(
67  PYBIND11_BYTES_AS_STRING(bytes.ptr()));
68  size_t n =
69  static_cast<size_t>(PYBIND11_BYTES_SIZE(bytes.ptr()));
70  return Region::decode(buffer, n).release();
71  },
72  "bytes"_a);
73 }
74 
75 } // <anonymous>
76 } // sphgeom
77 } // lsst
Region.h
This file defines an interface for spherical regions.
Box3d.h
This file declares a class for representing axis-aligned bounding boxes in ℝ³.
utils.h
UnitVector3d.h
This file declares a class for representing unit vectors in ℝ³.
Circle.h
This file declares a class for representing circular regions on the unit sphere.
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
astshim.fitsChanContinued.contains
def contains(self, name)
Definition: fitsChanContinued.py:127
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
Ellipse.h
This file declares a class for representing elliptical regions on the unit sphere.
bytes
table::Key< table::Array< std::uint8_t > > bytes
Definition: Transform.cc:199
relationship.h
Box.h
This file declares a class for representing longitude/latitude angle boxes on the unit sphere.
pybind11
Definition: _GenericMap.cc:40
lsst::afw::cameraGeom::PYBIND11_MODULE
PYBIND11_MODULE(camera, mod)
Definition: camera.cc:133
ConvexPolygon.h
This file declares a class for representing convex polygons with great circle edges on the unit spher...