LSST Applications g1653933729+34a971ddd9,g28da252d5a+6ecf39ab43,g2bbee38e9b+7117419c07,g2bc492864f+7117419c07,g2cdde0e794+704103fe75,g3156d2b45e+6e87dc994a,g347aa1857d+7117419c07,g35bb328faa+34a971ddd9,g3a166c0a6a+7117419c07,g3e281a1b8c+8ec26ec694,g4005a62e65+ba0306790b,g414038480c+40f8eb5d96,g569e0e2b34+d8e684fe9f,g717e5f8c0f+b9f74a9651,g76fe02a360+28e3f83f63,g80478fca09+fdb1f299e2,g82479be7b0+2fffa722b6,g858d7b2824+b9f74a9651,g8b782ad322+b9f74a9651,g8cd86fa7b1+ed49507c07,g90e5cb8612+3a7ace1691,g9125e01d80+34a971ddd9,g979bb04a14+232ddb636d,g9a700aaafa+34a971ddd9,ga5288a1d22+3504ff4bc9,gae0086650b+34a971ddd9,gae74b0b5c6+761ee125be,gb3d89ef091+14ce01cc3a,gb58c049af0+ace264a4f2,gc28159a63d+7117419c07,gcf0d15dbbd+34f38ce56c,gda6a2b7d83+34f38ce56c,gdaeeff99f8+7774323b41,ge33fd446bb+b9f74a9651,ge5cf12406b+d328917b0a,ge79ae78c31+7117419c07,gf0baf85859+890af219f9,gf5289d68f6+fe3ed47e0d,w.2024.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
_box.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
35#include "lsst/sphgeom/Box.h"
36#include "lsst/sphgeom/Box3d.h"
37#include "lsst/sphgeom/Circle.h"
40#include "lsst/sphgeom/LonLat.h"
42#include "lsst/sphgeom/Region.h"
44
47
48namespace py = pybind11;
49using namespace pybind11::literals;
50
51namespace lsst {
52namespace sphgeom {
53
54template <>
55void defineClass(py::class_<Box, std::unique_ptr<Box>, Region> &cls) {
56 cls.attr("TYPE_CODE") = py::int_(Box::TYPE_CODE);
57
58 cls.def_static("fromDegrees", &Box::fromDegrees, "lon1"_a, "lat1"_a,
59 "lon2"_a, "lat2"_a);
60 cls.def_static("fromRadians", &Box::fromRadians, "lon1"_a, "lat1"_a,
61 "lon2"_a, "lat2"_a);
62 cls.def_static("empty", &Box::empty);
63 cls.def_static("full", &Box::full);
64 cls.def_static("halfWidthForCircle", &Box::halfWidthForCircle, "radius"_a,
65 "lat"_a);
66 cls.def_static("allLongitudes", &Box::allLongitudes);
67 cls.def_static("allLatitudes", &Box::allLatitudes);
68
69 cls.def(py::init<>());
70 cls.def(py::init<LonLat const &>(), "point"_a);
71 cls.def(py::init<LonLat const &, LonLat const &>(), "point1"_a, "point2"_a);
72 cls.def(py::init<LonLat const &, Angle, Angle>(), "center"_a, "width"_a,
73 "height"_a);
74 cls.def(py::init<NormalizedAngleInterval const &, AngleInterval const &>(),
75 "lon"_a, "lat"_a);
76 cls.def(py::init<Box const &>(), "box"_a);
77
78 cls.def("__eq__", (bool (Box::*)(Box const &) const) & Box::operator==,
79 py::is_operator());
80 cls.def("__eq__", (bool (Box::*)(LonLat const &) const) & Box::operator==,
81 py::is_operator());
82 cls.def("__ne__", (bool (Box::*)(Box const &) const) & Box::operator!=,
83 py::is_operator());
84 cls.def("__ne__", (bool (Box::*)(LonLat const &) const) & Box::operator!=,
85 py::is_operator());
86 cls.def("__contains__",
87 (bool (Box::*)(LonLat const &) const) & Box::contains,
88 py::is_operator());
89 cls.def("__contains__", (bool (Box::*)(Box const &) const) & Box::contains,
90 py::is_operator());
91 // Rewrap this base class method since there are overloads in this subclass
92 cls.def("__contains__",
93 (bool (Box::*)(UnitVector3d const &) const) & Box::contains,
94 py::is_operator());
95
96 cls.def("getLon", &Box::getLon);
97 cls.def("getLat", &Box::getLat);
98 cls.def("isEmpty", &Box::isEmpty);
99 cls.def("isFull", &Box::isFull);
100 cls.def("getCenter", &Box::getCenter);
101 cls.def("getWidth", &Box::getWidth);
102 cls.def("getHeight", &Box::getHeight);
103 cls.def("contains", (bool (Box::*)(LonLat const &) const) & Box::contains);
104 cls.def("contains", (bool (Box::*)(Box const &) const) & Box::contains);
105 // Rewrap these base class methods since there are overloads in this subclass
106 cls.def("contains",
107 (bool (Box::*)(UnitVector3d const &) const) & Box::contains);
108 cls.def("contains", py::vectorize((bool (Box::*)(double, double, double) const)&Box::contains),
109 "x"_a, "y"_a, "z"_a);
110 cls.def("contains", py::vectorize((bool (Box::*)(double, double) const)&Box::contains),
111 "lon"_a, "lat"_a);
112 cls.def("isDisjointFrom",
113 (bool (Box::*)(LonLat const &) const) & Box::isDisjointFrom);
114 cls.def("isDisjointFrom",
115 (bool (Box::*)(Box const &) const) & Box::isDisjointFrom);
116 cls.def("intersects",
117 (bool (Box::*)(LonLat const &) const) & Box::intersects);
118 cls.def("intersects", (bool (Box::*)(Box const &) const) & Box::intersects);
119 cls.def("isWithin", (bool (Box::*)(LonLat const &) const) & Box::isWithin);
120 cls.def("isWithin", (bool (Box::*)(Box const &) const) & Box::isWithin);
121 cls.def("clipTo", (Box & (Box::*)(LonLat const &)) & Box::clipTo);
122 cls.def("clipTo", (Box & (Box::*)(Box const &)) & Box::clipTo);
123 cls.def("clippedTo", (Box(Box::*)(LonLat const &) const) & Box::clippedTo);
124 cls.def("clippedTo", (Box(Box::*)(Box const &) const) & Box::clippedTo);
125 cls.def("expandTo", (Box & (Box::*)(LonLat const &)) & Box::expandTo);
126 cls.def("expandTo", (Box & (Box::*)(Box const &)) & Box::expandTo);
127 cls.def("expandedTo",
128 (Box(Box::*)(LonLat const &) const) & Box::expandedTo);
129 cls.def("expandedTo", (Box(Box::*)(Box const &) const) & Box::expandedTo);
130 cls.def("dilateBy", (Box & (Box::*)(Angle)) & Box::dilateBy, "angle"_a);
131 cls.def("dilateBy", (Box & (Box::*)(Angle, Angle)) & Box::dilateBy,
132 "width"_a, "height"_a);
133 cls.def("dilatedBy", (Box(Box::*)(Angle) const) & Box::dilatedBy,
134 "angle"_a);
135 cls.def("dilatedBy", (Box(Box::*)(Angle, Angle) const) & Box::dilatedBy,
136 "width"_a, "height"_a);
137 cls.def("erodeBy", (Box & (Box::*)(Angle)) & Box::erodeBy, "angle"_a);
138 cls.def("erodeBy", (Box & (Box::*)(Angle, Angle)) & Box::erodeBy, "width"_a,
139 "height"_a);
140 cls.def("erodedBy", (Box(Box::*)(Angle) const) & Box::erodedBy, "angle"_a);
141 cls.def("erodedBy", (Box(Box::*)(Angle, Angle) const) & Box::erodedBy,
142 "width"_a, "height"_a);
143 cls.def("getArea", &Box::getArea);
144 cls.def("relate",
145 (Relationship(Box::*)(LonLat const &) const) & Box::relate,
146 "point"_a);
147 // Rewrap this base class method since there are overloads in this subclass
148 cls.def("relate",
149 (Relationship(Box::*)(Region const &) const) & Box::relate,
150 "region"_a);
151
152 // Note that the Region interface has already been wrapped.
153
154 cls.def("__str__", [](Box const &self) {
155 return py::str("Box({!s}, {!s})").format(self.getLon(), self.getLat());
156 });
157 cls.def("__repr__", [](Box const &self) {
158 return py::str("Box({!r}, {!r})").format(self.getLon(), self.getLat());
159 });
160 cls.def(py::pickle(&python::encode, &python::decode<Box>));
161}
162
163} // sphgeom
164} // lsst
This file defines a class for representing angle intervals.
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 contains a class representing spherical coordinates.
This file declares a class representing closed intervals of normalized angles, i.e.
This file defines an interface for spherical regions.
This file declares a class for representing unit vectors in ℝ³.
Angle represents an angle in radians.
Definition Angle.h:50
Box represents a rectangle in spherical coordinate space that contains its boundary.
Definition Box.h:62
Box clippedTo(LonLat const &x) const
clippedTo returns the intersection of this box and x.
Definition Box.h:243
AngleInterval const & getLat() const
getLat returns the latitude interval of this box.
Definition Box.h:156
Box dilatedBy(Angle r) const
Definition Box.h:281
static NormalizedAngle halfWidthForCircle(Angle r, Angle lat)
halfWidthForCircle computes the half-width of bounding boxes for circles with radius r and centers at...
Definition Box.cc:50
Box & erodeBy(Angle r)
Definition Box.h:300
NormalizedAngle getWidth() const
getWidth returns the width in longitude angle of this box.
Definition Box.h:173
double getArea() const
getArea returns the area of this box in steradians.
Definition Box.cc:122
static Box fromRadians(double lon1, double lat1, double lon2, double lat2)
Definition Box.h:72
Box expandedTo(LonLat const &x) const
Definition Box.h:271
NormalizedAngleInterval const & getLon() const
getLon returns the longitude interval of this box.
Definition Box.h:153
Relationship relate(LonLat const &p) const
Definition Box.h:305
bool isDisjointFrom(LonLat const &x) const
Definition Box.h:194
static constexpr std::uint8_t TYPE_CODE
Definition Box.h:64
static Box empty()
Definition Box.h:77
bool isFull() const
isFull returns true if this box contains all points on the unit sphere.
Definition Box.h:163
Box & dilateBy(Angle r)
dilateBy minimally expands this Box to include all points within angular separation r of its boundary...
Definition Box.cc:85
Angle getHeight() const
getHeight returns the height in latitude angle of this box.
Definition Box.h:177
LonLat getCenter() const
getCenter returns the center of this box.
Definition Box.h:167
static NormalizedAngleInterval allLongitudes()
allLongitudes returns a normalized angle interval containing all valid longitude angles.
Definition Box.h:89
bool isWithin(LonLat const &x) const
Definition Box.h:214
Box erodedBy(Angle r) const
Definition Box.h:302
Box & expandTo(LonLat const &x)
Definition Box.h:254
static AngleInterval allLatitudes()
allLatitudes returns an angle interval containing all valid latitude angles.
Definition Box.h:95
bool contains(LonLat const &x) const
Definition Box.h:182
static Box fromDegrees(double lon1, double lat1, double lon2, double lat2)
Definition Box.h:67
bool isEmpty() const
isEmpty returns true if this box does not contain any points.
Definition Box.h:159
Box & clipTo(LonLat const &x)
clipTo shrinks this box until it contains only x.
Definition Box.h:225
static Box full()
Definition Box.h:79
bool intersects(LonLat const &x) const
Definition Box.h:202
LonLat represents a spherical coordinate (longitude/latitude angle) pair.
Definition LonLat.h:55
Region is a minimal interface for 2-dimensional regions on the unit sphere.
Definition Region.h:87
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:61
void defineClass(Pybind11Class &cls)
std::bitset< 3 > Relationship
Relationship describes how two sets are related.
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.