CatalogSet

class CatalogSet[source]

CatalogSet class for managing a set of catalogs.

This class provides methods

  1. Search for catalogs in the given folder.

  2. Select catalogs with given criteria.

  3. Exclude catalogs with given criteria.

  4. Add catalogs to the set.

  5. Merge catalogs into single table.

  6. Select sources from each Catalog instance.

__init__(catalogs=None)[source]

Initialize the CatalogSet class.

Parameters:

catalogs (list[Catalog], optional) – List of Catalog instances. Defaults to None. If None, the CatalogSet will be dummy instance.

Methods

merge_catalogs(self, max_distance_arcsec=3.0, ra_key='X_WORLD', dec_key='Y_WORLD', data_keys=['MAGSKY_AUTO', 'MAGERR_AUTO', 'ZP_AUTO', 'ZPERR_AUTO', 'MAGSKY_APER', 'MAGERR_APER', 'ZP_APER', 'ZPERR_APER', 'MAGSKY_APER_1', 'MAGERR_APER_1', 'ZP_APER_1', 'ZPERR_APER_1', 'MAGSKY_APER_2', 'MAGERR_APER_2', 'ZP_APER_2', 'ZPERR_APER_2', 'MAGSKY_APER_3', 'MAGERR_APER_3', 'ZP_APER_3', 'ZPERR_APER_3', 'MAGSKY_CIRC', 'MAGERR_CIRC'], join_type='outer')

Merge catalogs into single table.

Parameters:
  • max_distance_arcsec (float, optional) – Maximum distance in arcseconds for matching sources.

  • ra_key (str, optional) – Column name for right ascension.

  • dec_key (str, optional) – Column name for declination.

  • data_keys (list[str], optional) – List of column names for data.

  • join_type (str, optional) – Type of join to use.

Returns:

  • merged_tbl (astropy.table.Table) – Merged table of catalogs.

  • metadata (dict) – Metadata of catalogs.

exclude_catalogs(self, file_key=None, filter=None, exptime=None, objname=None, obs_start=None, obs_end=None, seeing=None, depth=None, observatory=None, telname=None)

Exclude catalogs that match the given criteria from self.catalogs.

Select catalogs from self.catalogs and update self.target_catalogs.

Parameters:
  • file_key (str, optional) – File key to exclude.

  • filter (str, optional) – Filter to exclude.

  • exptime (float, optional) – Exposure time to exclude.

  • objname (str, optional) – Object name to exclude.

  • obs_start (str, optional) – Observation start time to exclude.

  • obs_end (str, optional) – Observation end time to exclude.

  • seeing (float, optional) – Seeing to exclude.

  • depth (float, optional) – Depth to exclude.

  • observatory (str, optional) – Observatory to exclude.

  • telname (str, optional) – Telescope name to exclude.

Return type:

None

select_catalogs(self, file_key=None, filter=None, exptime=None, objname=None, obs_start=None, obs_end=None, seeing=None, depth=None, observatory=None, telname=None)

Select catalogs that match the given criteria from self.catalogs.

Select catalogs from self.catalogs and update self.target_catalogs.

Parameters:
  • file_key (str, optional) – File key to select.

  • filter (str, optional) – Filter to select.

  • exptime (float, optional) – Exposure time to select.

  • objname (str, optional) – Object name to select.

  • obs_start (str, optional) – Observation start time to select.

  • obs_end (str, optional) – Observation end time to select.

  • seeing (float, optional) – Seeing to select.

  • depth (float, optional) – Depth to select.

  • observatory (str, optional) – Observatory to select.

  • telname (str, optional) – Telescope name to select.

Return type:

None

select_sources(self, x, y, unit='coord', matching_radius=60, x_key='X_WORLD', y_key='Y_WORLD')

Select sources from all catalogs within the given radius around the input coordinates.

Each catalog will be updated with the selected sources.

Parameters:
  • ra (float) – Right Ascension in degrees.

  • dec (float) – Declination in degrees.

  • radius (float) – Search radius in arcseconds.

Return type:

None

Properties

Key Properties

Property

Description

df

Pandas DataFrame of all catalogs (cached).

target_df

DataFrame of selected catalogs.