query_catalog

giant.catalogs.gaia:

Gaia.query_catalog(ids=None, min_ra=0.0, max_ra=360.0, min_dec=-90.0, max_dec=90.0, min_mag=-4.0, max_mag=14.0, search_center=None, search_radius=None, new_epoch=None)[source]

This method queries stars from the catalog 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 include_proper_motion is True then this will shift the stars to the new epoch input by the user (new_epoch) using proper motion.

Parameters:

  • ids (Iterable[str | int] | Set[str | int] | None) – A sequence of star ids to retrieve from the catalog. The ids are given by the index of the returned data frame (the designation column from the actual catalog) and should be input as an iterable that yields either integers or strings in an appropriate format

  • min_ra (float) – The minimum ra bound to query stars from in degrees

  • max_ra (float) – The maximum ra bound to query stars from in degrees

  • min_dec (float) – The minimum declination to query stars from in degrees

  • max_dec (float) – The maximum declination to query stars from in degrees

  • min_mag (float) – The minimum magnitude to query stars from. Recall that magnitude is inverse (so lower magnitude is a dimmer star)

  • max_mag (float) – The maximum magnitude to query stars from. Recall that magnitude is inverse (so higher magnitude is a dimmer star)

  • search_center (Sequence[float] | ndarray[tuple[Any, ...], dtype[float64]] | None) – The center of a search cone as a ra/dec pair.

  • search_radius (float | None) – The radius about the center of the search cone

  • new_epoch (datetime | float | None) – The epoch to translate the stars to using proper motion if include_proper_motion is turned on

Returns:

A pandas DataFrame with columns GIANT_COLUMNS.

Return type:

DataFrame