SourceListData

class stellarphot.SourceListData(*args, input_data=None, colname_map=None, **kwargs)

Bases: BaseEnhancedTable

A class to hold information on the source lists to pass to aperture photometry routines. It verifies either image-based locations (x/y) or sky-based locations (ra/dec) exist.

Parameters:

input_data: `astropy.table.Table`, optional (Default: None)

A table containing all the source list data to be validated. This data is copied, so any changes made during validation will not affect the input data, only the data in the class.

colname_map: dict, optional (Default: None)

A dictionary containing old column names as keys and new column names as values. This is used to automatically update the column names to the desired names BEFORE the validation is performed.

Attributes:

has_ra_dec: bool

True if the table has sky-based locations (ra/dec), False otherwise.

has_x_y: bool

True if the table has image-based locations (x/y), False otherwise.

Notes

For validation of inputs, you must provide input_data, if you do not, an empty table will be returned.

input_data MUST contain the following columns in the following column:

Column Name	Unit
star_id	None

In addition to the star_id columns you must have EITHER

Column Name	Unit
ra	u.deg
dec	u.deg

and/or

Column Name	Unit
xcenter	u.pix
ycenter	u.pix

to define the locations of the sources. If one locaton pair is provided but not the other, the missing columns will be added but assigned NaN values. It is ok to provide both sky and image location, but no validation is done to ensure they are consistent.

Attributes Summary

has_ra_dec
has_x_y
sourcelist_descript

Methods Summary

drop_ra_dec()
drop_x_y()

Attributes Documentation

has_ra_dec

has_x_y

sourcelist_descript = {'dec': Unit("deg"), 'ra': Unit("deg"), 'star_id': None, 'xcenter': Unit("pix"), 'ycenter': Unit("pix")}

Methods Documentation

drop_ra_dec()

drop_x_y()