LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
_circle.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/numpy.h"
31
32#include "lsst/sphgeom/python.h"
33
34#include "lsst/sphgeom/Box.h"
35#include "lsst/sphgeom/Circle.h"
38#include "lsst/sphgeom/Region.h"
40
43
44namespace py = pybind11;
45using namespace pybind11::literals;
46
47namespace lsst {
48namespace sphgeom {
49
50template <>
52 cls.attr("TYPE_CODE") = py::int_(Circle::TYPE_CODE);
53
54 cls.def_static("empty", &Circle::empty);
55 cls.def_static("full", &Circle::full);
56 cls.def_static("squaredChordLengthFor", &Circle::squaredChordLengthFor,
57 "openingAngle"_a);
58 cls.def_static("openingAngleFor", &Circle::openingAngleFor,
59 "squaredChordLength"_a);
60
61 cls.def(py::init<>());
62 cls.def(py::init<UnitVector3d const &>(), "center"_a);
63 cls.def(py::init<UnitVector3d const &, Angle>(), "center"_a, "angle"_a);
64 cls.def(py::init<UnitVector3d const &, double>(), "center"_a,
65 "squaredChordLength"_a);
66 cls.def(py::init<Circle const &>(), "circle"_a);
67
68 cls.def("__eq__", &Circle::operator==, py::is_operator());
69 cls.def("__ne__", &Circle::operator!=, py::is_operator());
70 cls.def("__contains__",
71 (bool (Circle::*)(Circle const &) const) & Circle::contains,
72 py::is_operator());
73 // Rewrap this base class method since there are overloads in this subclass
74 cls.def("__contains__",
75 (bool (Circle::*)(UnitVector3d const &) const) & Circle::contains,
76 py::is_operator());
77
78 cls.def("isEmpty", &Circle::isEmpty);
79 cls.def("isFull", &Circle::isFull);
80 cls.def("getCenter", &Circle::getCenter);
81 cls.def("getSquaredChordLength", &Circle::getSquaredChordLength);
82 cls.def("getOpeningAngle", &Circle::getOpeningAngle);
83 cls.def("contains",
84 (bool (Circle::*)(Circle const &) const) & Circle::contains);
85 // Rewrap these base class methods since there are overloads in this subclass
86 cls.def("contains",
87 (bool (Circle::*)(UnitVector3d const &) const) & Circle::contains);
88 cls.def("contains", py::vectorize((bool (Circle::*)(double, double, double) const)&Circle::contains),
89 "x"_a, "y"_a, "z"_a);
90 cls.def("contains", py::vectorize((bool (Circle::*)(double, double) const)&Circle::contains),
91 "lon"_a, "lat"_a);
92
93 cls.def("isDisjointFrom",
94 (bool (Circle::*)(UnitVector3d const &) const) &
96 cls.def("isDisjointFrom",
97 (bool (Circle::*)(Circle const &) const) & Circle::isDisjointFrom);
98 cls.def("intersects",
99 (bool (Circle::*)(UnitVector3d const &) const) &
101 cls.def("intersects",
102 (bool (Circle::*)(Circle const &) const) & Circle::intersects);
103 cls.def("isWithin",
104 (bool (Circle::*)(UnitVector3d const &) const) & Circle::isWithin);
105 cls.def("isWithin",
106 (bool (Circle::*)(Circle const &) const) & Circle::isWithin);
107 cls.def("clipTo",
108 (Circle & (Circle::*)(UnitVector3d const &)) & Circle::clipTo);
109 cls.def("clipTo", (Circle & (Circle::*)(Circle const &)) & Circle::clipTo);
110 cls.def("clippedTo",
111 (Circle(Circle::*)(UnitVector3d const &) const) &
113 cls.def("clippedTo",
114 (Circle(Circle::*)(Circle const &) const) & Circle::clippedTo);
115 cls.def("expandTo",
116 (Circle & (Circle::*)(UnitVector3d const &)) & Circle::expandTo);
117 cls.def("expandTo",
118 (Circle & (Circle::*)(Circle const &)) & Circle::expandTo);
119 cls.def("expandedTo",
120 (Circle(Circle::*)(UnitVector3d const &) const) &
122 cls.def("expandedTo",
123 (Circle(Circle::*)(Circle const &) const) & Circle::expandedTo);
124 cls.def("dilateBy", &Circle::dilateBy, "radius"_a);
125 cls.def("dilatedBy", &Circle::dilatedBy, "radius"_a);
126 cls.def("erodeBy", &Circle::erodeBy, "radius"_a);
127 cls.def("erodedBy", &Circle::erodedBy, "radius"_a);
128 cls.def("getArea", &Circle::getArea);
129 cls.def("complement", &Circle::complement);
130 cls.def("complemented", &Circle::complemented);
131
132 // Note that the Region interface has already been wrapped.
133
134 cls.def("__str__", [](Circle const &self) {
135 return py::str("Circle({!s}, {!s})")
136 .format(self.getCenter(), self.getOpeningAngle());
137 });
138 cls.def("__repr__", [](Circle const &self) {
139 return py::str("Circle({!r}, {!r})")
140 .format(self.getCenter(), self.getOpeningAngle());
141 });
142 cls.def(py::pickle(&python::encode, &python::decode<Circle>));
143}
144
145} // sphgeom
146} // lsst
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 defines an interface for spherical regions.
This file declares a class for representing unit vectors in ℝ³.
Circle is a circular region on the unit sphere that contains its boundary.
Definition Circle.h:53
bool contains(Circle const &x) const
contains returns true if the intersection of this circle and x is equal to x.
Definition Circle.cc:71
static Angle openingAngleFor(double squaredChordLength)
openingAngleFor computes and returns the angular separation between points in S² that are separated b...
Definition Circle.cc:59
bool isEmpty() const
Definition Circle.h:116
static Circle empty()
Definition Circle.h:57
Circle clippedTo(UnitVector3d const &x) const
Definition Circle.h:172
Circle & clipTo(UnitVector3d const &x)
Definition Circle.cc:98
double getArea() const
getArea returns the area of this circle in steradians.
Definition Circle.h:212
Circle & dilateBy(Angle r)
If r is positive, dilateBy increases the opening angle of this circle to include all points within an...
Definition Circle.cc:194
static Circle full()
Definition Circle.h:59
bool isWithin(UnitVector3d const &) const
Definition Circle.h:158
Circle expandedTo(UnitVector3d const &x) const
Definition Circle.h:190
bool isFull() const
Definition Circle.h:121
Circle dilatedBy(Angle r) const
Definition Circle.h:207
bool isDisjointFrom(UnitVector3d const &x) const
Definition Circle.h:144
Circle & erodeBy(Angle r)
Definition Circle.h:208
double getSquaredChordLength() const
getSquaredChordLength returns the squared length of chords between the circle center and points on th...
Definition Circle.h:130
Angle getOpeningAngle() const
getOpeningAngle returns the opening angle of this circle - that is, the angle between its center vect...
Definition Circle.h:135
UnitVector3d const & getCenter() const
getCenter returns the center of this circle as a unit vector.
Definition Circle.h:125
bool intersects(UnitVector3d const &x) const
Definition Circle.h:151
Circle & complement()
complement sets this circle to the closure of its complement.
Definition Circle.cc:204
Circle & expandTo(UnitVector3d const &x)
Definition Circle.cc:130
static double squaredChordLengthFor(Angle openingAngle)
squaredChordLengthFor computes and returns the squared chord length between points in S² that are sep...
Definition Circle.cc:48
Circle complemented() const
complemented returns the closure of the complement of this circle.
Definition Circle.h:224
static constexpr uint8_t TYPE_CODE
Definition Circle.h:55
Circle erodedBy(Angle r) const
Definition Circle.h:209
Region is a minimal interface for 2-dimensional regions on the unit sphere.
Definition Region.h:86
UnitVector3d is a unit vector in ℝ³ with components stored in double precision.
pybind11::bytes encode(Region const &self)
Encode a Region as a pybind11 bytes object.
Definition utils.h:60
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.