PCL
pcl::StarPosition Struct Reference

Positional data of a star. More...

#include <Position.h>

Public Member Functions

 StarPosition ()=default
 
 StarPosition (const StarPosition &x)
 
 StarPosition (double ra, double dec, double properMotionRA=0, double properMotionDec=0, double parallax=0, double radialVelocity=0, TimePoint epoch=TimePoint::J2000())
 
StarPositionoperator= (const StarPosition &x)
 

Public Attributes

double alpha = 0
 ICRS right ascension in degrees.
 
double delta = 0
 ICRS declination in degrees.
 
double muAlpha = 0
 Proper motion in right ascension, mas/year * cos( delta ).
 
double muDelta = 0
 Proper motion in declination, in mas/year.
 
double p = 0
 Parallax in arcseconds.
 
TimePoint t0 = TimePoint::J2000()
 Epoch of coordinates.
 
double v = 0
 Radial velocity in km/s, positive away from Earth.
 

Detailed Description

Constructor & Destructor Documentation

◆ StarPosition() [1/3]

pcl::StarPosition::StarPosition ( )
default

Default constructor. See data members for default values.

◆ StarPosition() [2/3]

pcl::StarPosition::StarPosition ( const StarPosition x)
inline

Copy constructor.

Definition at line 101 of file Position.h.

◆ StarPosition() [3/3]

pcl::StarPosition::StarPosition ( double  ra,
double  dec,
double  properMotionRA = 0,
double  properMotionDec = 0,
double  parallax = 0,
double  radialVelocity = 0,
TimePoint  epoch = TimePoint::J2000() 
)
inline

Memberwise constructor.

Parameters
raRight ascension equatorial coordinate in degrees. Can be specified in the range [-180,+180] or [0,360) indistinctly.
decDeclination equatorial coordinate in degrees. Should be in the [-90,+90] range.
properMotionRAProper motion in right ascension, in mas/year, measured on a great circle, that is, the specified value must be the proper motion in R.A. multiplied by the cosine of the declination. Zero by default.
properMotionDecProper motion in declination, in mas/year. Zero by default.
parallaxParallax in arcseconds. Zero by default.
radialVelocityRadial velocity in km/s, positive away from the Earth. Zero by default.
epochEpoch of catalog coordinates. J2000.0 by default.

Positions and proper motions must be referred to ICRS/J2000.0.

If out-of-range coordinates are specified, their values will be constrained to their proper ranges: right ascension to [0°,360°) and declination to [-90°,+90°].

Definition at line 159 of file Position.h.

Member Function Documentation

◆ operator=()

StarPosition& pcl::StarPosition::operator= ( const StarPosition x)
inline

Copy assignment operator. Returns a reference to this object.

Definition at line 115 of file Position.h.

References alpha, delta, muAlpha, muDelta, p, t0, and v.


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