ConvertReferenceCatalogConfig#

class lsst.meas.algorithms.ConvertReferenceCatalogConfig(*args, **kw)#

Bases: Config

Attributes Summary

`coord_err_unit`	Unit of RA/Dec error fields (astropy.unit.Unit compatible) (`str`, default `None`)
`dataset_config`	Configuration for reading the ingested data (`DatasetConfig`, default `<class 'lsst.meas.algorithms.convertReferenceCatalog.DatasetConfig'>`)
`dec_err_name`	Name of Dec error column (`str`, default `None`)
`dec_name`	Name of Dec column (values in decimal degrees) (`str`)
`epoch_format`	Format of epoch column: any value accepted by astropy.time.Time, e.g. 'iso' or 'unix' (`str`, default `None`).
`epoch_name`	Name of epoch column (`str`, default `None`)
`epoch_scale`	Scale of epoch column: any value accepted by astropy.time.Time, e.g. 'utc' (`str`, default `None`).
`extra_col_names`	Extra columns to add to the reference catalog.
`file_reader`	Task to use to read the files.
`full_position_information`	Include epoch, proper motions, parallax, and covariances between sky coordinates, proper motion, and parallax in the schema.
`id_name`	Name of column to use as an identifier (optional).
`is_photometric_name`	Name of column stating if satisfactory for photometric calibration (optional).
`is_resolved_name`	Name of column stating if the object is resolved (optional).
`is_variable_name`	Name of column stating if the object is measured to be variable (optional).
`mag_column_list`	The values in the reference catalog are assumed to be in AB magnitudes.
`mag_err_column_map`	A map of magnitude column name (key) to magnitude error column (value).
`manager`	Multiprocessing manager to perform the actual conversion of values, file-by-file.
`n_processes`	Number of python processes to use when ingesting.
`parallax_err_name`	Name of parallax error column (`str`, default `None`)
`parallax_name`	Name of parallax column (`str`, default `None`)
`parallax_scale`	Scale factor by which to multiply parallax values to obtain units of milliarcsec (`float`, default `1.0`)
`pm_dec_err_name`	Name of proper motion Dec error column (`str`, default `None`)
`pm_dec_name`	Name of proper motion Dec column (`str`, default `None`)
`pm_ra_err_name`	Name of proper motion RA error column (`str`, default `None`)
`pm_ra_name`	Name of proper motion RA column (`str`, default `None`)
`pm_scale`	Scale factor by which to multiply proper motion values to obtain units of milliarcsec/year (`float`, default `1.0`)
`ra_err_name`	Name of RA error column (`str`, default `None`)
`ra_name`	Name of RA column (values in decimal degrees) (`str`)

Methods Summary

`setDefaults`()	Subclass hook for computing defaults.
`validate`()	Validate the Config, raising an exception if invalid.

Attributes Documentation

coord_err_unit#: Unit of RA/Dec error fields (astropy.unit.Unit compatible) (str, default None)

dataset_config#: Configuration for reading the ingested data (DatasetConfig, default <class 'lsst.meas.algorithms.convertReferenceCatalog.DatasetConfig'>)

dec_err_name#: Name of Dec error column (str, default None)

dec_name#: Name of Dec column (values in decimal degrees) (str)

epoch_format#: Format of epoch column: any value accepted by astropy.time.Time, e.g. ‘iso’ or ‘unix’ (str, default None)

epoch_name#: Name of epoch column (str, default None)

epoch_scale#: Scale of epoch column: any value accepted by astropy.time.Time, e.g. ‘utc’ (str, default None)

extra_col_names#: Extra columns to add to the reference catalog. (List, default [])

file_reader#: Task to use to read the files. Default is to expect text files. (ConfigurableInstance, default <class 'lsst.meas.algorithms.readTextCatalogTask.ReadTextCatalogConfig'>)

full_position_information#: Include epoch, proper motions, parallax, and covariances between sky coordinates, proper motion, and parallax in the schema. If true, a custom ConvertRefcatManager class must exist to compute the output covariances. (bool, default False)

id_name#: Name of column to use as an identifier (optional). (str, default None)

is_photometric_name#: Name of column stating if satisfactory for photometric calibration (optional). (str, default None)

is_resolved_name#: Name of column stating if the object is resolved (optional). (str, default None)

is_variable_name#: Name of column stating if the object is measured to be variable (optional). (str, default None)

mag_column_list#: 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. (List)

mag_err_column_map#: A map of magnitude column name (key) to magnitude error column (value). (Dict, default {})

manager#: Multiprocessing manager to perform the actual conversion of values, file-by-file. (ConfigurableInstance, default <class 'lsst.meas.algorithms.convertRefcatManager.ConvertRefcatManagerConfig'>)

n_processes#: Number of python processes to use when ingesting. (int, default 1)

parallax_err_name#: Name of parallax error column (str, default None)

parallax_name#: Name of parallax column (str, default None)

parallax_scale#: Scale factor by which to multiply parallax values to obtain units of milliarcsec (float, default 1.0)

pm_dec_err_name#: Name of proper motion Dec error column (str, default None)

pm_dec_name#: Name of proper motion Dec column (str, default None)

pm_ra_err_name#: Name of proper motion RA error column (str, default None)

pm_ra_name#: Name of proper motion RA column (str, default None)

pm_scale#: Scale factor by which to multiply proper motion values to obtain units of milliarcsec/year (float, default 1.0)

ra_err_name#: Name of RA error column (str, default None)

ra_name#: Name of RA column (values in decimal degrees) (str)

Methods Documentation

setDefaults()#: Subclass hook for computing defaults.

Notes#

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

validate()#

Validate the Config, raising an exception if invalid.

Raises#

lsst.pex.config.FieldValidationError: Raised if verification fails.

Notes#

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.