LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
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 <>
51void defineClass(py::classh<Circle, Region> &cls) {
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("isFull", &Circle::isFull);
79 cls.def("getCenter", &Circle::getCenter);
80 cls.def("getSquaredChordLength", &Circle::getSquaredChordLength);
81 cls.def("getOpeningAngle", &Circle::getOpeningAngle);
82 cls.def("contains",
83 (bool (Circle::*)(Circle const &) const) & Circle::contains);
84 // Rewrap these base class methods since there are overloads in this subclass
85 cls.def("contains",
86 (bool (Circle::*)(UnitVector3d const &) const) & Circle::contains);
87 cls.def("contains", py::vectorize((bool (Circle::*)(double, double, double) const)&Circle::contains),
88 "x"_a, "y"_a, "z"_a);
89 cls.def("contains", py::vectorize((bool (Circle::*)(double, double) const)&Circle::contains),
90 "lon"_a, "lat"_a);
91
92 cls.def("isDisjointFrom",
93 (bool (Circle::*)(UnitVector3d const &) const) &
95 cls.def("isDisjointFrom",
96 (bool (Circle::*)(Circle const &) const) & Circle::isDisjointFrom);
97 cls.def("intersects",
98 (bool (Circle::*)(UnitVector3d const &) const) &
100 cls.def("intersects",
101 (bool (Circle::*)(Circle const &) const) & Circle::intersects);
102 cls.def("isWithin",
103 (bool (Circle::*)(UnitVector3d const &) const) & Circle::isWithin);
104 cls.def("isWithin",
105 (bool (Circle::*)(Circle const &) const) & Circle::isWithin);
106 cls.def("clipTo",
107 (Circle & (Circle::*)(UnitVector3d const &)) & Circle::clipTo);
108 cls.def("clipTo", (Circle & (Circle::*)(Circle const &)) & Circle::clipTo);
109 cls.def("clippedTo",
110 (Circle(Circle::*)(UnitVector3d const &) const) &
112 cls.def("clippedTo",
113 (Circle(Circle::*)(Circle const &) const) & Circle::clippedTo);
114 cls.def("expandTo",
115 (Circle & (Circle::*)(UnitVector3d const &)) & Circle::expandTo);
116 cls.def("expandTo",
117 (Circle & (Circle::*)(Circle const &)) & Circle::expandTo);
118 cls.def("expandedTo",
119 (Circle(Circle::*)(UnitVector3d const &) const) &
121 cls.def("expandedTo",
122 (Circle(Circle::*)(Circle const &) const) & Circle::expandedTo);
123 cls.def("dilateBy", &Circle::dilateBy, "radius"_a);
124 cls.def("dilatedBy", &Circle::dilatedBy, "radius"_a);
125 cls.def("erodeBy", &Circle::erodeBy, "radius"_a);
126 cls.def("erodedBy", &Circle::erodedBy, "radius"_a);
127 cls.def("getArea", &Circle::getArea);
128 cls.def("complement", &Circle::complement);
129 cls.def("complemented", &Circle::complemented);
130
131 // Note that the Region interface has already been wrapped.
132
133 cls.def("__str__", [](Circle const &self) {
134 return py::str("Circle({!s}, {!s})")
135 .format(self.getCenter(), self.getOpeningAngle());
136 });
137 cls.def("__repr__", [](Circle const &self) {
138 return py::str("Circle({!r}, {!r})")
139 .format(self.getCenter(), self.getOpeningAngle());
140 });
141 cls.def(py::pickle(&python::encode, &python::decode<Circle>));
142}
143
144} // sphgeom
145} // 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:54
static constexpr std::uint8_t TYPE_CODE
Definition Circle.h:56
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
static Circle empty()
Definition Circle.h:58
Circle clippedTo(UnitVector3d const &x) const
Definition Circle.h:173
Circle & clipTo(UnitVector3d const &x)
Definition Circle.cc:98
double getArea() const
getArea returns the area of this circle in steradians.
Definition Circle.h:213
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:60
bool isWithin(UnitVector3d const &) const
Definition Circle.h:159
Circle expandedTo(UnitVector3d const &x) const
Definition Circle.h:191
bool isFull() const
Definition Circle.h:122
Circle dilatedBy(Angle r) const
Definition Circle.h:208
bool isDisjointFrom(UnitVector3d const &x) const
Definition Circle.h:145
Circle & erodeBy(Angle r)
Definition Circle.h:209
double getSquaredChordLength() const
getSquaredChordLength returns the squared length of chords between the circle center and points on th...
Definition Circle.h:131
Angle getOpeningAngle() const
getOpeningAngle returns the opening angle of this circle - that is, the angle between its center vect...
Definition Circle.h:136
UnitVector3d const & getCenter() const
getCenter returns the center of this circle as a unit vector.
Definition Circle.h:126
bool intersects(UnitVector3d const &x) const
Definition Circle.h:152
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:225
Circle erodedBy(Angle r) const
Definition Circle.h:210
UnitVector3d is a unit vector in ℝ³ with components stored in double precision.
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.