mirar.catalog.kowalski package

Module for catalogs using Kowalski

Submodules

mirar.catalog.kowalski.base_kowalski_catalog module

Module containing the base Kowalski catalog object

class mirar.catalog.kowalski.base_kowalski_catalog.BaseKowalskiXMatch(*args, kowalski: Kowalski | None = None, max_time_ms: float = 10000, **kwargs)

Bases: BaseXMatchCatalog, ABC

Base class for a catalog using Kowalski

property kowalski_filter: dict

Filter for Kowalski query

Returns:

filter

near_query_kowalski(coords: dict) → dict

Performs a Kowalski query around coords

Parameters:

coords – ra/dec

Returns:

crossmatch dict

query(coords) → dict

Uses a Kowalski object to query for sources around coords

Parameters:

coords – ra/dec

Returns:

crossmatch sources

static update_data(data: dict) → dict

For a given catalog, update the data with any extra information

Parameters:

data – kowalski data

Returns:

updated data

exception mirar.catalog.kowalski.base_kowalski_catalog.KowalskiError

Bases: ProcessorError

Error relating to Kowalski

mirar.catalog.kowalski.base_kowalski_catalog.flatten_kowalski_data(matches: list[dict]) → list[dict]

Flatten a Kowalski data dict

Parameters:

matches – List of matches

Returns:

Flattened list of depth-1 dictionaries

mirar.catalog.kowalski.base_kowalski_catalog.get_kowalski() → Kowalski

Get a Kowalski object, using credentials stored in the environment

Returns:

Kowalski object

mirar.catalog.kowalski.gaia module

Module for querying Gaia using Kowalski

class mirar.catalog.kowalski.gaia.Gaia(*args, kowalski: Kowalski | None = None, max_time_ms: float = 10000, **kwargs)

Bases: BaseKowalskiXMatch

Gaia Kowalski catalog

abbreviation = 'gaia'

catalog_name = 'Gaia_EDR3'

property column_dtypes: dict

dtype of columns

property column_names: dict

Name of columns

property dec_column_name: str

Name of Dec column

projection = {'_id': 1, 'dec': 1, 'parallax': 1, 'parallax_error': 1, 'parallax_over_error': 1, 'ra': 1, 'ruwe': 1}

property ra_column_name: str

Name of RA column

class mirar.catalog.kowalski.gaia.GaiaBright(*args, kowalski: Kowalski | None = None, max_time_ms: float = 10000, **kwargs)

Bases: Gaia

Gaia Bright Kowalski catalog (Mg < 14)

abbreviation = 'gaiabright'

property kowalski_filter: dict

Filter for Kowalski query

Returns:

filter

mirar.catalog.kowalski.ps1 module

Module for querying PS1 using Kowalski

class mirar.catalog.kowalski.ps1.PS1(*args, kowalski: Kowalski | None = None, max_time_ms: float = 10000, **kwargs)

Bases: BaseKowalskiXMatch

PS1 Kowalski catalog

abbreviation = 'ps'

catalog_name = 'PS1_DR1'

column_dtypes = {'psdec': <class 'float'>, 'psobjectid': <class 'float'>, 'psra': <class 'float'>, 'sgmag': <class 'float'>, 'simag': <class 'float'>, 'srmag': <class 'float'>, 'szmag': <class 'float'>}

column_names = {'_id': 'psobjectid', 'decMean': 'psdec', 'gMeanPSFMag': 'sgmag', 'iMeanPSFMag': 'simag', 'rMeanPSFMag': 'srmag', 'raMean': 'psra', 'zMeanPSFMag': 'szmag'}

dec_column_name = 'psdec'

projection = {'_id': 1, 'decMean': 1, 'gMeanPSFMag': 1, 'iMeanPSFMag': 1, 'rMeanPSFMag': 1, 'raMean': 1, 'zMeanPSFMag': 1}

ra_column_name = 'psra'

class mirar.catalog.kowalski.ps1.PS1SGSc(*args, kowalski: Kowalski | None = None, max_time_ms: float = 10000, **kwargs)

Bases: BaseKowalskiXMatch

PS1 Star/Galaxy Score Kowalski catalog

abbreviation = 'sgscore'

catalog_name = 'PS1_PSC'

column_dtypes = {'sgscore': <class 'float'>, 'sgscoredec': <class 'float'>, 'sgscoreobjid': <class 'float'>, 'sgscorera': <class 'float'>}

column_names = {'_id': 'sgscoreobjid', 'dec': 'sgscoredec', 'ps_score': 'sgscore', 'ra': 'sgscorera'}

dec_column_name = 'sgscoredec'

projection = {'_id': 1, 'dec': 1, 'ps_score': 1, 'ra': 1}

ra_column_name = 'sgscorera'

class mirar.catalog.kowalski.ps1.PS1STRM(*args, kowalski: Kowalski | None = None, max_time_ms: float = 10000, **kwargs)

Bases: BaseKowalskiXMatch

PS1 STRM Kowalski catalog

abbreviation = 'ps1strm'

catalog_name = 'PS1_STRM'

column_dtypes = {'ps1strmclass': <class 'str'>, 'ps1strmdec': <class 'float'>, 'ps1strmobjid': <class 'float'>, 'ps1strmprobgalaxy': <class 'float'>, 'ps1strmprobqso': <class 'float'>, 'ps1strmprobstar': <class 'float'>, 'ps1strmra': <class 'float'>, 'ps1strmzphot': <class 'float'>, 'ps1strmzphoterr': <class 'float'>}

column_names = {'_id': 'ps1strmobjid', 'class': 'ps1strmclass', 'dec': 'ps1strmdec', 'prob_Galaxy': 'ps1strmprobgalaxy', 'prob_QSO': 'ps1strmprobqso', 'prob_Star': 'ps1strmprobstar', 'ra': 'ps1strmra', 'z_phot': 'ps1strmzphot', 'z_phot_err': 'ps1strmzphoterr'}

dec_column_name = 'ps1strmdec'

projection = {'_id': 1, 'class': 1, 'dec': 1, 'prob_Galaxy': 1, 'prob_QSO': 1, 'prob_Star': 1, 'ra': 1, 'z_phot': 1, 'z_phot_err': 1}

ra_column_name = 'ps1strmra'

mirar.catalog.kowalski.tmass module

Module for querying 2MASS using Kowalski

class mirar.catalog.kowalski.tmass.TMASS(*args, kowalski: Kowalski | None = None, max_time_ms: float = 10000, **kwargs)

Bases: BaseKowalskiXMatch

2MASS Kowalski catalog

abbreviation = 'tm'

catalog_name = '2MASS_PSC'

column_dtypes = {'tmdec': <class 'float'>, 'tmhmag': <class 'float'>, 'tmhmagerr': <class 'float'>, 'tmjmag': <class 'float'>, 'tmjmagerr': <class 'float'>, 'tmkmag': <class 'float'>, 'tmkmagerr': <class 'float'>, 'tmobjectid': <class 'str'>, 'tmph_qual': <class 'str'>, 'tmra': <class 'float'>}

column_names = {'decl': 'tmdec', 'designation': 'tmobjectid', 'h_cmsigcom': 'tmhmagerr', 'h_m': 'tmhmag', 'j_m': 'tmjmag', 'j_msigcom': 'tmjmagerr', 'k_cmsigcom': 'tmkmagerr', 'k_m': 'tmkmag', 'ph_qual': 'tmph_qual', 'ra': 'tmra'}

dec_column_name = 'tmdec'

projection = {'_id': 0, 'decl': 1, 'designation': 1, 'h_cmsigcom': 1, 'h_m': 1, 'j_m': 1, 'j_msigcom': 1, 'k_cmsigcom': 1, 'k_m': 1, 'ph_qual': 1, 'ra': 1}

ra_column_name = 'tmra'

static update_data(data: dict) → dict

For a given catalog, update the data with any extra information

Parameters:

data – kowalski data

Returns:

updated data

mirar.catalog.kowalski.ztf module

Module for querying ZTF using Kowalski

class mirar.catalog.kowalski.ztf.ZTF(*args, kowalski: Kowalski | None = None, max_time_ms: float = 10000, **kwargs)

Bases: BaseKowalskiXMatch

ZTF Kowalski catalog

abbreviation = 'ztf'

catalog_name = 'ZTF_alerts'

column_dtypes = {'ztfdec': <class 'float'>, 'ztfdrb': <class 'float'>, 'ztfid': <class 'str'>, 'ztfname': <class 'str'>, 'ztfra': <class 'float'>, 'ztfrb': <class 'float'>}

column_names = {'_id': 'ztfid', 'candidate.dec': 'ztfdec', 'candidate.drb': 'ztfdrb', 'candidate.ra': 'ztfra', 'candidate.rb': 'ztfrb', 'objectId': 'ztfname'}

dec_column_name = 'ztfdec'

projection = {'_id': 1, 'candidate.dec': 1, 'candidate.drb': 1, 'candidate.ra': 1, 'candidate.rb': 1, 'objectId': 1}

ra_column_name = 'ztfra'