LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
NormalizedAngle.h
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
30#ifndef LSST_SPHGEOM_NORMALIZEDANGLE_H_
31#define LSST_SPHGEOM_NORMALIZEDANGLE_H_
32
35
36#include <limits>
37
38#include "Angle.h"
39
40
41namespace lsst {
42namespace sphgeom {
43
44// Forward declarations
45class LonLat;
46class Vector3d;
47
51public:
55
56 static NormalizedAngle fromDegrees(double a) {
57 return NormalizedAngle(a * RAD_PER_DEG);
58 }
59
60 static NormalizedAngle fromRadians(double a) {
61 return NormalizedAngle(a);
62 }
63
72 NormalizedAngle const & b);
73
76 static NormalizedAngle center(NormalizedAngle const & a,
77 NormalizedAngle const & b);
78
80 NormalizedAngle() = default;
81
83 NormalizedAngle(NormalizedAngle const & a) = default;
84
86 explicit NormalizedAngle(Angle const & a) {
87 *this = NormalizedAngle(a.asRadians());
88 }
89
92 explicit NormalizedAngle(double a) {
93 // For really large |a|, the error in this reduction can exceed 2*PI
94 // (because PI is only an approximation to π).
95 if (a < 0.0) {
96 _a = Angle(std::fmod(a, 2.0 * PI) + 2.0 * PI);
97 } else if (a > 2 * PI) {
98 _a = Angle(std::fmod(a, 2.0 * PI));
99 } else {
100 _a = Angle(a);
101 }
102 }
103
106 NormalizedAngle(LonLat const &, LonLat const &);
107
110 NormalizedAngle(Vector3d const &, Vector3d const &);
111
115 operator Angle const & () const { return _a; }
116
117 // Comparison operators
118 bool operator==(Angle const & a) const { return _a == a; }
119 bool operator!=(Angle const & a) const { return _a != a; }
120 bool operator<(Angle const & a) const { return _a < a; }
121 bool operator>(Angle const & a) const { return _a > a; }
122 bool operator<=(Angle const & a) const { return _a <= a; }
123 bool operator>=(Angle const & a) const { return _a >= a; }
124
125 // Arithmetic operators
126 Angle operator-() const { return Angle(-_a); }
127 Angle operator+(Angle const & a) const { return _a + a; }
128 Angle operator-(Angle const & a) const { return _a - a; }
129 Angle operator*(double a) const { return _a * a; }
130 Angle operator/(double a) const { return _a / a; }
131 double operator/(Angle const & a) const { return _a / a; }
132
134 double asDegrees() const { return _a.asDegrees(); }
135
137 double asRadians() const { return _a.asRadians(); }
138
140 bool isNan() const { return _a.isNan(); }
141
150 double d = a.asRadians() - asRadians();
151 x._a = Angle((d < 0.0) ? 2.0 * PI + d : d);
152 return x;
153 }
154
155private:
156 Angle _a;
157};
158
159inline NormalizedAngle const & abs(NormalizedAngle const & a) { return a; }
160
161}} // namespace lsst::sphgeom
162
163#endif // LSST_SPHGEOM_NORMALIZEDANGLE_H_
Angle represents an angle in radians.
Definition Angle.h:50
LonLat represents a spherical coordinate (longitude/latitude angle) pair.
Definition LonLat.h:55
NormalizedAngle is an angle that lies in the range [0, 2π), with one exception - a NormalizedAngle ca...
bool operator!=(Angle const &a) const
bool operator>=(Angle const &a) const
bool operator<=(Angle const &a) const
bool operator==(Angle const &a) const
bool isNan() const
isNan returns true if the angle value is NaN.
NormalizedAngle(double a)
This constructor creates a NormalizedAngle with the given value in radians, normalized to be in the r...
double asRadians() const
asRadians returns the value of this angle in units of radians.
NormalizedAngle getAngleTo(NormalizedAngle const &a) const
getAngleTo computes the angle α ∈ [0, 2π) such that adding α to this angle and then normalizing the r...
static NormalizedAngle fromRadians(double a)
bool operator>(Angle const &a) const
NormalizedAngle(Angle const &a)
This constructor creates a normalized copy of a.
static NormalizedAngle nan()
Angle operator/(double a) const
Angle operator-(Angle const &a) const
NormalizedAngle()=default
This constructor creates a NormalizedAngle with a value of zero.
Angle operator+(Angle const &a) const
double asDegrees() const
asDegrees returns the value of this angle in units of degrees.
static NormalizedAngle fromDegrees(double a)
double operator/(Angle const &a) const
bool operator<(Angle const &a) const
static NormalizedAngle between(NormalizedAngle const &a, NormalizedAngle const &b)
For two angles a and b, between(a, b) returns the smaller of a.getAngleTo(b) and b....
Angle operator*(double a) const
static NormalizedAngle center(NormalizedAngle const &a, NormalizedAngle const &b)
For two normalized angles a and b, center(a, b) returns the angle m such that a.getAngleTo(m) is equa...
NormalizedAngle(NormalizedAngle const &a)=default
This constructor creates a copy of a.
Vector3d is a vector in ℝ³ with components stored in double precision.
Definition Vector3d.h:51
T fmod(T... args)
Angle abs(Angle const &a)
Definition Angle.h:113
constexpr double RAD_PER_DEG
Definition constants.h:45
constexpr double PI
Definition constants.h:43
T quiet_NaN(T... args)
This file declares a class for representing angles.