ConvertReferenceCatalogConfig

class lsst.meas.algorithms.ConvertReferenceCatalogConfig

Bases: lsst.pex.config.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.
epoch_name Name of epoch column (str, default None)
epoch_scale Scale of epoch column: any value accepted by astropy.time.Time, e.g.
extra_col_names Extra columns to add to the reference catalog.
file_reader Task to use to read the files.
history
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

compare(other[, shortcut, rtol, atol, output]) Compare this configuration to another Config for equality.
formatHistory(name, **kwargs) Format a configuration field’s history to a human-readable format.
freeze() Make this config, and all subconfigs, read-only.
items() Get configurations as (field name, field value) pairs.
keys() Get field names.
load(filename[, root]) Modify this config in place by executing the Python code in a configuration file.
loadFromStream(stream[, root, filename]) Modify this Config in place by executing the Python code in the provided stream.
loadFromString(code[, root, filename]) Modify this Config in place by executing the Python code in the provided string.
names() Get all the field names in the config, recursively.
save(filename[, root]) Save a Python script to the named file, which, when loaded, reproduces this config.
saveToStream(outfile[, root, skipImports]) Save a configuration file to a stream, which, when loaded, reproduces this config.
saveToString([skipImports]) Return the Python script form of this configuration as an executable string.
setDefaults() Subclass hook for computing defaults.
toDict() Make a dictionary of field names and their values.
update(**kw) Update values of fields specified by the keyword arguments.
validate() Validate the Config, raising an exception if invalid.
values() Get field values.

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'>)

history
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

compare(other, shortcut=True, rtol=1e-08, atol=1e-08, output=None)

Compare this configuration to another Config for equality.

Parameters:
other : lsst.pex.config.Config

Other Config object to compare against this config.

shortcut : bool, optional

If True, return as soon as an inequality is found. Default is True.

rtol : float, optional

Relative tolerance for floating point comparisons.

atol : float, optional

Absolute tolerance for floating point comparisons.

output : callable, optional

A callable that takes a string, used (possibly repeatedly) to report inequalities.
Returns:
isEqual : bool

True when the two lsst.pex.config.Config instances are equal. False if there is an inequality.

See also

lsst.pex.config.compareConfigs

Notes

Unselected targets of RegistryField fields and unselected choices of ConfigChoiceField fields are not considered by this method.

Floating point comparisons are performed by numpy.allclose.

formatHistory(name, **kwargs)

Format a configuration field’s history to a human-readable format.

Parameters:
name : str

Name of a Field in this config.

kwargs

Keyword arguments passed to lsst.pex.config.history.format.
Returns:
history : str

A string containing the formatted history.

See also

lsst.pex.config.history.format
freeze()

Make this config, and all subconfigs, read-only.

items()

Get configurations as (field name, field value) pairs.

Returns:
items : dict_items

Iterator of tuples for each configuration. Tuple items are:

  1. Field name.
  2. Field value.
keys()

Get field names.

Returns:
names : dict_keys

List of lsst.pex.config.Field names.

See also

lsst.pex.config.Config.iterkeys
load(filename, root='config')

Modify this config in place by executing the Python code in a configuration file.

Parameters:
filename : str

Name of the configuration file. A configuration file is Python module.

root : str, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

See also

lsst.pex.config.Config.loadFromStream
lsst.pex.config.Config.loadFromString
lsst.pex.config.Config.save
lsst.pex.config.Config.saveToStream
lsst.pex.config.Config.saveToString
loadFromStream(stream, root='config', filename=None)

Modify this Config in place by executing the Python code in the provided stream.

Parameters:
stream : file-like object, str, bytes, or compiled string

Stream containing configuration override code. If this is a code object, it should be compiled with mode="exec".

root : str, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

filename : str, optional

Name of the configuration file, or None if unknown or contained in the stream. Used for error reporting.

See also

lsst.pex.config.Config.load
lsst.pex.config.Config.loadFromString
lsst.pex.config.Config.save
lsst.pex.config.Config.saveToStream
lsst.pex.config.Config.saveToString

Notes

For backwards compatibility reasons, this method accepts strings, bytes and code objects as well as file-like objects. New code should use loadFromString instead for most of these types.

loadFromString(code, root='config', filename=None)

Modify this Config in place by executing the Python code in the provided string.

Parameters:
code : str, bytes, or compiled string

Stream containing configuration override code.

root : str, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

filename : str, optional

Name of the configuration file, or None if unknown or contained in the stream. Used for error reporting.

See also

lsst.pex.config.Config.load
lsst.pex.config.Config.loadFromStream
lsst.pex.config.Config.save
lsst.pex.config.Config.saveToStream
lsst.pex.config.Config.saveToString
names()

Get all the field names in the config, recursively.

Returns:
names : list of str

Field names.
save(filename, root='config')

Save a Python script to the named file, which, when loaded, reproduces this config.

Parameters:
filename : str

Desination filename of this configuration.

root : str, optional

Name to use for the root config variable. The same value must be used when loading (see lsst.pex.config.Config.load).

See also

lsst.pex.config.Config.saveToStream
lsst.pex.config.Config.saveToString
lsst.pex.config.Config.load
lsst.pex.config.Config.loadFromStream
lsst.pex.config.Config.loadFromString
saveToStream(outfile, root='config', skipImports=False)

Save a configuration file to a stream, which, when loaded, reproduces this config.

Parameters:
outfile : file-like object

Destination file object write the config into. Accepts strings not bytes.

root

Name to use for the root config variable. The same value must be used when loading (see lsst.pex.config.Config.load).

skipImports : bool, optional

If True then do not include import statements in output, this is to support human-oriented output from pipetask where additional clutter is not useful.

See also

lsst.pex.config.Config.save
lsst.pex.config.Config.saveToString
lsst.pex.config.Config.load
lsst.pex.config.Config.loadFromStream
lsst.pex.config.Config.loadFromString
saveToString(skipImports=False)

Return the Python script form of this configuration as an executable string.

Parameters:
skipImports : bool, optional

If True then do not include import statements in output, this is to support human-oriented output from pipetask where additional clutter is not useful.
Returns:
code : str

A code string readable by loadFromString.

See also

lsst.pex.config.Config.save
lsst.pex.config.Config.saveToStream
lsst.pex.config.Config.load
lsst.pex.config.Config.loadFromStream
lsst.pex.config.Config.loadFromString
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.

toDict()

Make a dictionary of field names and their values.

Returns:
dict_ : dict

Dictionary with keys that are Field names. Values are Field values.

See also

lsst.pex.config.Field.toDict

Notes

This method uses the toDict method of individual fields. Subclasses of Field may need to implement a toDict method for this method to work.

update(**kw)

Update values of fields specified by the keyword arguments.

Parameters:
kw

Keywords are configuration field names. Values are configuration field values.

Notes

The __at and __label keyword arguments are special internal keywords. They are used to strip out any internal steps from the history tracebacks of the config. Do not modify these keywords to subvert a Config instance’s history.

Examples

This is a config with three fields:

>>> from lsst.pex.config import Config, Field
>>> class DemoConfig(Config):
...     fieldA = Field(doc='Field A', dtype=int, default=42)
...     fieldB = Field(doc='Field B', dtype=bool, default=True)
...     fieldC = Field(doc='Field C', dtype=str, default='Hello world')
...
>>> config = DemoConfig()

These are the default values of each field:

>>> for name, value in config.iteritems():
...     print(f"{name}: {value}")
...
fieldA: 42
fieldB: True
fieldC: 'Hello world'

Using this method to update fieldA and fieldC:

>>> config.update(fieldA=13, fieldC='Updated!')

Now the values of each field are:

>>> for name, value in config.iteritems():
...     print(f"{name}: {value}")
...
fieldA: 13
fieldB: True
fieldC: 'Updated!'
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.

values()

Get field values.

Returns:
values : dict_values

Iterator of field values.