IngestGaiaReferenceTask

IngestGaiaReferenceTask acts as a special-cased version of the refcat ingester for Gaia DR2.

Python API summary

from lsst.meas.algorithms.ingestIndexReferenceTask import IngestGaiaReferenceTask
classIngestGaiaReferenceTask(*args, **kwargs)

A special-cased version of the refcat ingester for Gaia DR2...

attributeconfig

Access configuration fields and retargetable subtasks.

See also

See the IngestGaiaReferenceTask API reference for complete details.

Retargetable subtasks

file_reader

Default
lsst.meas.algorithms.readTextCatalogTask.ReadTextCatalogTask
Field type
ConfigurableField
Task to use to read the files. Default is to expect text files.

Configuration fields

coord_err_unit

Default
None
Field type
str Field (optional)
Unit of RA/Dec error fields (astropy.unit.Unit compatible)

dataset_config

Data type
lsst.meas.algorithms.ingestIndexReferenceTask.DatasetConfig
Field type
ConfigField
Configuration for reading the ingested data

dec_err_name

Default
None
Field type
str Field (optional)
Name of Dec error column

dec_name

Default
None
Field type
str Field
Name of Dec column (values in decimal degrees)

epoch_format

Default
None
Field type
str Field (optional)
Format of epoch column: any value accepted by astropy.time.Time, e.g. ‘iso’ or ‘unix’

epoch_name

Default
None
Field type
str Field (optional)
Name of epoch column

epoch_scale

Default
None
Field type
str Field (optional)
Scale of epoch column: any value accepted by astropy.time.Time, e.g. ‘utc’

extra_col_names

Default
[]
Field type
str ListField
Extra columns to add to the reference catalog.

id_name

Default
None
Field type
str Field (optional)
Name of column to use as an identifier (optional).

is_photometric_name

Default
None
Field type
str Field (optional)
Name of column stating if satisfactory for photometric calibration (optional).

is_resolved_name

Default
None
Field type
str Field (optional)
Name of column stating if the object is resolved (optional).

is_variable_name

Default
None
Field type
str Field (optional)
Name of column stating if the object is measured to be variable (optional).

mag_column_list

Default
None
Field type
str ListField
The values in the reference catalog are assumed to be in AB magnitudes. List of column names to use for photometric information. At least one entry is required.

mag_err_column_map

Default
{}
Field type
DictField
Key type
str
Value type
str
A map of magnitude column name (key) to magnitude error column (value).

n_processes

Default
1
Field type
int Field
Number of python processes to use when ingesting.

parallax_err_name

Default
None
Field type
str Field (optional)
Name of parallax error column

parallax_name

Default
None
Field type
str Field (optional)
Name of parallax column

parallax_scale

Default
1.0
Field type
float Field
Scale factor by which to multiply parallax values to obtain units of milliarcsec

pm_dec_err_name

Default
None
Field type
str Field (optional)
Name of proper motion Dec error column

pm_dec_name

Default
None
Field type
str Field (optional)
Name of proper motion Dec column

pm_ra_err_name

Default
None
Field type
str Field (optional)
Name of proper motion RA error column

pm_ra_name

Default
None
Field type
str Field (optional)
Name of proper motion RA column

pm_scale

Default
1.0
Field type
float Field
Scale factor by which to multiply proper motion values to obtain units of milliarcsec/year

ra_err_name

Default
None
Field type
str Field (optional)
Name of RA error column

ra_name

Default
None
Field type
str Field
Name of RA column (values in decimal degrees)