build_catalog¶
- giant.catalogs.gaia.build_catalog(catalog_file=None, giant_catalog_file=None, limiting_magnitude=14.0, blending_magnitude=8.0, limiting_separation=0.04, number_of_stars=0)[source]¶
- Build a local GIANT catalog:
from the GAIA database for faster query times
from a local GIANT catalog for different star blending options
This function can be used to build a new GIANT catalog (or overwrite an old one) from the GAIA star catalog. Typically a user will not use this directly and instead will use the command line utility
build_catalog.If you want to use this function, you can adjust how (and where) the catalog is built by adjusting the arguments. Note that this will require downloading the GAIA catalog (if it isn’t already available). In addition, building the catalog can take a long time, so you will want to have a period where you can leave this run for a while without interruption to ensure that the catalog is built successfully and not corrupted.
- Parameters:
catalog_file (Path | str | None) – The file to save the giant catalog database to
giant_catalog_file (Path | str | None) – The filepath containing a pre-built local giant catalog from which to build the new giant catalog from.
limiting_magnitude (float) – The maximum magnitude to include in the catalog
blending_magnitude (float) – The magnitude of the blended star for it to be included as a blended star in the catalog.
limiting_separation (float) – The maximum separation between stars for them to be considered for blending in degrees. Typically this should be set to around the IFOV on the detector you are considering.
number_of_stars (int) – The maximum number of stars that can be blended together in any group. To turn off star blending, set this to 0.
