pcl::StarDetector::Star Struct Reference

Structure to hold the data of a detected star. More...

#include <StarDetector.h>

Public Types
using	component = DPoint::component

Public Member Functions
	Star ()=default
	Star (const DPoint &p, const Rect &r, const Rect &sr=0, float a=0, float f=0, float s=0, float m=0)
	Star (const DPoint &p, float f=0)
	Star (const Star &)=default
	Star (double x, double y, float f=0)
bool	operator< (const Star &s) const
Star &	operator= (const Star &)=default
bool	operator== (const Star &s) const
component	operator[] (int i) const

Public Attributes
float	area = 0
	Area of the detected source structure in square pixels.
float	flux = 0
	Total flux above local background.
float	mad = 0
DPoint	pos = 0.0
Rect	rect = 0
	Bounding rectangle of the detection region in pixels, image coordinates.
Star *	ref = nullptr
	Referenced star, useful for cross-referencing applications.
float	signal = 0
Rect	srect = 0
	Sampling region in pixels, image coordinates.

Detailed Description

Definition at line 86 of file StarDetector.h.

Member Typedef Documentation

component

using pcl::StarDetector::Star::component = DPoint::component

The type of a coordinate used to represent star positions (barycenter or PSF centroid coordinates).

Definition at line 92 of file StarDetector.h.

Constructor & Destructor Documentation

Star() [1/5]

pcl::StarDetector::Star::Star ( )

default

Default constructor.

Star() [2/5]

pcl::StarDetector::Star::Star ( const DPoint &  p, const Rect &  r, const Rect &  sr = 0, float  a = 0, float  f = 0, float  s = 0, float  m = 0  )

inline

Constructs a new Star object with the specified position p, detection region r, sampling region sr, area a, total flux f, mean signal s, and PSF average deviation m.

Definition at line 117 of file StarDetector.h.

Star() [3/5]

pcl::StarDetector::Star::Star ( const DPoint &  p, float  f = 0  )

inline

Constructs a new Star object with the specified position p in image coordinates and total flux f.

Definition at line 126 of file StarDetector.h.

Star() [4/5]

pcl::StarDetector::Star::Star ( double  x, double  y, float  f = 0  )

inline

Constructs a new Star object with the specified image coordinates x, y and total flux f.

Definition at line 135 of file StarDetector.h.

Star() [5/5]

pcl::StarDetector::Star::Star ( const Star &  )

default

Copy constructor.

Member Function Documentation

operator<()

bool pcl::StarDetector::Star::operator< ( const Star &  s ) const

inline

Less-than relational operator. By default stars are sorted by brightness in descending order. Stars with larger flux values come first in a sorted list.

Definition at line 164 of file StarDetector.h.

References flux.

operator=()

Star& pcl::StarDetector::Star::operator= ( const Star &  )

default

Copy assignment operator. Returns a reference to this object.

operator==()

bool pcl::StarDetector::Star::operator== ( const Star &  s ) const

inline

Equality operator. Two stars are equal iff they are located at the same coordinates, i.e at the same barycenter or centroid position.

Definition at line 154 of file StarDetector.h.

References pos.

operator[]()

component pcl::StarDetector::Star::operator[] ( int  i ) const

inline

Array subscript operator for coordinate selection, compatible with pcl::QuadTree.

Definition at line 173 of file StarDetector.h.

Member Data Documentation

mad

float pcl::StarDetector::Star::mad = 0

Robust average absolute deviation of the fitted PSF with respect to sampled image data.

Definition at line 103 of file StarDetector.h.

pos

DPoint pcl::StarDetector::Star::pos = 0.0

Star position in image coordinates. Corresponds to the centroid of the fitted PSF when PSF fitting is enabled; to the barycenter calculated by the star detection algorithm otherwise.

Definition at line 94 of file StarDetector.h.

Referenced by operator==().

signal

float pcl::StarDetector::Star::signal = 0

Estimated mean signal over the local background within the PSF fitting region. Nonzero only when PSF fitting is enabled.

Definition at line 101 of file StarDetector.h.

---

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

• StarDetector.h