UCAC4.query_catalogue¶
- UCAC4.query_catalogue(ids=None, min_ra=0, max_ra=360, min_dec=-90, max_dec=90, min_mag=-4, max_mag=20, search_center=None, search_radius=None, new_epoch=None)[source]¶
This method queries stars from the catalogue that meet specified constraints and returns them as a DataFrame with columns of
GIANT_COLUMNS
.Stars can either be queried by ID directly or by right ascension/declination/magnitude. You cannot filter using both with this method. If
apply_proper_motion
isTrue
then this will shift the stars to the new epoch input by the user (new_epoch
) using proper motion.- Parameters:
ids (Sequence | ndarray | None) – A sequence of star ids to retrieve from the catalogue. The ids are given by zone, rnz and should be input as an iterable that yields tuples (therefore if you have a dataframe you should do
df.itertuples(false)
min_ra (Real) – The minimum ra bound to query stars from in degrees
max_ra (Real) – The maximum ra bound to query stars from in degrees
min_dec (Real) – The minimum declination to query stars from in degrees
max_dec (Real) – The maximum declination to query stars from in degrees
min_mag (Real) – The minimum magnitude to query stars from. Recall that magnitude is inverse (so lower magnitude is a dimmer star)
max_mag (Real) – The maximum magnitude to query stars from. Recall that magnitude is inverse (so higher magnitude is a dimmer star)
search_center (Sequence | ndarray | None) – The center of a search cone as a ra/dec pair.
search_radius (Real | None) – The radius about the center of the search cone
new_epoch (datetime | Real | None) – The epoch to translate the stars to using proper motion if
apply_proper_motion
is turned on
- Returns:
A Pandas dataframe with columns
GIANT_COLUMNS
.- Return type:
DataFrame