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
_unitVector3d.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
31#include "lsst/sphgeom/python.h"
32
33#include "lsst/sphgeom/Angle.h"
34#include "lsst/sphgeom/LonLat.h"
38
39namespace py = pybind11;
40using namespace pybind11::literals;
41
42namespace lsst {
43namespace sphgeom {
44
45template <>
46void defineClass(py::classh<UnitVector3d> &cls) {
47 // Provide the equivalent of the UnitVector3d to Vector3d C++ cast
48 // operator in Python
49 py::implicitly_convertible<UnitVector3d, Vector3d>();
50
51 cls.def_static(
52 "orthogonalTo",
54 "vector"_a);
55 cls.def_static("orthogonalTo",
56 (UnitVector3d(*)(Vector3d const &, Vector3d const &)) &
58 "vector1"_a, "vector2"_a);
59 cls.def_static("orthogonalTo",
60 (UnitVector3d(*)(NormalizedAngle const &)) &
62 "meridian"_a);
63 cls.def_static("northFrom", &UnitVector3d::northFrom, "vector"_a);
64 cls.def_static("X", &UnitVector3d::X);
65 cls.def_static("Y", &UnitVector3d::Y);
66 cls.def_static("Z", &UnitVector3d::Z);
67 // The fromNormalized static factory functions are not exposed to
68 // Python, as they are easy to misuse and intended only for performance
69 // critical code (i.e. not Python).
70
71 cls.def(py::init<>());
72 cls.def(py::init<UnitVector3d const &>(), "unitVector"_a);
73 cls.def(py::init<Vector3d const &>(), "vector"_a);
74 cls.def(py::init<double, double, double>(), "x"_a, "y"_a, "z"_a);
75 cls.def(py::init<LonLat const &>(), "lonLat"_a);
76 cls.def(py::init<Angle, Angle>(), "lon"_a, "lat"_a);
77
78 cls.def("__eq__", &UnitVector3d::operator==, py::is_operator());
79 cls.def("__ne__", &UnitVector3d::operator!=, py::is_operator());
80 cls.def("__neg__",
81 (UnitVector3d(UnitVector3d::*)() const) & UnitVector3d::operator-);
82 cls.def("__add__", &UnitVector3d::operator+, py::is_operator());
83 cls.def("__sub__",
84 (Vector3d(UnitVector3d::*)(Vector3d const &) const) &
85 UnitVector3d::operator-,
86 py::is_operator());
87 cls.def("__mul__", &UnitVector3d::operator*, py::is_operator());
88 cls.def("__truediv__", &UnitVector3d::operator/, py::is_operator());
89
90 cls.def("x", &UnitVector3d::x);
91 cls.def("y", &UnitVector3d::y);
92 cls.def("z", &UnitVector3d::z);
93 cls.def("x", &UnitVector3d::dot);
94 cls.def("dot", &UnitVector3d::dot);
95 cls.def("cross", &UnitVector3d::cross);
96 cls.def("robustCross", &UnitVector3d::robustCross);
97 cls.def("cwiseProduct", &UnitVector3d::cwiseProduct);
98 cls.def("rotatedAround", &UnitVector3d::rotatedAround, "axis"_a, "angle"_a);
99
100 cls.def("__len__", [](UnitVector3d const &self) { return py::int_(3); });
101 cls.def("__getitem__", [](UnitVector3d const &self, py::int_ i) {
102 return self(python::convertIndex(3, i));
103 });
104
105 cls.def("__str__", [](UnitVector3d const &self) {
106 return py::str("[{!s}, {!s}, {!s}]")
107 .format(self.x(), self.y(), self.z());
108 });
109 cls.def("__repr__", [](UnitVector3d const &self) {
110 return py::str("UnitVector3d({!r}, {!r}, {!r})")
111 .format(self.x(), self.y(), self.z());
112 });
113
114 // Do not implement __reduce__ for pickling. Why? Given:
115 //
116 // u = UnitVector3d(x, y, z)
117 // v = UnitVector3d(u.x(), u.y(), u.z())
118 //
119 // u may not be identical to v, since the constructor normalizes its input
120 // components. Furthermore, UnitVector3d::fromNormalized is not visible to
121 // Python, and even if it were, pybind11 is currently incapable of returning
122 // a picklable reference to it.
123 cls.def(py::pickle([](UnitVector3d const &self) { return py::make_tuple(self.x(), self.y(), self.z()); },
124 [](py::tuple t) {
125 if (t.size() != 3) {
126 throw std::runtime_error("Tuple size = " + std::to_string(t.size()) +
127 "; must be 3 for a UnitVector3d");
128 }
130 t[0].cast<double>(), t[1].cast<double>(), t[2].cast<double>()));
131 }));
132}
133
134} // sphgeom
135} // 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 ℝ³.
NormalizedAngle is an angle that lies in the range [0, 2π), with one exception - a NormalizedAngle ca...
UnitVector3d is a unit vector in ℝ³ with components stored in double precision.
static UnitVector3d Z()
double dot(Vector3d const &v) const
dot returns the inner product of this unit vector and v.
Vector3d robustCross(UnitVector3d const &v) const
a.robustCross(b) is (b + a).cross(b - a) - twice the cross product of a and b.
Vector3d cwiseProduct(Vector3d const &v) const
cwiseProduct returns the component-wise product of this unit vector and v.
static UnitVector3d fromNormalized(Vector3d const &v)
fromNormalized returns the unit vector equal to v, which is assumed to be normalized.
UnitVector3d rotatedAround(UnitVector3d const &k, Angle a) const
rotatedAround returns a copy of this unit vector, rotated around the unit vector k by angle a accordi...
static UnitVector3d Y()
static UnitVector3d X()
static UnitVector3d orthogonalTo(Vector3d const &v)
orthogonalTo returns an arbitrary unit vector that is orthogonal to v.
Vector3d cross(Vector3d const &v) const
cross returns the cross product of this unit vector and v.
static UnitVector3d northFrom(Vector3d const &v)
northFrom returns the unit vector orthogonal to v that points "north" from v.
Vector3d is a vector in ℝ³ with components stored in double precision.
Definition Vector3d.h:51
ptrdiff_t convertIndex(ptrdiff_t len, pybind11::int_ i)
Convert a Python index i over a sequence with length len to a non-negative (C++ style) index,...
Definition utils.h:48
void defineClass(Pybind11Class &cls)
This file declares a class for representing angles.
T to_string(T... args)