UCAC4.dump_to_sqlite

giant.catalogs.ucac:

UCAC4.dump_to_sqlite(database_connection, limiting_mag=20, use_tycho_mag=False, return_locations=False, return_mag=None)[source]

Use this to write the catalog to a sqlite3 database in the GIANT format.

You can control what stars/data are included using the key word argument inputs. You can also have this return the star magnitude/locations for doing blending stars.

In general you should not use this directly. Instead you should use build_catalog() or script build_catalog.

Parameters:

  • database_connection (Connection) – The connection to the database the data is to be dumped to

  • limiting_mag (float) – The maximum magnitude to include in the catalog. This is based off of the APASM_V magnitude or the UCAC4 magm magnitude, depending on which is available

  • use_tycho_mag (bool) – This flag stores the magnitude from the Tycho2 catalog for each star that is in the Tycho2 catalog. Note that this will be very slow.

  • return_locations (bool) – This flag specifies to return locations for stars for doing blending

  • return_mag (float | None) – This flag specifies to only return locations for stars that are brighter than this magnitude. If None then all stars are returned.

Returns:

A dataframe of the dumped stars that meet the return_mag condition or None if return_locations is False

Return type:

DataFrame | None