Loading [MathJax]/extensions/tex2jax.js
LSST Applications 28.0.0,g1653933729+a8ce1bb630,g1a997c3884+a8ce1bb630,g28da252d5a+5bd70b7e6d,g2bbee38e9b+638fca75ac,g2bc492864f+638fca75ac,g3156d2b45e+07302053f8,g347aa1857d+638fca75ac,g35bb328faa+a8ce1bb630,g3a166c0a6a+638fca75ac,g3e281a1b8c+7bbb0b2507,g4005a62e65+17cd334064,g414038480c+5b5cd4fff3,g41af890bb2+4ffae9de63,g4e1a3235cc+0f1912dca3,g6249c6f860+3c3976f90c,g80478fca09+46aba80bd6,g82479be7b0+77990446f6,g858d7b2824+78ba4d1ce1,g89c8672015+f667a5183b,g9125e01d80+a8ce1bb630,ga5288a1d22+2a6264e9ca,gae0086650b+a8ce1bb630,gb58c049af0+d64f4d3760,gc22bb204ba+78ba4d1ce1,gc28159a63d+638fca75ac,gcf0d15dbbd+32ddb6096f,gd6b7c0dfd1+3e339405e9,gda3e153d99+78ba4d1ce1,gda6a2b7d83+32ddb6096f,gdaeeff99f8+1711a396fd,gdd5a9049c5+b18c39e5e3,ge2409df99d+a5e4577cdc,ge33fd446bb+78ba4d1ce1,ge79ae78c31+638fca75ac,gf0baf85859+64e8883e75,gf5289d68f6+e1b046a8d7,gfa443fc69c+91d9ed1ecf,gfda6b12a05+8419469a56
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
_convexPolygon.cc
Go to the documentation of this file.
1/*
2 * This file is part of sphgeom.
3 *
4 * Developed for the LSST Data Management System.
5 * This product includes software developed by the LSST Project
6 * (http://www.lsst.org).
7 * See the COPYRIGHT file at the top-level directory of this distribution
8 * for details of code ownership.
9 *
10 * This software is dual licensed under the GNU General Public License and also
11 * under a 3-clause BSD license. Recipients may choose which of these licenses
12 * to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
13 * respectively. If you choose the GPL option then the following text applies
14 * (but note that there is still no warranty even if you opt for BSD instead):
15 *
16 * This program is free software: you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation, either version 3 of the License, or
19 * (at your option) any later version.
20 *
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
25 *
26 * You should have received a copy of the GNU General Public License
27 * along with this program. If not, see <http://www.gnu.org/licenses/>.
28 */
29#include "pybind11/pybind11.h"
30#include "pybind11/stl.h"
31#include "pybind11/numpy.h"
32
33#include "lsst/sphgeom/python.h"
34
35#include "lsst/sphgeom/Box.h"
36#include "lsst/sphgeom/Box3d.h"
37#include "lsst/sphgeom/Circle.h"
41
44
45namespace py = pybind11;
46using namespace pybind11::literals;
47
48namespace lsst {
49namespace sphgeom {
50
51template <>
53 Region> &cls) {
54 cls.attr("TYPE_CODE") = py::int_(ConvexPolygon::TYPE_CODE);
55
56 cls.def_static("convexHull", &ConvexPolygon::convexHull, "points"_a);
57
58 cls.def(py::init<std::vector<UnitVector3d> const &>(), "points"_a);
59 // Do not wrap the two unsafe (3 and 4 vertex) constructors
60 cls.def(py::init<ConvexPolygon const &>(), "convexPolygon"_a);
61
62 cls.def("__eq__", &ConvexPolygon::operator==, py::is_operator());
63 cls.def("__ne__", &ConvexPolygon::operator!=, py::is_operator());
64
65 cls.def("getVertices", &ConvexPolygon::getVertices);
66 cls.def("getCentroid", &ConvexPolygon::getCentroid);
67
68 // Note that much of the Region interface has already been wrapped. Here are bits that have not:
69 // (include overloads from Region that would otherwise be shadowed).
70 cls.def("contains", py::overload_cast<UnitVector3d const &>(&ConvexPolygon::contains, py::const_));
71 cls.def("contains", py::overload_cast<Region const &>(&ConvexPolygon::contains, py::const_));
72 cls.def("contains",
73 py::vectorize((bool (ConvexPolygon::*)(double, double, double) const)&ConvexPolygon::contains),
74 "x"_a, "y"_a, "z"_a);
75 cls.def("contains",
76 py::vectorize((bool (ConvexPolygon::*)(double, double) const)&ConvexPolygon::contains),
77 "lon"_a, "lat"_a);
78 cls.def("isDisjointFrom", &ConvexPolygon::isDisjointFrom);
79 cls.def("intersects", &ConvexPolygon::intersects);
80 cls.def("isWithin", &ConvexPolygon::isWithin);
81
82 cls.def("__repr__", [](ConvexPolygon const &self) {
83 return py::str("ConvexPolygon({!r})").format(self.getVertices());
84 });
85 cls.def(py::pickle(&python::encode, &python::decode<ConvexPolygon>));
86}
87
88} // sphgeom
89} // lsst
This file declares a class for representing axis-aligned bounding boxes in ℝ³.
This file declares a class for representing circular regions on the unit sphere.
This file declares a class for representing convex polygons with great circle edges on the unit spher...
This file declares a class for representing unit vectors in ℝ³.
ConvexPolygon is a closed convex polygon on the unit sphere.
static constexpr std::uint8_t TYPE_CODE
bool intersects(Region const &r) const
UnitVector3d getCentroid() const
The centroid of a polygon is its center of mass projected onto S², assuming a uniform mass distributi...
bool contains(UnitVector3d const &v) const override
bool isDisjointFrom(Region const &r) const
static ConvexPolygon convexHull(std::vector< UnitVector3d > const &points)
convexHull returns the convex hull of the given set of points if it exists and throws an exception ot...
std::vector< UnitVector3d > const & getVertices() const
bool isWithin(Region const &r) const
Region is a minimal interface for 2-dimensional regions on the unit sphere.
Definition Region.h:87
std::unique_ptr< R > decode(pybind11::bytes bytes)
Decode a Region from a pybind11 bytes object.
Definition utils.h:69
pybind11::bytes encode(Region const &self)
Encode a Region as a pybind11 bytes object.
Definition utils.h:61
void defineClass(Pybind11Class &cls)
This file declares a class for representing longitude/latitude angle boxes on the unit sphere.
This file declares a class for representing elliptical regions on the unit sphere.