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
_SpherePoint.cc
Go to the documentation of this file.
1/*
2 * Developed for the LSST Data Management System.
3 * This product includes software developed by the LSST Project
4 * (https://www.lsst.org).
5 * See the COPYRIGHT file at the top-level directory of this distribution
6 * for details of code ownership.
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 GNU General Public License
19 * along with this program. If not, see <https://www.gnu.org/licenses/>.
20 */
21
22#include "pybind11/pybind11.h"
23#include "pybind11/stl.h"
24#include "pybind11/numpy.h"
25
26#include <cmath>
27#include <memory>
28
32#include "lsst/sphgeom/LonLat.h"
33#include "lsst/geom/Angle.h"
34#include "lsst/geom/Point.h"
36
37namespace py = pybind11;
38using namespace py::literals;
39
40namespace lsst {
41namespace geom {
42
43namespace {
44
45double toUnitX(double longitude, double latitude) {
47}
48
49double toUnitY(double longitude, double latitude) {
51}
52
53double toUnitZ(double longitude, double latitude) {
54 return std::sin(latitude);
55}
56
57} // anonymous
58
59
60using PySpherePoint = py::class_<SpherePoint, std::shared_ptr<SpherePoint>>;
61
63 wrappers.addSignatureDependency("lsst.sphgeom");
64 wrappers.wrapType(
65 PySpherePoint(wrappers.module, "SpherePoint"),
66 [](auto & mod, auto & cls) mutable {
67 /* Constructors */
68 cls.def(py::init<>());
69 cls.def(py::init<Angle const &, Angle const &>(), "longitude"_a, "latitude"_a);
70 cls.def(py::init<double, double, AngleUnit>(), "longitude"_a, "latitude"_a, "units"_a);
71 cls.def(py::init<sphgeom::Vector3d const &>(), "vector"_a);
72 cls.def(py::init<sphgeom::UnitVector3d const &>(), "unitVector"_a);
73 cls.def(py::init<sphgeom::LonLat const &>(), "lonLat"_a);
74 cls.def(py::init<SpherePoint const &>(), "other"_a);
75 py::implicitly_convertible<SpherePoint, sphgeom::LonLat>();
76 py::implicitly_convertible<sphgeom::LonLat, SpherePoint>();
77
78 /* Operators */
79 cls.def("__getitem__",
80 [](SpherePoint const &self, std::ptrdiff_t i) {
81 return self[cpputils::python::cppIndex(2, i)];
82 });
83 cls.def("__eq__", &SpherePoint::operator==, py::is_operator());
84 cls.def("__ne__", &SpherePoint::operator!=, py::is_operator());
85
86 /* Members */
87 cls.def("getLongitude", &SpherePoint::getLongitude);
88 cls.def("getLatitude", &SpherePoint::getLatitude);
89 cls.def("getRa", &SpherePoint::getRa);
90 cls.def("getDec", &SpherePoint::getDec);
91 cls.def("getVector", &SpherePoint::getVector);
92 cls.def("getPosition", &SpherePoint::getPosition, "units"_a);
93 cls.def("atPole", &SpherePoint::atPole);
94 cls.def("isFinite", &SpherePoint::isFinite);
95 cls.def("bearingTo", &SpherePoint::bearingTo, "other"_a);
96 cls.def("separation", &SpherePoint::separation, "other"_a);
97 cls.def("rotated", &SpherePoint::rotated, "axis"_a, "amount"_a);
98 cls.def("offset", &SpherePoint::offset, "bearing"_a, "amount"_a);
99 cls.def("getTangentPlaneOffset", &SpherePoint::getTangentPlaneOffset, "other"_a);
100 cpputils::python::addOutputOp(cls, "__str__");
101 cls.def("__len__", [](SpherePoint const &) { return 2; });
102 cls.def("__reduce__", [cls](SpherePoint const &self) {
103 return py::make_tuple(cls, py::make_tuple(py::cast(self.getLongitude()),
104 py::cast(self.getLatitude())));
105 });
106
107
108 /* Module level */
109 mod.def("averageSpherePoint", averageSpherePoint);
110
111 // Used only by pure-Python extension toUnitXYZ in _SpherePoint.py.
112 mod.def("_toUnitX", py::vectorize(&toUnitX), "longitude"_a, "latitude"_a);
113 mod.def("_toUnitY", py::vectorize(&toUnitY), "longitude"_a, "latitude"_a);
114 mod.def("_toUnitZ", py::vectorize(&toUnitZ), "longitude"_a, "latitude"_a);
115 }
116 );
117}
118
119} // namespace geom
120} // namespace lsst
This file contains a class representing spherical coordinates.
This file declares a class for representing unit vectors in ℝ³.
This file declares a class for representing vectors in ℝ³.
table::Key< lsst::geom::Angle > longitude
Definition VisitInfo.cc:215
table::Key< lsst::geom::Angle > latitude
Definition VisitInfo.cc:214
A helper class for subdividing pybind11 module across multiple translation units (i....
Definition python.h:242
void addSignatureDependency(std::string const &name)
Indicate an external module that provides a type used in function/method signatures.
Definition python.h:357
PyType wrapType(PyType cls, ClassWrapperCallback function, bool setModuleName=true)
Add a type (class or enum) wrapper, deferring method and other attribute definitions until finish() i...
Definition python.h:391
pybind11::module module
The module object passed to the PYBIND11_MODULE block that contains this WrapperCollection.
Definition python.h:448
Point in an unspecified spherical coordinate system.
Definition SpherePoint.h:57
std::pair< Angle, Angle > getTangentPlaneOffset(SpherePoint const &other) const
Get the offset from a tangent plane centered at this point to another point.
SpherePoint offset(Angle const &bearing, Angle const &amount) const
Return a point offset from this one along a great circle.
bool isFinite() const noexcept
true if this point is a well-defined position.
Point2D getPosition(AngleUnit unit) const noexcept
Return longitude, latitude as a Point2D object.
Angle bearingTo(SpherePoint const &other) const
Orientation at this point of the great circle arc to another point.
bool atPole() const noexcept
true if this point is either coordinate pole.
Angle separation(SpherePoint const &other) const noexcept
Angular distance between two points.
sphgeom::UnitVector3d getVector() const noexcept
A unit vector representation of this point.
Angle getLatitude() const noexcept
The latitude of this point.
Angle getLongitude() const noexcept
The longitude of this point.
SpherePoint rotated(SpherePoint const &axis, Angle const &amount) const noexcept
Return a point rotated from this one around an axis.
Angle getDec() const noexcept
Synonym for getLatitude.
Angle getRa() const noexcept
Synonym for getLongitude.
T cos(T... args)
void addOutputOp(PyClass &cls, std::string const &method)
Add __str__ or __repr__ method implemented by operator<<.
Definition python.h:87
py::class_< SpherePoint, std::shared_ptr< SpherePoint > > PySpherePoint
void wrapSpherePoint(WrapperCollection &wrappers)
T sin(T... args)