LSSTApplications  17.0+124,17.0+14,17.0+73,18.0.0+37,18.0.0+80,18.0.0-4-g68ffd23+4,18.1.0-1-g0001055+12,18.1.0-1-g03d53ef+5,18.1.0-1-g1349e88+55,18.1.0-1-g2505f39+44,18.1.0-1-g5315e5e+4,18.1.0-1-g5e4b7ea+14,18.1.0-1-g7e8fceb+4,18.1.0-1-g85f8cd4+48,18.1.0-1-g8ff0b9f+4,18.1.0-1-ga2c679d+1,18.1.0-1-gd55f500+35,18.1.0-10-gb58edde+2,18.1.0-11-g0997b02+4,18.1.0-13-gfe4edf0b+12,18.1.0-14-g259bd21+21,18.1.0-19-gdb69f3f+2,18.1.0-2-g5f9922c+24,18.1.0-2-gd3b74e5+11,18.1.0-2-gfbf3545+32,18.1.0-26-g728bddb4+5,18.1.0-27-g6ff7ca9+2,18.1.0-3-g52aa583+25,18.1.0-3-g8ea57af+9,18.1.0-3-gb69f684+42,18.1.0-3-gfcaddf3+6,18.1.0-32-gd8786685a,18.1.0-4-gf3f9b77+6,18.1.0-5-g1dd662b+2,18.1.0-5-g6dbcb01+41,18.1.0-6-gae77429+3,18.1.0-7-g9d75d83+9,18.1.0-7-gae09a6d+30,18.1.0-9-gc381ef5+4,w.2019.45
LSSTDataManagementBasePackage
Public Member Functions | Static Public Member Functions | List of all members
lsst::sphgeom::Angle Class Reference

Angle represents an angle in radians. More...

#include <Angle.h>

Public Member Functions

 Angle ()
 This constructor creates an Angle with a value of zero. More...
 
 Angle (double a)
 This constructor creates an Angle with the given value in radians. More...
 
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 operator<= (Angle const &a) const
 
bool operator>= (Angle const &a) const
 
Angle operator- () const
 
Angle operator+ (Angle const &a) const
 
Angle operator- (Angle const &a) const
 
Angle operator* (double a) const
 
Angle operator/ (double a) const
 
double operator/ (Angle const &a) const
 
Angle & operator+= (Angle const &a)
 
Angle & operator-= (Angle const &a)
 
Angle & operator*= (double a)
 
Angle & operator/= (double a)
 
double asDegrees () const
 asDegrees returns the value of this angle in units of degrees. More...
 
double asRadians () const
 asRadians returns the value of this angle in units of radians. More...
 
bool isNormalized () const
 isNormalized returns true if this angle lies in the range [0, 2π). More...
 
bool isNan () const
 isNan returns true if the angle value is NaN. More...
 

Static Public Member Functions

static Angle nan ()
 
static Angle fromDegrees (double a)
 
static Angle fromRadians (double a)
 

Detailed Description

Angle represents an angle in radians.

It provides methods for angle comparison and arithmetic, as well as unit conversion. An angle is said to be normalized if it lies in the range [0, 2π).

Definition at line 43 of file Angle.h.

Constructor & Destructor Documentation

◆ Angle() [1/2]

lsst::sphgeom::Angle::Angle ( )
inline

This constructor creates an Angle with a value of zero.

Definition at line 54 of file Angle.h.

54 : _rad(0.0) {}

◆ Angle() [2/2]

lsst::sphgeom::Angle::Angle ( double  a)
inlineexplicit

This constructor creates an Angle with the given value in radians.

Definition at line 57 of file Angle.h.

57 : _rad(a) {}
a
table::Key< int > a
Definition: TransmissionCurve.cc:466

Member Function Documentation

◆ asDegrees()

double lsst::sphgeom::Angle::asDegrees ( ) const
inline

asDegrees returns the value of this angle in units of degrees.

Definition at line 82 of file Angle.h.

82 { return _rad * DEG_PER_RAD; }
lsst::sphgeom::DEG_PER_RAD
constexpr double DEG_PER_RAD
Definition: constants.h:39

◆ asRadians()

double lsst::sphgeom::Angle::asRadians ( ) const
inline

asRadians returns the value of this angle in units of radians.

Definition at line 85 of file Angle.h.

85 { return _rad; }

◆ fromDegrees()

static Angle lsst::sphgeom::Angle::fromDegrees ( double  a)
inlinestatic

Definition at line 49 of file Angle.h.

49 { return Angle(a * RAD_PER_DEG); }
a
table::Key< int > a
Definition: TransmissionCurve.cc:466
lsst::sphgeom::Angle::Angle
Angle()
This constructor creates an Angle with a value of zero.
Definition: Angle.h:54
lsst::sphgeom::RAD_PER_DEG
constexpr double RAD_PER_DEG
Definition: constants.h:38

◆ fromRadians()

static Angle lsst::sphgeom::Angle::fromRadians ( double  a)
inlinestatic

Definition at line 51 of file Angle.h.

51 { return Angle(a); }
a
table::Key< int > a
Definition: TransmissionCurve.cc:466
lsst::sphgeom::Angle::Angle
Angle()
This constructor creates an Angle with a value of zero.
Definition: Angle.h:54

◆ isNan()

bool lsst::sphgeom::Angle::isNan ( ) const
inline

isNan returns true if the angle value is NaN.

Definition at line 91 of file Angle.h.

91 { return std::isnan(_rad); }
std::isnan
T isnan(T... args)

◆ isNormalized()

bool lsst::sphgeom::Angle::isNormalized ( ) const
inline

isNormalized returns true if this angle lies in the range [0, 2π).

Definition at line 88 of file Angle.h.

88 { return _rad >= 0.0 && _rad <= 2.0 * PI; }
lsst::sphgeom::PI
constexpr double PI
Definition: constants.h:36

◆ nan()

static Angle lsst::sphgeom::Angle::nan ( )
inlinestatic

Definition at line 45 of file Angle.h.

45  {
46  return Angle(std::numeric_limits<double>::quiet_NaN());
47  }
lsst::sphgeom::Angle::Angle
Angle()
This constructor creates an Angle with a value of zero.
Definition: Angle.h:54

◆ operator!=()

bool lsst::sphgeom::Angle::operator!= ( Angle const &  a) const
inline

Definition at line 61 of file Angle.h.

61 { return _rad != a._rad; }
a
table::Key< int > a
Definition: TransmissionCurve.cc:466

◆ operator*()

Angle lsst::sphgeom::Angle::operator* ( double  a) const
inline

Definition at line 71 of file Angle.h.

71 { return Angle(_rad * a); }
a
table::Key< int > a
Definition: TransmissionCurve.cc:466
lsst::sphgeom::Angle::Angle
Angle()
This constructor creates an Angle with a value of zero.
Definition: Angle.h:54

◆ operator*=()

Angle& lsst::sphgeom::Angle::operator*= ( double  a)
inline

Definition at line 78 of file Angle.h.

78 { *this = *this * a; return *this; }
a
table::Key< int > a
Definition: TransmissionCurve.cc:466

◆ operator+()

Angle lsst::sphgeom::Angle::operator+ ( Angle const &  a) const
inline

Definition at line 69 of file Angle.h.

69 { return Angle(_rad + a._rad); }
a
table::Key< int > a
Definition: TransmissionCurve.cc:466
lsst::sphgeom::Angle::Angle
Angle()
This constructor creates an Angle with a value of zero.
Definition: Angle.h:54

◆ operator+=()

Angle& lsst::sphgeom::Angle::operator+= ( Angle const &  a)
inline

Definition at line 76 of file Angle.h.

76 { *this = *this + a; return *this; }
a
table::Key< int > a
Definition: TransmissionCurve.cc:466

◆ operator-() [1/2]

Angle lsst::sphgeom::Angle::operator- ( ) const
inline

Definition at line 68 of file Angle.h.

68 { return Angle(-_rad); }
lsst::sphgeom::Angle::Angle
Angle()
This constructor creates an Angle with a value of zero.
Definition: Angle.h:54

◆ operator-() [2/2]

Angle lsst::sphgeom::Angle::operator- ( Angle const &  a) const
inline

Definition at line 70 of file Angle.h.

70 { return Angle(_rad - a._rad); }
a
table::Key< int > a
Definition: TransmissionCurve.cc:466
lsst::sphgeom::Angle::Angle
Angle()
This constructor creates an Angle with a value of zero.
Definition: Angle.h:54

◆ operator-=()

Angle& lsst::sphgeom::Angle::operator-= ( Angle const &  a)
inline

Definition at line 77 of file Angle.h.

77 { *this = *this - a; return *this; }
a
table::Key< int > a
Definition: TransmissionCurve.cc:466

◆ operator/() [1/2]

Angle lsst::sphgeom::Angle::operator/ ( double  a) const
inline

Definition at line 72 of file Angle.h.

72 { return Angle(_rad / a); }
a
table::Key< int > a
Definition: TransmissionCurve.cc:466
lsst::sphgeom::Angle::Angle
Angle()
This constructor creates an Angle with a value of zero.
Definition: Angle.h:54

◆ operator/() [2/2]

double lsst::sphgeom::Angle::operator/ ( Angle const &  a) const
inline

Definition at line 73 of file Angle.h.

73 { return _rad / a._rad; }
a
table::Key< int > a
Definition: TransmissionCurve.cc:466

◆ operator/=()

Angle& lsst::sphgeom::Angle::operator/= ( double  a)
inline

Definition at line 79 of file Angle.h.

79 { *this = *this / a; return *this; }
a
table::Key< int > a
Definition: TransmissionCurve.cc:466

◆ operator<()

bool lsst::sphgeom::Angle::operator< ( Angle const &  a) const
inline

Definition at line 62 of file Angle.h.

62 { return _rad < a._rad; }
a
table::Key< int > a
Definition: TransmissionCurve.cc:466

◆ operator<=()

bool lsst::sphgeom::Angle::operator<= ( Angle const &  a) const
inline

Definition at line 64 of file Angle.h.

64 { return _rad <= a._rad; }
a
table::Key< int > a
Definition: TransmissionCurve.cc:466

◆ operator==()

bool lsst::sphgeom::Angle::operator== ( Angle const &  a) const
inline

Definition at line 60 of file Angle.h.

60 { return _rad == a._rad; }
a
table::Key< int > a
Definition: TransmissionCurve.cc:466

◆ operator>()

bool lsst::sphgeom::Angle::operator> ( Angle const &  a) const
inline

Definition at line 63 of file Angle.h.

63 { return _rad > a._rad; }
a
table::Key< int > a
Definition: TransmissionCurve.cc:466

◆ operator>=()

bool lsst::sphgeom::Angle::operator>= ( Angle const &  a) const
inline

Definition at line 65 of file Angle.h.

65 { return _rad >= a._rad; }
a
table::Key< int > a
Definition: TransmissionCurve.cc:466
The documentation for this class was generated from the following file:
Generated on Sat Nov 16 2019 09:15:52 for LSSTApplications by   doxygen 1.8.13