SkyCatalogUtility

class SkyCatalogUtility[source]

Utility class for loading, filtering, and selecting sources from sky catalogs.

__init__(catalog_archive_path=None)[source]
Parameters:

catalog_archive_path (Optional[str], optional) – Path to the catalog archive summary file. If not provided, the path will be set to the catalog_dir in the config.

Methods

get_catalogs(self, ra=None, dec=None, objname=None, fov_ra=1.0, fov_dec=1.0, catalog_type='GAIAXP', catalog_version='v1', fraction_criteria=0.05, query_when_not_archived=True, verbose=False)

Load SkyCatalog instances that overlap with a given coordinate and FOV.

Parameters:

  • ra (float) – The right ascension of the target coordinate.

  • dec (float) – The declination of the target coordinate.

  • objname (str, optional) – The name of the target object.

  • fov_ra (float, optional) – The field of view in right ascension.

  • fov_dec (float, optional) – The field of view in declination.

  • catalog_type (str, optional) – The type of catalog to load.

  • catalog_version (str, optional) – The version of catalog to load.

  • fraction_criteria (float, optional) – The fraction of the catalog that must overlap with the target coordinate and FOV.

  • query_when_not_archived (bool, optional) – Whether to query the catalog when it is not archived.

  • verbose (bool, optional) – Whether to print verbose output.

Returns:

catalogs – The list of SkyCatalog instances that overlap with the target coordinate and FOV.

Return type:

List[SkyCatalog]

select_reference_sources(self, catalog, mag_lower=None, mag_upper=None, **kwargs)

Select reference sources from a given SkyCatalog based on predefined cuts.

Parameters:

  • catalog (SkyCatalog) – The SkyCatalog instance to select reference sources from.

  • mag_lower (Optional[float], optional) – The lower magnitude bound for filtering reference sources.

  • mag_upper (Optional[float], optional) – The upper magnitude bound for filtering reference sources.

  • **kwargs (dict) – Additional keyword arguments to filter reference sources.

Return type:

Tuple[Table, list]

Returns:

  • ref_sources (astropy.table.Table) – The selected reference sources.

  • applied_kwargs (list) – The applied keyword arguments.

Properties