UCAC4.query_catalogue_raw

giant.catalogues.ucac:

UCAC4.query_catalogue_raw(ids=None, min_ra=0.0, max_ra=360.0, min_dec=-90.0, max_dec=90.0, search_center=None, search_radius=None, max_visual_mag=20.0, min_visual_mag=-1.44, generator=False)[source]

This method queries stars from the catalogue that meet specified constraints and returns them as a DataFrame or as an iterable of dataframes where the columns are the raw catalogue files.

Stars can either be queried by ID directly or by right ascension/declination/magnitude. You cannot filter using both with this method. This method is not usable by GIANT and it does not apply proper motion. If you need records that are usable by GIANT and with proper motion applied see query_catalogue(). For details on what the columns are refer to the UCAC4 documentation (can be found online).

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_visual_mag (Real) – The minimum visual magnitude to query stars from. Recall that magnitude is inverse (so lower magnitude is a dimmer star)

  • max_visual_mag (Real) – The maximum visual 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

  • generator (bool) – A boolean flag specifying whether to return the stars as a generator (preserving memory) or to to collect all of the stars into a single dataframe. If True then the function will yield dataframes (which may themselves contain single or multiple stars).

Returns:

A (Iterable of) Pandas dataframe(s) with columns according to the catalogue columns.

Return type:

DataFrame | Iterable[DataFrame]