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.

: _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.

: _rad(a) {}

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.

{ return _rad * DEG_PER_RAD; }

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.

{ return _rad; }

fromDegrees()

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

inlinestatic

Definition at line 49 of file Angle.h.

{ return Angle(a * RAD_PER_DEG); }

fromRadians()

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

inlinestatic

Definition at line 51 of file Angle.h.

{ return Angle(a); }

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.

{ return std::isnan(_rad); }

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.

{ return _rad >= 0.0 && _rad <= 2.0 * PI; }

nan()

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

inlinestatic

Definition at line 45 of file Angle.h.

                       {
        return Angle(std::numeric_limits<double>::quiet_NaN());
    }

operator!=()

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

inline

Definition at line 61 of file Angle.h.

{ return _rad != a._rad; }

operator*()

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

inline

Definition at line 71 of file Angle.h.

{ return Angle(_rad * a); }

operator*=()

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

inline

Definition at line 78 of file Angle.h.

{ *this = *this * a; return *this; }

operator+()

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

inline

Definition at line 69 of file Angle.h.

{ return Angle(_rad + a._rad); }

operator+=()

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

inline

Definition at line 76 of file Angle.h.

{ *this = *this + a; return *this; }

operator-() [1/2]

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

inline

Definition at line 68 of file Angle.h.

{ return Angle(-_rad); }

operator-() [2/2]

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

inline

Definition at line 70 of file Angle.h.

{ return Angle(_rad - a._rad); }

operator-=()

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

inline

Definition at line 77 of file Angle.h.

{ *this = *this - a; return *this; }

operator/() [1/2]

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

inline

Definition at line 73 of file Angle.h.

{ return _rad / a._rad; }

operator/() [2/2]

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

inline

Definition at line 72 of file Angle.h.

{ return Angle(_rad / a); }

operator/=()

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

inline

Definition at line 79 of file Angle.h.

{ *this = *this / a; return *this; }

operator<()

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

inline

Definition at line 62 of file Angle.h.

{ return _rad < a._rad; }

operator<=()

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

inline

Definition at line 64 of file Angle.h.

{ return _rad <= a._rad; }

operator==()

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

inline

Definition at line 60 of file Angle.h.

{ return _rad == a._rad; }

operator>()

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

inline

Definition at line 63 of file Angle.h.

{ return _rad > a._rad; }

operator>=()

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

inline

Definition at line 65 of file Angle.h.

{ return _rad >= a._rad; }

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-5.0.0/Linux64/sphgeom/g1081da9e2a+62d12e78cb/include/lsst/sphgeom/Angle.h