mirar.catalog.vizier package

Module for catalogs using Vizier

Submodules

mirar.catalog.vizier.base_vizier_catalog module

Module containing base class for a Vizier catalog

class mirar.catalog.vizier.base_vizier_catalog.VizierCatalog(*args, snr_threshold: float = 3.0, **kwargs)[source]

Bases: BaseCatalog, ABC

Base class for a catalog generated using Vizier

property catalog_vizier_code: str | list[str]

Code of catalog in Vizier

static check_coverage(ra_deg: float, dec_deg: float)[source]

Perform any available coverage check, to see if catalog covers ra/dec position

Parameters:

  • ra_deg – Ra

  • dec_deg – Dec

Returns:

None

property dec_key

Key for dec values

property extra_columns: list[str]

Code of catalog in Vizier

filter_catalog(table: Table) → Table[source]

Filters catalog to include a subset of sources, if required

get_catalog(ra_deg: float, dec_deg: float) → Table[source]

Returns a catalog centered on ra/dec

Parameters:

  • ra_deg – RA

  • dec_deg – Dec

Returns:

Catalog

get_column_filters() → dict[source]

Returns the column filters to be applied to the query

get_mag_error_key() → str[source]

Returns the key for mag error in table

Returns:

Mag error key

get_mag_key() → str[source]

Returns the key for mag in table

Returns:

Mag key

join_query(query: dict) → Table[source]

Join the query results into a single table

Parameters:

query – Query results

Returns:

Table

property ra_key

Key for RA values

exception mirar.catalog.vizier.base_vizier_catalog.VizierError[source]

Bases: ProcessorError

Class for errors in Vizier catalog

mirar.catalog.vizier.gaia module

Module for querying Gaia catalog

class mirar.catalog.vizier.gaia.GaiaVizier(*args, snr_threshold: float = 3.0, **kwargs)[source]

Bases: VizierCatalog

Gaia DR3 catalog

property abbreviation

Abbreviation for naming catalog files

catalog_vizier_code = ['I/355/gaiadr3']
dec_key = 'DE_ICRS'
property extra_columns: list[str]

Code of catalog in Vizier

get_catalog(ra_deg: float, dec_deg: float) → Table[source]

Query the Gaia catalog for sources around a given position

Parameters:

  • ra_deg – Right ascension in degrees

  • dec_deg – Declination in degrees

Returns:

Table of sources

get_column_filters() → dict[source]

Get the column filters for the catalog

Returns:

Column filters

get_mag_key() → str[source]

Returns the key for mag in table

Returns:

Mag key

ra_key = 'RA_ICRS'

mirar.catalog.vizier.gaia2mass module

Module for querying Gaia catalog

class mirar.catalog.vizier.gaia2mass.Gaia2MassVizier(*args, filter_name: str = 'j', snr_threshold: float = 5, trim: bool = False, image_catalog_path: str | None = None, acceptable_j_ph_quals: str | list[str] = None, acceptable_h_ph_quals: str | list[str] = None, acceptable_k_ph_quals: str | list[str] = None, **kwargs)[source]

Bases: BaseGaia2Mass, VizierCatalog

Gaia DR3 catalog

catalog_vizier_code = ['I/355/gaiadr3', 'II/246/out']
dec_key = 'DE_ICRS'
get_column_filters() → dict[source]

Get the column filters for the catalog

Returns:

Column filters

get_mag_key() → str[source]

Returns the key for mag in table

Returns:

Mag key

get_source_table(ra_deg: float, dec_deg: float) → Table[source]

Query the Gaia catalog for sources around a given position

Parameters:

  • ra_deg – Right ascension in degrees

  • dec_deg – Declination in degrees

Returns:

Table of sources

join_query(query: dict) → Table[source]

Join the two queries together

Parameters:

query

Returns:

ra_key = 'RA_ICRS'

mirar.catalog.vizier.ps1 module

Module for querying PS1 catalog

exception mirar.catalog.vizier.ps1.NotInPS1Error[source]

Bases: ProcessorError

Error for source not in PS1 field

class mirar.catalog.vizier.ps1.PS1(*args, snr_threshold: float = 3.0, **kwargs)[source]

Bases: VizierCatalog

PanStarrs 1 catalog

abbreviation = 'ps1'
catalog_vizier_code = 'II/349'
static check_coverage(ra_deg: float, dec_deg: float)[source]

Perform any available coverage check, to see if catalog covers ra/dec position

Parameters:

  • ra_deg – Ra

  • dec_deg – Dec

Returns:

None

dec_key = 'DEJ2000'
filter_catalog(table: Table) → Table[source]

Filters catalog to include a subset of sources, if required

ra_key = 'RAJ2000'
class mirar.catalog.vizier.ps1.PS1StarGal(*args, snr_threshold: float = 3.0, **kwargs)[source]

Bases: VizierCatalog

PanStarrs 1 (PS1) Point Source Catalog (PSC) catalog with Star/Galaxy separation by Y. Tachibana & A. A. Miller ref: https://iopscience.iop.org/article/10.1088/1538-3873/aae3d9

abbreviation = 'ps1_stargal'
catalog_vizier_code = ['II/381/hlsp_ps1_tm', 'II/349']
static check_coverage(ra_deg: float, dec_deg: float)[source]

Perform any available coverage check, to see if catalog covers ra/dec position

Parameters:

  • ra_deg – Ra

  • dec_deg – Dec

Returns:

None

dec_key = 'DEJ2000'
join_query(query: dict) → Table[source]

Join the two queries (PS1 and PS1_TM catalogs) together, since PS1_TM only has columns {objid, position, psScore}.

Parameters:

query

Returns:

ra_key = 'RAJ2000'
mirar.catalog.vizier.ps1.in_ps1(dec_deg: float) → bool[source]

Is a given position in PS1?

Parameters:

dec_deg – Declination

Returns:

Boolean

mirar.catalog.vizier.sdss module

Module containing SDSS Vizier catalog

exception mirar.catalog.vizier.sdss.NotInSDSSError[source]

Bases: ProcessorError

Error for source not in SDSS field

class mirar.catalog.vizier.sdss.SDSS(*args, snr_threshold: float = 3.0, **kwargs)[source]

Bases: VizierCatalog

SDSS Vizier catalog

abbreviation = 'sdss'
catalog_vizier_code = 'V/154'
static check_coverage(ra_deg: float, dec_deg: float)[source]

Perform any available coverage check, to see if catalog covers ra/dec position

Parameters:

  • ra_deg – Ra

  • dec_deg – Dec

Returns:

None

dec_key = 'DE_ICRS'
ra_key = 'RA_ICRS'
mirar.catalog.vizier.sdss.get_sdss_coverage() → PolygonList[source]

Get the SDSS coverahe map

Returns:

coverage map

mirar.catalog.vizier.sdss.in_sdss(ra_deg: float, dec_deg: float) → bool[source]

Check whether a given coordinate was covered by SDSS

Parameters:

  • ra_deg – RA

  • dec_deg – dec

Returns:

boolean

mirar.catalog.vizier.skymapper module

Module containing Skymapper Vizier catalog

exception mirar.catalog.vizier.skymapper.NotInSkymapperError[source]

Bases: ProcessorError

Error for source not in Skymapper

class mirar.catalog.vizier.skymapper.SkyMapper(*args, snr_threshold: float = 3.0, **kwargs)[source]

Bases: VizierCatalog

Skymapper catalog from Vizier

abbreviation = 'skymapper'
catalog_vizier_code = 'II/358'
static check_coverage(ra_deg: float, dec_deg: float)[source]

Perform any available coverage check, to see if catalog covers ra/dec position

Parameters:

  • ra_deg – Ra

  • dec_deg – Dec

Returns:

None

dec_key = 'DEICRS'
property extra_columns: list[str]

Code of catalog in Vizier

get_mag_key()[source]

Returns the key for mag in table

Returns:

Mag key

ra_key = 'RAICRS'
mirar.catalog.vizier.skymapper.in_skymapper(dec_deg: float) → bool[source]

Is a given position in skymapper?

Parameters:

dec_deg – Declination

Returns:

Boolean