LSSTApplications  18.0.0+73,19.0.0+5,19.0.0+63,19.0.0+74,19.0.0+9,19.0.0-1-g20d9b18+29,19.0.0-1-g49a97f9+3,19.0.0-1-g5549ca4+4,19.0.0-1-g8c57eb9+29,19.0.0-1-g9a028c0+9,19.0.0-1-ga72da6b+3,19.0.0-1-gb77924a+10,19.0.0-1-gbfe0924+61,19.0.0-1-ge272bc4+29,19.0.0-1-gefe1d0d+45,19.0.0-14-g7511ce4+1,19.0.0-16-g3dc1a33c+1,19.0.0-16-g497ad8f+2,19.0.0-17-g9c22e3c+5,19.0.0-18-g2c901ce+5,19.0.0-18-g35bb99870,19.0.0-19-g2772d4a+4,19.0.0-19-g85fbfd3+4,19.0.0-2-g0d9f9cd+69,19.0.0-2-g260436e+49,19.0.0-2-g9675b69+3,19.0.0-2-gd6f004e+1,19.0.0-2-gde8e5e3+3,19.0.0-2-gff6972b+13,19.0.0-3-ga642a0f,19.0.0-3-gf3b1435+1,19.0.0-4-gac56cce+12,19.0.0-47-g0e06596+1,19.0.0-48-gd5e8b3b4+1,19.0.0-5-g66946eb+1,19.0.0-5-gd8897ba+1,19.0.0-7-g3343160,19.0.0-7-g686a884+4,19.0.0-7-g886f805+1,w.2020.16
LSSTDataManagementBasePackage
Classes | Namespaces | Macros | Functions | Variables
Angle.h File Reference
#include <cmath>
#include <iostream>
#include <type_traits>
#include "boost/math/constants/constants.hpp"

Go to the source code of this file.

Classes

class  lsst::geom::AngleUnit
 A class used to convert scalar POD types such as double to Angle. More...
 
class  lsst::geom::Angle
 A class representing an angle. More...
 
struct  std::hash< lsst::geom::AngleUnit >
 
struct  std::hash< lsst::geom::Angle >
 

Namespaces

 lsst
 A base class for image defects.
 
 lsst::geom
 
 std
 STL namespace.
 

Macros

#define ANGLE_OPUP_TYPE(OP, TYPE)
 
#define ANGLE_COMP(OP)   constexpr bool operator OP(const Angle& rhs) const noexcept { return _val OP rhs._val; }
 
#define ANGLE_OP(OP)
 
#define ANGLE_OP_TYPE(OP, TYPE)
 

Functions

constexpr double lsst::geom::degToRad (double x) noexcept
 
constexpr double lsst::geom::radToDeg (double x) noexcept
 
constexpr double lsst::geom::radToArcsec (double x) noexcept
 
constexpr double lsst::geom::radToMas (double x) noexcept
 
constexpr double lsst::geom::arcsecToRad (double x) noexcept
 
constexpr double lsst::geom::masToRad (double x) noexcept
 
constexpr Angle lsst::geom::operator+ (Angle a, Angle d) noexcept
 Sum of two angles. More...
 
constexpr Angle lsst::geom::operator- (Angle a, Angle d) noexcept
 Difference of two angles. More...
 
constexpr Angle lsst::geom::operator* (Angle a, Angle d) noexcept
 Product of two angles. More...
 
constexpr Angle lsst::geom::operator- (Angle angle)
 An angle in the opposite sense. More...
 
constexpr Angle lsst::geom::operator/ (Angle a, int d) noexcept
 Ratio of an angle and a scalar. More...
 
constexpr Angle lsst::geom::operator/ (Angle a, double d) noexcept
 Ratio of an angle and a scalar. More...
 
template<typename T >
constexpr double lsst::geom::operator/ (T const lhs, Angle rhs) noexcept=delete
 
std::ostreamlsst::geom::operator<< (std::ostream &s, Angle a)
 Print an Angle to a stream. More...
 
template<typename T >
constexpr bool lsst::geom::isAngle (T) noexcept
 Allow a user to check if they have an angle. More...
 
template<typename T >
constexpr Angle lsst::geom::operator* (T lhs, AngleUnit rhs) noexcept
 Use AngleUnit to convert a POD (e.g. int, double) to an Angle; e.g. 180*degrees. More...
 
constexpr Angle lsst::geom::operator* (Angle a, double d) noexcept
 Product of an angle and a scalar. More...
 
constexpr Angle lsst::geom::operator* (double d, Angle a) noexcept
 Product of an angle and a scalar. More...
 
constexpr Angle lsst::geom::operator* (Angle a, int d) noexcept
 Product of an angle and a scalar. More...
 
constexpr Angle lsst::geom::operator* (int d, Angle a) noexcept
 Product of an angle and a scalar. More...
 

Variables

double constexpr lsst::geom::PI = boost::math::constants::pi<double>()
 The ratio of a circle's circumference to diameter. More...
 
double constexpr lsst::geom::TWOPI = boost::math::constants::pi<double>() * 2.0
 
double constexpr lsst::geom::HALFPI = boost::math::constants::pi<double>() * 0.5
 
double constexpr lsst::geom::ONE_OVER_PI = 1.0 / boost::math::constants::pi<double>()
 
double const lsst::geom::SQRTPI = sqrt(boost::math::constants::pi<double>())
 
double const lsst::geom::INVSQRTPI = 1.0 / sqrt(boost::math::constants::pi<double>())
 
double constexpr lsst::geom::ROOT2 = boost::math::constants::root_two<double>()
 
AngleUnit constexpr lsst::geom::radians = AngleUnit(1.0)
 constant with units of radians More...
 
AngleUnit constexpr lsst::geom::degrees = AngleUnit(PI / 180.0)
 constant with units of degrees More...
 
AngleUnit constexpr lsst::geom::hours = AngleUnit(PI * 15.0 / 180.0)
 constant with units of hours More...
 
AngleUnit constexpr lsst::geom::arcminutes = AngleUnit(PI / 60 / 180.0)
 constant with units of arcminutes More...
 
AngleUnit constexpr lsst::geom::arcseconds = AngleUnit(PI / 180.0 / 3600.0)
 constant with units of arcseconds More...
 
AngleUnit constexpr lsst::geom::milliarcseconds
 constant with units of milliarcseconds More...
 

Macro Definition Documentation

◆ ANGLE_COMP

#define ANGLE_COMP (   OP)    constexpr bool operator OP(const Angle& rhs) const noexcept { return _val OP rhs._val; }

Definition at line 259 of file Angle.h.

◆ ANGLE_OP

#define ANGLE_OP (   OP)
Value:
inline constexpr Angle operator OP(Angle a, Angle d) noexcept { \
return Angle(static_cast<double>(a) OP static_cast<double>(d)); \
}
table::Key< int > a
lsst::geom::Angle Angle
Definition: misc.h:33

Definition at line 287 of file Angle.h.

◆ ANGLE_OP_TYPE

#define ANGLE_OP_TYPE (   OP,
  TYPE 
)
Value:
inline constexpr Angle operator OP(Angle a, TYPE d) noexcept { \
return Angle(static_cast<double>(a) OP d); \
} \
\
inline constexpr Angle operator OP(TYPE d, Angle a) noexcept { \
return Angle(d OP static_cast<double>(a)); \
}
table::Key< int > a
lsst::geom::Angle Angle
Definition: misc.h:33

Definition at line 294 of file Angle.h.

◆ ANGLE_OPUP_TYPE

#define ANGLE_OPUP_TYPE (   OP,
  TYPE 
)
Value:
Angle& operator OP(TYPE const& d) noexcept { \
_val OP d; \
return *this; \
}
lsst::geom::Angle Angle
Definition: misc.h:33

Definition at line 235 of file Angle.h.