NumCpp  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
nc::coordinates::Coordinate Class Reference

Holds a full coordinate object. More...

#include <Coordinate.hpp>

Public Member Functions

 Coordinate ()=default
 
 Coordinate (const NdArray< double > &inCartesianVector)
 
 Coordinate (const RA &inRA, const Dec &inDec) noexcept
 
 Coordinate (double inRaDegrees, double inDecDegrees)
 
 Coordinate (double inX, double inY, double inZ) noexcept
 
 Coordinate (uint8 inRaHours, uint8 inRaMinutes, double inRaSeconds, Sign inSign, uint8 inDecDegreesWhole, uint8 inDecMinutes, double inDecSeconds)
 
const Decdec () const noexcept
 
double degreeSeperation (const Coordinate &inOtherCoordinate) const
 
double degreeSeperation (const NdArray< double > &inVector) const
 
bool operator!= (const Coordinate &inRhs) const noexcept
 
bool operator== (const Coordinate &inRhs) const noexcept
 
void print () const
 
const RAra () const noexcept
 
double radianSeperation (const Coordinate &inOtherCoordinate) 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 Coordinate &inCoord)
 

Detailed Description

Holds a full coordinate object.

Constructor & Destructor Documentation

◆ Coordinate() [1/6]

nc::coordinates::Coordinate::Coordinate ( )
default

Default Constructor

◆ Coordinate() [2/6]

nc::coordinates::Coordinate::Coordinate ( double  inRaDegrees,
double  inDecDegrees 
)
inline

Constructor

Parameters
inRaDegrees
inDecDegrees

◆ Coordinate() [3/6]

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

Constructor

Parameters
inRaHours
inRaMinutes
inRaSeconds
inSign
inDecDegreesWhole
inDecMinutes
inDecSeconds

◆ Coordinate() [4/6]

nc::coordinates::Coordinate::Coordinate ( const RA inRA,
const Dec inDec 
)
inlinenoexcept

Constructor

Parameters
inRA
inDec

◆ Coordinate() [5/6]

nc::coordinates::Coordinate::Coordinate ( double  inX,
double  inY,
double  inZ 
)
inlinenoexcept

Constructor

Parameters
inX
inY
inZ

◆ Coordinate() [6/6]

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

Constructor

Parameters
inCartesianVector

Member Function Documentation

◆ dec()

const Dec& nc::coordinates::Coordinate::dec ( ) const
inlinenoexcept

Returns the Dec object

Returns
Dec

◆ degreeSeperation() [1/2]

double nc::coordinates::Coordinate::degreeSeperation ( const Coordinate inOtherCoordinate) const
inline

Returns the degree seperation between the two Coordinates

Parameters
inOtherCoordinate
Returns
degrees

◆ degreeSeperation() [2/2]

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

Returns the degree seperation between the Coordinate and the input vector

Parameters
inVector
Returns
degrees

◆ operator!=()

bool nc::coordinates::Coordinate::operator!= ( const Coordinate inRhs) const
inlinenoexcept

Not equality operator

Parameters
inRhs
Returns
bool

◆ operator==()

bool nc::coordinates::Coordinate::operator== ( const Coordinate inRhs) const
inlinenoexcept

Equality operator

Parameters
inRhs
Returns
bool

◆ print()

void nc::coordinates::Coordinate::print ( ) const
inline

Prints the Coordinate object to the console

◆ ra()

const RA& nc::coordinates::Coordinate::ra ( ) const
inlinenoexcept

Returns the RA object

Returns
RA

◆ radianSeperation() [1/2]

double nc::coordinates::Coordinate::radianSeperation ( const Coordinate inOtherCoordinate) const
inline

Returns the radian seperation between the two Coordinates

Parameters
inOtherCoordinate
Returns
radians

◆ radianSeperation() [2/2]

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

Returns the radian seperation between the Coordinate and the input vector

Parameters
inVector
Returns
radians

◆ str()

std::string nc::coordinates::Coordinate::str ( ) const
inline

Returns coordinate as a string representation

Returns
string

◆ x()

double nc::coordinates::Coordinate::x ( ) const
inlinenoexcept

Returns the cartesian x value

Returns
x

◆ xyz()

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

Returns the cartesian xyz triplet as an NdArray

Returns
NdArray

◆ y()

double nc::coordinates::Coordinate::y ( ) const
inlinenoexcept

Returns the cartesian y value

Returns
y

◆ z()

double nc::coordinates::Coordinate::z ( ) const
inlinenoexcept

Returns the cartesian z value

Returns
z

Friends And Related Function Documentation

◆ operator<<

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

Ostream operator

Parameters
inStream
inCoord
Returns
std::ostream

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