star


Defines

#define cleanup
#define cleanup
#define cleanup
#define cleanup
#define cleanup
#define cleanup
#define cleanup
#define LIST_DEFINE
#define LIST_ELEM   fors_star

Functions

fors_starfors_star_new (double x, double y, double fwhm, double smajor, double sminor, double orientation, double m, double dm, double si)
 Constructor.
fors_starfors_star_duplicate (const fors_star *star)
 Copy constructor.
void fors_star_delete (fors_star **star)
 Delete object and set pointer to NULL.
void fors_star_delete_but_standard (fors_star **star)
 Delete object and set pointer to NULL - but ignore the standard star.
bool fors_star_equal (const fors_star *s, const fors_star *t)
 Test for equality.
bool fors_star_brighter_than (const fors_star *s1, const fors_star *s2, void *data)
 Compare star brightness.
double fors_star_distsq (const fors_star *s, const fors_star *t)
 Get distance between stars.
double fors_star_extension (const fors_star *s, void *data)
 Get star size.
double fors_star_stellarity (const fors_star *s, void *data)
 Get star stellarity.
double fors_star_ellipticity (const fors_star *s, void *data)
 Get star ellipticity.
void fors_star_print (cpl_msg_severity level, const fors_star *s)
 Print object.
void fors_star_print_list (cpl_msg_severity level, const fors_star_list *sl)
 Print list of stars.
double fors_star_get_x (const fors_star *s, void *data)
 Get position.
double fors_star_get_y (const fors_star *s, void *data)
 Get position.
double fors_star_get_zeropoint (const fors_star *s, void *data)
 Get zeropoint.
double fors_star_get_zeropoint_err (const fors_star *s, void *data)
 Get zeropoint error.
bool fors_star_is_identified (const fors_star *s, void *data)
 Determine if star was identified.

Detailed Description

A data type used to represent stars on a CCD (position, magnitude, etc.)

Function Documentation

fors_star* fors_star_new double  x,
double  y,
double  fwhm,
double  smajor,
double  sminor,
double  orientation,
double  m,
double  dm,
double  si
 

Constructor.

Parameters:
x 1st coordinate
y 2nd coordinate
fwhm full width half maximum
smajor semi-major axis length
sminor semi-minor axis length
orientation angle between semi-major axis and x-axis
m magnitude
dm magnitude error
si stellarity index
Returns:
newly allocated star

Definition at line 65 of file fors_star.c.

References assure, and fors_point_new().

Referenced by extract_sex(), extract_test(), test_identify(), and test_star().

fors_star* fors_star_duplicate const fors_star star  ) 
 

Copy constructor.

Parameters:
star to duplicate
Returns:
newly allocated star

Definition at line 110 of file fors_star.c.

References assure, fors_point_duplicate(), _fors_star::id, and _fors_star::pixel.

Referenced by get_image_quality(), get_zeropoint(), test_identify(), and test_star().

void fors_star_delete fors_star **  star  ) 
 

Delete object and set pointer to NULL.

Parameters:
star to delete

Definition at line 133 of file fors_star.c.

References fors_point_delete().

Referenced by entry_delete(), and get_zeropoint().

void fors_star_delete_but_standard fors_star **  star  ) 
 

Delete object and set pointer to NULL - but ignore the standard star.

Parameters:
star to delete

Definition at line 149 of file fors_star.c.

References fors_point_delete().

Referenced by entry_delete_but_standard().

bool fors_star_equal const fors_star s,
const fors_star t
 

Test for equality.

Parameters:
s 1st star
t 2nd star
Returns:
true if and only if the two stars compare equal

Definition at line 165 of file fors_star.c.

References assure, fors_point_equal(), and _fors_star::pixel.

Referenced by get_zeropoint(), and test_star().

bool fors_star_brighter_than const fors_star s1,
const fors_star s2,
void *  data
 

Compare star brightness.

Parameters:
s1 1st star
s2 2nd star
data not used
Returns:
true iff s1 is brighter than s2

Definition at line 183 of file fors_star.c.

References _fors_star::magnitude.

Referenced by star_brighter_than().

double fors_star_distsq const fors_star s,
const fors_star t
 

Get distance between stars.

Parameters:
s 1st star
t 2nd star
Returns:
squared distance between stars

Definition at line 199 of file fors_star.c.

References assure, fors_point_distsq(), and _fors_star::pixel.

Referenced by test_star().

double fors_star_extension const fors_star s,
void *  data
 

Get star size.

Parameters:
s star
data not used
Returns:
average extension (one sigma)

Definition at line 215 of file fors_star.c.

References assure, and _fors_star::fwhm.

Referenced by get_image_quality().

double fors_star_stellarity const fors_star s,
void *  data
 

Get star stellarity.

Parameters:
s star
data not used
Returns:
stellarity index

Definition at line 232 of file fors_star.c.

References assure, and _fors_star::stellarity_index.

Referenced by get_image_quality().

double fors_star_ellipticity const fors_star s,
void *  data
 

Get star ellipticity.

Parameters:
s star
data not used
Returns:
geometric average of semi major/minor axes length

Definition at line 248 of file fors_star.c.

References assure, _fors_star::semi_major, and _fors_star::semi_minor.

Referenced by fors_create_sources_table(), and get_image_quality().

void fors_star_print cpl_msg_severity  level,
const fors_star s
 

Print object.

Parameters:
level message level
s to print at the info level

Definition at line 262 of file fors_star.c.

References _fors_star::dmagnitude, _fors_star::dmagnitude_corr, _fors_star::magnitude, _fors_star::magnitude_corr, _fors_star::orientation, _fors_star::pixel, _fors_star::semi_major, and _fors_star::semi_minor.

Referenced by entry_list_print(), and fors_star_print_list().

void fors_star_print_list cpl_msg_severity  level,
const fors_star_list *  sl
 

Print list of stars.

Parameters:
level message level
sl list to print

Definition at line 285 of file fors_star.c.

References fors_star_print().

double fors_star_get_x const fors_star s,
void *  data
 

Get position.

Parameters:
s star
data not used
Returns:
x-position

Definition at line 306 of file fors_star.c.

References assure, and _fors_star::pixel.

Referenced by fors_identify().

double fors_star_get_y const fors_star s,
void *  data
 

Get position.

Parameters:
s star
data not used
Returns:
y-position

Definition at line 322 of file fors_star.c.

References assure, and _fors_star::pixel.

Referenced by fors_identify().

double fors_star_get_zeropoint const fors_star s,
void *  data
 

Get zeropoint.

Parameters:
s star, must be identified
data not used
Returns:
zeropoint

Definition at line 339 of file fors_star.c.

References assure, _fors_star::id, and _fors_star::magnitude_corr.

Referenced by fors_create_sources_table(), get_zeropoint(), and zeropoint_inside().

double fors_star_get_zeropoint_err const fors_star s,
void *  data
 

Get zeropoint error.

Parameters:
s star, must be identified
data not used
Returns:
zeropoint error

Definition at line 355 of file fors_star.c.

References assure, _fors_star::dmagnitude_corr, and _fors_star::id.

Referenced by fors_create_sources_table(), get_zeropoint(), and zeropoint_inside().

bool fors_star_is_identified const fors_star s,
void *  data
 

Determine if star was identified.

Parameters:
s star
data not used
Returns:
true iff star is identified

Definition at line 372 of file fors_star.c.

References assure, and _fors_star::id.

Referenced by get_zeropoint().


Generated on Wed Sep 10 07:31:55 2008 for FORS Pipeline Reference Manual by  doxygen 1.4.6