NumCpp  2.12.1
A Templatized Header Only C++ Implementation of the Python NumPy Library
Public Member Functions | Friends
nc::coordinates::reference_frames::Celestial Class Reference

Holds a full celestial Celestial object. More...

#include <Celestial.hpp>

Public Member Functions

 Celestial ()=default
 
 Celestial (const Cartesian &inCartesianVector)
 
 Celestial (const NdArray< double > &inCartesianVector)
 
 Celestial (const RA &inRA, const Dec &inDec) noexcept
 
 Celestial (const Vec3 &inCartesianVector)
 
 Celestial (double inRaDegrees, double inDecDegrees)
 
 Celestial (double inX, double inY, double inZ)
 
 Celestial (uint8 inRaHours, uint8 inRaMinutes, double inRaSeconds, Dec::Sign inSign, uint8 inDecDegreesWhole, uint8 inDecMinutes, double inDecSeconds)
 
const Dec & dec () const noexcept
 
double degreeSeperation (const Celestial &inOtherCelestial) const
 
double degreeSeperation (const NdArray< double > &inVector) const
 
bool operator!= (const Celestial &inRhs) const noexcept
 
bool operator== (const Celestial &inRhs) const noexcept
 
void print () const
 
const RA & ra () const noexcept
 
double radianSeperation (const Celestial &inOtherCelestial) const
 
double radianSeperation (const NdArray< double > &inVector) const
 
std::string str () const
 
double x () const noexcept
 
NdArray< double > xyz () const
 
double y () const noexcept
 
double z () const noexcept
 

Friends

std::ostream & operator<< (std::ostream &inStream, const Celestial &inCoord)
 

Detailed Description

Holds a full celestial Celestial object.

Constructor & Destructor Documentation

◆ Celestial() [1/8]

nc::coordinates::reference_frames::Celestial::Celestial ( )
default

Default Constructor

◆ Celestial() [2/8]

nc::coordinates::reference_frames::Celestial::Celestial ( double  inRaDegrees,
double  inDecDegrees 
)
inline

Constructor

Parameters
inRaDegrees
inDecDegrees

◆ Celestial() [3/8]

nc::coordinates::reference_frames::Celestial::Celestial ( uint8  inRaHours,
uint8  inRaMinutes,
double  inRaSeconds,
Dec::Sign  inSign,
uint8  inDecDegreesWhole,
uint8  inDecMinutes,
double  inDecSeconds 
)
inline

Constructor

Parameters
inRaHours
inRaMinutes
inRaSeconds
inSign
inDecDegreesWhole
inDecMinutes
inDecSeconds

◆ Celestial() [4/8]

nc::coordinates::reference_frames::Celestial::Celestial ( const RA &  inRA,
const Dec &  inDec 
)
inlinenoexcept

Constructor

Parameters
inRA
inDec

◆ Celestial() [5/8]

nc::coordinates::reference_frames::Celestial::Celestial ( double  inX,
double  inY,
double  inZ 
)
inline

Constructor

Parameters
inX
inY
inZ

◆ Celestial() [6/8]

nc::coordinates::reference_frames::Celestial::Celestial ( const Cartesian &  inCartesianVector)
inline

Constructor

Parameters
inCartesianVector

◆ Celestial() [7/8]

nc::coordinates::reference_frames::Celestial::Celestial ( const Vec3 &  inCartesianVector)
inline

Constructor

Parameters
inCartesianVector

◆ Celestial() [8/8]

nc::coordinates::reference_frames::Celestial::Celestial ( const NdArray< double > &  inCartesianVector)
inline

Constructor

Parameters
inCartesianVector

Member Function Documentation

◆ dec()

const Dec & nc::coordinates::reference_frames::Celestial::dec ( ) const
inlinenoexcept

Returns the Dec object

Returns
Dec

◆ degreeSeperation() [1/2]

double nc::coordinates::reference_frames::Celestial::degreeSeperation ( const Celestial &  inOtherCelestial) const
inline

Returns the degree seperation between the two Celestials

Parameters
inOtherCelestial
Returns
degrees

◆ degreeSeperation() [2/2]

double nc::coordinates::reference_frames::Celestial::degreeSeperation ( const NdArray< double > &  inVector) const
inline

Returns the degree seperation between the Celestial and the input vector

Parameters
inVector
Returns
degrees

◆ operator!=()

bool nc::coordinates::reference_frames::Celestial::operator!= ( const Celestial &  inRhs) const
inlinenoexcept

Not equality operator

Parameters
inRhs
Returns
bool

◆ operator==()

bool nc::coordinates::reference_frames::Celestial::operator== ( const Celestial &  inRhs) const
inlinenoexcept

Equality operator

Parameters
inRhs
Returns
bool

◆ print()

void nc::coordinates::reference_frames::Celestial::print ( ) const
inline

Prints the Celestial object to the console

◆ ra()

const RA & nc::coordinates::reference_frames::Celestial::ra ( ) const
inlinenoexcept

Returns the RA object

Returns
RA

◆ radianSeperation() [1/2]

double nc::coordinates::reference_frames::Celestial::radianSeperation ( const Celestial &  inOtherCelestial) const
inline

Returns the radian seperation between the two Celestials

Parameters
inOtherCelestial
Returns
radians

◆ radianSeperation() [2/2]

double nc::coordinates::reference_frames::Celestial::radianSeperation ( const NdArray< double > &  inVector) const
inline

Returns the radian seperation between the Celestial and the input vector

Parameters
inVector
Returns
radians

◆ str()

std::string nc::coordinates::reference_frames::Celestial::str ( ) const
inline

Returns Celestial as a string representation

Returns
string

◆ x()

double nc::coordinates::reference_frames::Celestial::x ( ) const
inlinenoexcept

Returns the cartesian x value

Returns
x

◆ xyz()

NdArray< double > nc::coordinates::reference_frames::Celestial::xyz ( ) const
inline

Returns the cartesian xyz triplet as an NdArray

Returns
NdArray

◆ y()

double nc::coordinates::reference_frames::Celestial::y ( ) const
inlinenoexcept

Returns the cartesian y value

Returns
y

◆ z()

double nc::coordinates::reference_frames::Celestial::z ( ) const
inlinenoexcept

Returns the cartesian z value

Returns
z

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  inStream,
const Celestial &  inCoord 
)
friend

Ostream operator

Parameters
inStream
inCoord
Returns
std::ostream
The documentation for this class was generated from the following file: