LSSTApplications  20.0.0
LSSTDataManagementBasePackage
polygon.cc
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2008-2016 AURA/LSST.
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 <memory>
24 
25 #include <pybind11/pybind11.h>
26 #include <pybind11/stl.h>
27 
30 #include "lsst/geom/Box.h"
31 #include "lsst/geom/Point.h"
36 #include "lsst/afw/table/io/python.h" // for addPersistableMethods
37 
38 namespace py = pybind11;
39 using namespace py::literals;
40 
41 namespace lsst {
42 namespace afw {
43 namespace geom {
44 namespace polygon {
45 
46 PYBIND11_MODULE(polygon, mod) {
47  py::module::import("lsst.pex.exceptions");
48  py::module::import("lsst.afw.typehandling");
49 
50  // TODO: Commented-out code is waiting until needed and is untested.
51  // Add tests for it and enable it or remove it before the final pybind11 merge.
52 
53  /* Module level */
54  py::class_<Polygon, std::shared_ptr<Polygon>, typehandling::Storable> clsPolygon(mod, "Polygon");
55 
56  pex::exceptions::python::declareException<SinglePolygonException, pex::exceptions::RuntimeError>(
57  mod, "SinglePolygonException", "RuntimeError");
58 
59  /* Member types and enums */
60 
61  /* Constructors */
62  clsPolygon.def(py::init<Polygon::Box const &>());
63  clsPolygon.def(py::init<Polygon::Box const &, TransformPoint2ToPoint2 const &>());
64  clsPolygon.def(py::init<Polygon::Box const &, lsst::geom::AffineTransform const &>());
65  clsPolygon.def(py::init<std::vector<Polygon::Point> const &>());
66 
67  table::io::python::addPersistableMethods<Polygon>(clsPolygon);
68 
69  /* Operators */
70  clsPolygon.def("__eq__", [](Polygon const &self, Polygon const &other) { return self == other; },
71  py::is_operator());
72  clsPolygon.def("__ne__", [](Polygon const &self, Polygon const &other) { return self != other; },
73  py::is_operator());
74 
75  /* Members */
76  clsPolygon.def("getNumEdges", &Polygon::getNumEdges);
77  clsPolygon.def("getBBox", &Polygon::getBBox);
78  clsPolygon.def("calculateCenter", &Polygon::calculateCenter);
79  clsPolygon.def("calculateArea", &Polygon::calculateArea);
80  clsPolygon.def("calculatePerimeter", &Polygon::calculatePerimeter);
81  clsPolygon.def("getVertices", &Polygon::getVertices);
82  clsPolygon.def("getEdges", &Polygon::getEdges);
83  clsPolygon.def("contains", &Polygon::contains);
84  clsPolygon.def("overlaps", (bool (Polygon::*)(Polygon const &) const) & Polygon::overlaps);
85  clsPolygon.def("overlaps", (bool (Polygon::*)(Polygon::Box const &) const) & Polygon::overlaps);
86  clsPolygon.def("intersectionSingle", (std::shared_ptr<Polygon>(Polygon::*)(Polygon const &) const) &
87  Polygon::intersectionSingle);
88  clsPolygon.def("intersectionSingle", (std::shared_ptr<Polygon>(Polygon::*)(Polygon::Box const &) const) &
89  Polygon::intersectionSingle);
90  clsPolygon.def("intersection",
91  (std::vector<std::shared_ptr<Polygon>>(Polygon::*)(Polygon const &) const) &
92  Polygon::intersection);
93  clsPolygon.def("intersection",
95  Polygon::intersection);
96  clsPolygon.def("unionSingle",
97  (std::shared_ptr<Polygon>(Polygon::*)(Polygon const &) const) & Polygon::unionSingle);
98  clsPolygon.def("unionSingle",
99  (std::shared_ptr<Polygon>(Polygon::*)(Polygon::Box const &) const) & Polygon::unionSingle);
100 
101  // Wrap Polygon::union_ (C++) as Polygon.union (Python)
102  clsPolygon.def("union", (std::vector<std::shared_ptr<Polygon>>(Polygon::*)(Polygon const &) const) &
103  Polygon::union_);
104  clsPolygon.def("union", (std::vector<std::shared_ptr<Polygon>>(Polygon::*)(Polygon::Box const &) const) &
105  Polygon::union_);
106  clsPolygon.def("symDifference",
107  (std::vector<std::shared_ptr<Polygon>>(Polygon::*)(Polygon const &) const) &
108  Polygon::symDifference);
109  clsPolygon.def("symDifference",
111  Polygon::symDifference);
112  // clsPolygon.def("simplify", &Polygon::simplify);
113  clsPolygon.def("convexHull", &Polygon::convexHull);
114  clsPolygon.def("transform",
117  clsPolygon.def("transform",
120  clsPolygon.def("subSample", (std::shared_ptr<Polygon>(Polygon::*)(size_t) const) & Polygon::subSample);
121  clsPolygon.def("subSample", (std::shared_ptr<Polygon>(Polygon::*)(double) const) & Polygon::subSample);
122  clsPolygon.def("createImage",
124  Polygon::createImage);
125  clsPolygon.def(
126  "createImage",
128  Polygon::createImage);
129  // clsPolygon.def("isPersistable", &Polygon::isPersistable);
130 }
131 } // namespace polygon
132 } // namespace geom
133 } // namespace afw
134 } // namespace lsst
Box.h
std::shared_ptr
STL class.
lsst::afw::geom::Transform
Transform LSST spatial data, such as lsst::geom::Point2D and lsst::geom::SpherePoint,...
Definition: Transform.h:68
Exception.h
std::vector
STL class.
AffineTransform.h
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::geom::polygon::PYBIND11_MODULE
PYBIND11_MODULE(polygon, mod)
Definition: polygon.cc:46
lsst::afw::typehandling::Storable
Interface supporting iteration over heterogenous containers.
Definition: Storable.h:58
Transform.h
lsst::geom::AffineTransform
An affine coordinate transformation consisting of a linear transformation and an offset.
Definition: AffineTransform.h:75
lsst::afw::geom::polygon::Polygon
Cartesian polygons.
Definition: Polygon.h:59
astshim.fitsChanContinued.contains
def contains(self, name)
Definition: fitsChanContinued.py:127
other
ItemVariant const * other
Definition: Schema.cc:56
Storable.h
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
Polygon.h
lsst::geom
Definition: geomOperators.dox:4
Runtime.h
python.h
lsst::geom::Box2I
An integer coordinate rectangle.
Definition: Box.h:55
transform
table::Key< int > transform
Definition: TransformMap.cc:299
pybind11
Definition: _GenericMap.cc:40
Point.h
lsst::geom::Box2D
A floating-point coordinate rectangle geometry.
Definition: Box.h:413
lsst::afw::image::Image< float >
lsst::utils.tests.init
def init()
Definition: tests.py:58
lsst::geom::Extent< int, 2 >