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

A "centroid" detected in an image. More...

#include <star-utils.hpp>

Inheritance diagram for lost::Star:
Collaboration diagram for lost::Star:

Public Member Functions

 Star (decimal x, decimal y, decimal radiusX, decimal radiusY, int magnitude)
 
 Star (decimal x, decimal y, decimal radiusX)
 Convenience constructor that sets Star.radiusY = radiusX and Star.magnitude = 0. More...
 
 Star ()
 Create a zeroed-out star. Fields should be set immediately after construction. More...
 

Public Attributes

Vec2 position
 The (x,y) pixel coordinates in the image (top left is 0,0) More...
 
decimal radiusX
 Approximate horizontal radius of the bright area in pixels. More...
 
decimal radiusY
 Approximate vertical radius of the bright area in pixels. More...
 
int magnitude
 A relative measure of magnitude of the star. More...
 

Detailed Description

A "centroid" detected in an image.

This represents a star from an image which has not necessarily been identified.

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

Constructor & Destructor Documentation

◆ Star() [1/3]

lost::Star::Star ( decimal  x,
decimal  y,
decimal  radiusX,
decimal  radiusY,
int  magnitude 
)
inline

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

◆ Star() [2/3]

lost::Star::Star ( decimal  x,
decimal  y,
decimal  radiusX 
)
inline

Convenience constructor that sets Star.radiusY = radiusX and Star.magnitude = 0.

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

◆ Star() [3/3]

lost::Star::Star ( )
inline

Create a zeroed-out star. Fields should be set immediately after construction.

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

Member Data Documentation

◆ magnitude

int lost::Star::magnitude

A relative measure of magnitude of the star.

Larger is brighter. It's impossible to tell the true magnitude of the star from the image, without really good camera calibration. Anyway, this field is not meant to correspond to the usual measurement of magnitude. Instead, it's just some measure of brightness which may be specific to the centroiding algorithm. For example, it might be the total number of bright pixels in the star.

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

◆ position

Vec2 lost::Star::position

The (x,y) pixel coordinates in the image (top left is 0,0)

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

◆ radiusX

decimal lost::Star::radiusX

Approximate horizontal radius of the bright area in pixels.

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

◆ radiusY

decimal lost::Star::radiusY

Approximate vertical radius of the bright area in pixels.

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


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