LOST  0.0.1
LOST: Open-source Star Tracker
lost::CatalogStar Class Reference

A star from the Bright Star Catalog. More...

#include <star-utils.hpp>

Collaboration diagram for lost::CatalogStar:

Public Member Functions

 CatalogStar ()=default
 
 CatalogStar (decimal raj2000, decimal dej2000, int magnitude, int name)
 Create a CatalogStar using its celestial/spherical coordinates. More...
 
 CatalogStar (Vec3 spatial, int magnitude, int name)
 

Public Attributes

Vec3 spatial
 The point on the unit sphere where the star lies. More...
 
int magnitude
 The magnitude of the star, with the decimal point shifted two places right. More...
 
int name
 A unique number which unambiguously identifies the catalog star. More...
 

Detailed Description

A star from the Bright Star Catalog.

Definition at line 12 of file star-utils.hpp.

Constructor & Destructor Documentation

◆ CatalogStar() [1/3]

lost::CatalogStar::CatalogStar ( )
default

◆ CatalogStar() [2/3]

lost::CatalogStar::CatalogStar ( decimal  raj2000,
decimal  dej2000,
int  magnitude,
int  name 
)
inline

Create a CatalogStar using its celestial/spherical coordinates.

Parameters
raj2000,dej2000The right ascension and declination of the star in the year 2000
magnitudeSee ::magnitude
nameSee ::name

Definition at line 22 of file star-utils.hpp.

◆ CatalogStar() [3/3]

lost::CatalogStar::CatalogStar ( Vec3  spatial,
int  magnitude,
int  name 
)
inline

Definition at line 25 of file star-utils.hpp.

Member Data Documentation

◆ magnitude

int lost::CatalogStar::magnitude

The magnitude of the star, with the decimal point shifted two places right.

I.e., multiply this by 10-2 to get the magnitude.

Definition at line 37 of file star-utils.hpp.

◆ name

int lost::CatalogStar::name

A unique number which unambiguously identifies the catalog star.

The catalog is an array, so in algorithms we usually refer to catalog stars by their index in the catalog. However, if the catalog is filtered (say, to remove stars that are too dim or too close to each other), the indexes change, which makes everything really hard to debug because indexes change based on how the catalog was filtered. That's what names are for: They're fixed and don't change.

Definition at line 42 of file star-utils.hpp.

◆ spatial

Vec3 lost::CatalogStar::spatial

The point on the unit sphere where the star lies.

The earth is at the center of the sphere. A star with right ascension and declination both equal to zero will lie at (1,0,0).

Definition at line 32 of file star-utils.hpp.


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