lsst.sphgeom 22.0.1-8-gfb2c8f9+1b4e7dc7c0
UnitVector3d.h
Go to the documentation of this file.
1/*
2 * LSST Data Management System
3 * Copyright 2014-2015 AURA/LSST.
4 *
5 * This product includes software developed by the
6 * LSST Project (http://www.lsst.org/).
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 LSST License Statement and
19 * the GNU General Public License along with this program. If not,
20 * see <https://www.lsstcorp.org/LegalNotices/>.
21 */
22
23#ifndef LSST_SPHGEOM_UNITVECTOR3D_H_
24#define LSST_SPHGEOM_UNITVECTOR3D_H_
25
28
29#include "LonLat.h"
30#include "Vector3d.h"
31
32
33namespace lsst {
34namespace sphgeom {
35
56public:
59 static UnitVector3d orthogonalTo(Vector3d const & v);
60
65 static UnitVector3d orthogonalTo(Vector3d const & v1, Vector3d const & v2);
66
72 static UnitVector3d northFrom(Vector3d const & v);
73
77 UnitVector3d u; u._v = Vector3d(-sin(a), cos(a), 0.0); return u;
78 }
79
83 UnitVector3d u; u._v = v; return u;
84 }
85
89 static UnitVector3d fromNormalized(double x, double y, double z) {
90 UnitVector3d u; u._v = Vector3d(x, y, z); return u;
91 }
92
93 static UnitVector3d X() {
94 return UnitVector3d();
95 }
96
97 static UnitVector3d Y() {
98 UnitVector3d u; u._v = Vector3d(0.0, 1.0, 0.0); return u;
99 }
100
101 static UnitVector3d Z() {
102 UnitVector3d u; u._v = Vector3d(0.0, 0.0, 1.0); return u;
103 }
104
106 UnitVector3d() : _v(1.0, 0.0, 0.0) {}
107
108 UnitVector3d(UnitVector3d const &v) = default;
109
112 explicit UnitVector3d(Vector3d const & v) : _v(v) {
113 _v.normalize();
114 }
115
116 UnitVector3d(double x, double y, double z) : _v(x, y, z) {
117 _v.normalize();
118 }
120
123 explicit UnitVector3d(LonLat const & p) {
124 *this = UnitVector3d(p.getLon(), p.getLat());
125 }
126
129 UnitVector3d(Angle lon, Angle lat);
130
134 operator Vector3d const & () const { return _v; }
135
136 bool operator==(Vector3d const & v) const { return _v == v; }
137 bool operator!=(Vector3d const & v) const { return _v != v; }
138
140 double const * getData() const { return _v.getData(); }
141
143 double operator()(int i) const { return _v(i); }
144
145 double x() const { return _v.x(); }
146
147 double y() const { return _v.y(); }
148
149 double z() const { return _v.z(); }
150
152 double dot(Vector3d const & v) const { return _v.dot(v); }
153
155 Vector3d cross(Vector3d const & v) const { return _v.cross(v); }
156
162 return (v + *this).cross(v - *this);
163 }
164
167 UnitVector3d u; u._v = -_v; return u;
168 }
169
172 Vector3d operator*(double s) const { return _v * s; }
173
176 Vector3d operator/(double s) const { return _v / s; }
177
179 Vector3d operator+(Vector3d const & v) const { return _v + v; }
180
183 Vector3d operator-(Vector3d const & v) const { return _v - v; }
184
187 Vector3d cwiseProduct(Vector3d const & v) const {
188 return _v.cwiseProduct(v);
189 }
190
194 return UnitVector3d(_v.rotatedAround(k, a));
195 }
196
197private:
198 Vector3d _v;
199};
200
201
202std::ostream & operator<<(std::ostream &, UnitVector3d const &);
203
204}} // namespace lsst::sphgeom
205
206#endif // LSST_SPHGEOM_UNITVECTOR3D_H_
This file contains a class representing spherical coordinates.
This file declares a class for representing vectors in ℝ³.
Definition: Angle.h:43
Definition: LonLat.h:48
Definition: NormalizedAngle.h:43
Definition: UnitVector3d.h:55
double dot(Vector3d const &v) const
dot returns the inner product of this unit vector and v.
Definition: UnitVector3d.h:152
UnitVector3d operator-() const
The unary minus operator negates every component of this unit vector.
Definition: UnitVector3d.h:166
Vector3d robustCross(UnitVector3d const &v) const
Definition: UnitVector3d.h:161
Vector3d cwiseProduct(Vector3d const &v) const
Definition: UnitVector3d.h:187
Vector3d operator+(Vector3d const &v) const
The addition operator returns the sum of this unit vector and v.
Definition: UnitVector3d.h:179
static UnitVector3d fromNormalized(double x, double y, double z)
Definition: UnitVector3d.h:89
static UnitVector3d orthogonalTo(NormalizedAngle const &a)
Definition: UnitVector3d.h:76
UnitVector3d(Vector3d const &v)
Definition: UnitVector3d.h:112
static UnitVector3d fromNormalized(Vector3d const &v)
Definition: UnitVector3d.h:82
UnitVector3d rotatedAround(UnitVector3d const &k, Angle a) const
Definition: UnitVector3d.h:193
Vector3d operator*(double s) const
Definition: UnitVector3d.h:172
Vector3d operator/(double s) const
Definition: UnitVector3d.h:176
UnitVector3d()
The default constructor creates a unit vector equal to (1, 0, 0).
Definition: UnitVector3d.h:106
Vector3d operator-(Vector3d const &v) const
Definition: UnitVector3d.h:183
static UnitVector3d orthogonalTo(Vector3d const &v)
Definition: UnitVector3d.cc:34
Vector3d cross(Vector3d const &v) const
cross returns the cross product of this unit vector and v.
Definition: UnitVector3d.h:155
UnitVector3d(LonLat const &p)
Definition: UnitVector3d.h:123
double const * getData() const
getData returns a pointer to the 3 components of this unit vector.
Definition: UnitVector3d.h:140
double operator()(int i) const
The function call operator returns the i-th component of this vector.
Definition: UnitVector3d.h:143
static UnitVector3d northFrom(Vector3d const &v)
Definition: UnitVector3d.cc:51
Vector3d is a vector in ℝ³ with components stored in double precision.
Definition: Vector3d.h:44
Vector3d cwiseProduct(Vector3d const &v) const
cwiseProduct returns the component-wise product of this vector and v.
Definition: Vector3d.h:150
Vector3d rotatedAround(UnitVector3d const &k, Angle a) const
Definition: Vector3d.cc:125
double dot(Vector3d const &v) const
dot returns the inner product of this vector and v.
Definition: Vector3d.h:73
double const * getData() const
data returns a pointer to the 3 components of this vector.
Definition: Vector3d.h:61
double normalize()
Definition: Vector3d.cc:41
Vector3d cross(Vector3d const &v) const
cross returns the cross product of this vector and v.
Definition: Vector3d.h:101