LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
LSSTDataManagementBasePackage
NormalizedAngle.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_NORMALIZEDANGLE_H_
24 #define LSST_SPHGEOM_NORMALIZEDANGLE_H_
25 
28 
29 #include "Angle.h"
30 
31 
32 namespace lsst {
33 namespace sphgeom {
34 
35 // Forward declarations
36 class LonLat;
37 class Vector3d;
38 
42 public:
43  static NormalizedAngle nan() {
45  }
46 
47  static NormalizedAngle fromDegrees(double a) {
48  return NormalizedAngle(a * RAD_PER_DEG);
49  }
50 
51  static NormalizedAngle fromRadians(double a) {
52  return NormalizedAngle(a);
53  }
54 
63  NormalizedAngle const & b);
64 
67  static NormalizedAngle center(NormalizedAngle const & a,
68  NormalizedAngle const & b);
69 
72 
74  NormalizedAngle(NormalizedAngle const & a) : _a(a._a) {}
75 
77  explicit NormalizedAngle(Angle const & a) {
78  *this = NormalizedAngle(a.asRadians());
79  }
80 
83  explicit NormalizedAngle(double a) {
84  // For really large |a|, the error in this reduction can exceed 2*PI
85  // (because PI is only an approximation to π).
86  if (a < 0.0) {
87  _a = Angle(std::fmod(a, 2.0 * PI) + 2.0 * PI);
88  } else if (a > 2 * PI) {
89  _a = Angle(std::fmod(a, 2.0 * PI));
90  } else {
91  _a = Angle(a);
92  }
93  }
94 
97  NormalizedAngle(LonLat const &, LonLat const &);
98 
101  NormalizedAngle(Vector3d const &, Vector3d const &);
102 
106  operator Angle const & () const { return _a; }
107 
108  // Comparison operators
109  bool operator==(Angle const & a) const { return _a == a; }
110  bool operator!=(Angle const & a) const { return _a != a; }
111  bool operator<(Angle const & a) const { return _a < a; }
112  bool operator>(Angle const & a) const { return _a > a; }
113  bool operator<=(Angle const & a) const { return _a <= a; }
114  bool operator>=(Angle const & a) const { return _a >= a; }
115 
116  // Arithmetic operators
117  Angle operator-() const { return Angle(-_a); }
118  Angle operator+(Angle const & a) const { return _a + a; }
119  Angle operator-(Angle const & a) const { return _a - a; }
120  Angle operator*(double a) const { return _a * a; }
121  Angle operator/(double a) const { return _a / a; }
122  double operator/(Angle const & a) const { return _a / a; }
123 
125  double asDegrees() const { return _a.asDegrees(); }
126 
128  double asRadians() const { return _a.asRadians(); }
129 
131  bool isNan() const { return _a.isNan(); }
132 
141  double d = a.asRadians() - asRadians();
142  x._a = Angle((d < 0.0) ? 2.0 * PI + d : d);
143  return x;
144  }
145 
146 private:
147  Angle _a;
148 };
149 
150 inline NormalizedAngle const & abs(NormalizedAngle const & a) { return a; }
151 
152 }} // namespace lsst::sphgeom
153 
154 #endif // LSST_SPHGEOM_NORMALIZEDANGLE_H_
lsst::sphgeom::NormalizedAngle::asRadians
double asRadians() const
asRadians returns the value of this angle in units of radians.
Definition: NormalizedAngle.h:128
lsst::sphgeom::NormalizedAngle::NormalizedAngle
NormalizedAngle(Angle const &a)
This constructor creates a normalized copy of a.
Definition: NormalizedAngle.h:77
lsst::sphgeom::NormalizedAngle::operator==
bool operator==(Angle const &a) const
Definition: NormalizedAngle.h:109
lsst::sphgeom::PI
constexpr double PI
Definition: constants.h:36
lsst::sphgeom::NormalizedAngle::operator-
Angle operator-() const
Definition: NormalizedAngle.h:117
lsst::sphgeom::NormalizedAngle::operator>
bool operator>(Angle const &a) const
Definition: NormalizedAngle.h:112
Angle.h
This file declares a class for representing angles.
lsst::sphgeom::Angle::asRadians
double asRadians() const
asRadians returns the value of this angle in units of radians.
Definition: Angle.h:85
lsst::sphgeom::Angle::isNan
bool isNan() const
isNan returns true if the angle value is NaN.
Definition: Angle.h:91
lsst::sphgeom::LonLat
LonLat represents a spherical coordinate (longitude/latitude angle) pair.
Definition: LonLat.h:48
lsst::sphgeom::NormalizedAngle::isNan
bool isNan() const
isNan returns true if the angle value is NaN.
Definition: NormalizedAngle.h:131
lsst::sphgeom::abs
Angle abs(Angle const &a)
Definition: Angle.h:106
lsst::sphgeom::NormalizedAngle::operator*
Angle operator*(double a) const
Definition: NormalizedAngle.h:120
lsst::sphgeom::NormalizedAngle::nan
static NormalizedAngle nan()
Definition: NormalizedAngle.h:43
lsst::sphgeom::RAD_PER_DEG
constexpr double RAD_PER_DEG
Definition: constants.h:38
lsst::sphgeom::NormalizedAngle::center
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...
Definition: NormalizedAngle.cc:45
lsst::sphgeom::NormalizedAngle::getAngleTo
NormalizedAngle getAngleTo(NormalizedAngle const &a) const
getAngleTo computes the angle α ∈ [0, 2π) such that adding α to this angle and then normalizing the r...
Definition: NormalizedAngle.h:139
lsst::sphgeom::Vector3d
Vector3d is a vector in ℝ³ with components stored in double precision.
Definition: Vector3d.h:44
lsst::sphgeom::NormalizedAngle::asDegrees
double asDegrees() const
asDegrees returns the value of this angle in units of degrees.
Definition: NormalizedAngle.h:125
lsst::afw::table::Angle
lsst::geom::Angle Angle
Definition: misc.h:33
lsst::sphgeom::NormalizedAngle::operator<=
bool operator<=(Angle const &a) const
Definition: NormalizedAngle.h:113
x
double x
Definition: ChebyshevBoundedField.cc:277
lsst::sphgeom::NormalizedAngle::operator>=
bool operator>=(Angle const &a) const
Definition: NormalizedAngle.h:114
b
table::Key< int > b
Definition: TransmissionCurve.cc:467
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::sphgeom::NormalizedAngle::NormalizedAngle
NormalizedAngle()
This constructor creates a NormalizedAngle with a value of zero.
Definition: NormalizedAngle.h:71
std::fmod
T fmod(T... args)
lsst::sphgeom::NormalizedAngle::between
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....
Definition: NormalizedAngle.cc:35
a
table::Key< int > a
Definition: TransmissionCurve.cc:466
lsst::sphgeom::NormalizedAngle::NormalizedAngle
NormalizedAngle(double a)
This constructor creates a NormalizedAngle with the given value in radians, normalized to be in the r...
Definition: NormalizedAngle.h:83
lsst::sphgeom::Angle::asDegrees
double asDegrees() const
asDegrees returns the value of this angle in units of degrees.
Definition: Angle.h:82
lsst::sphgeom::NormalizedAngle::fromRadians
static NormalizedAngle fromRadians(double a)
Definition: NormalizedAngle.h:51
lsst::sphgeom::NormalizedAngle::operator<
bool operator<(Angle const &a) const
Definition: NormalizedAngle.h:111
lsst::sphgeom::Angle
Angle represents an angle in radians.
Definition: Angle.h:43
lsst::sphgeom::NormalizedAngle::operator/
Angle operator/(double a) const
Definition: NormalizedAngle.h:121
lsst::sphgeom::NormalizedAngle::fromDegrees
static NormalizedAngle fromDegrees(double a)
Definition: NormalizedAngle.h:47
lsst::sphgeom::NormalizedAngle::NormalizedAngle
NormalizedAngle(NormalizedAngle const &a)
This constructor creates a copy of a.
Definition: NormalizedAngle.h:74
lsst::sphgeom::NormalizedAngle::operator-
Angle operator-(Angle const &a) const
Definition: NormalizedAngle.h:119
lsst::sphgeom::NormalizedAngle
NormalizedAngle is an angle that lies in the range [0, 2π), with one exception - a NormalizedAngle ca...
Definition: NormalizedAngle.h:41
std::numeric_limits
lsst::sphgeom::NormalizedAngle::operator!=
bool operator!=(Angle const &a) const
Definition: NormalizedAngle.h:110
lsst::sphgeom::NormalizedAngle::operator/
double operator/(Angle const &a) const
Definition: NormalizedAngle.h:122
lsst::sphgeom::NormalizedAngle::operator+
Angle operator+(Angle const &a) const
Definition: NormalizedAngle.h:118