LoadReferenceObjectsConfig

class lsst.meas.algorithms.LoadReferenceObjectsConfig(*args, **kw)

Bases: Config

Attributes Summary

anyFilterMapsToThis	Always use this reference catalog filter, no matter whether or what filter name is supplied to the loader.
filterMap	Mapping of camera filter name: reference catalog filter name; each reference filter must exist in the refcat.
maxRefObjects	Maximum number of reference objects to send to the matcher.
minRefMag	Minimum (i.e. brightest) magnitude for reference catalog (the brightest sources are typically saturated in the images, so may as well remove them from the reference catalog).
pixelMargin	Padding to add to 4 all edges of the bounding box (pixels) (int, default 250)
requireProperMotion	Require that the fields needed to correct proper motion (epoch, pm_ra and pm_dec) are present? (bool, default False)

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

anyFilterMapsToThis

Always use this reference catalog filter, no matter whether or what filter name is supplied to the loader. Effectively a trivial filterMap: map all filter names to this filter. This can be set for purely-astrometric catalogs (e.g. Gaia DR2) where there is only one reasonable choice for every camera filter->refcat mapping, but not for refcats used for photometry, which need a filterMap and/or colorterms/transmission corrections. (str, default None)

filterMap

Mapping of camera filter name: reference catalog filter name; each reference filter must exist in the refcat. Note that this does not perform any bandpass corrections: it is just a lookup. (Dict, default {})

maxRefObjects

Maximum number of reference objects to send to the matcher. Setting this to a reasonable value may be desirable for memory reasons (particularly in very crowded field). (int, default None)

minRefMag

Minimum (i.e. brightest) magnitude for reference catalog (the brightest sources are typically saturated in the images, so may as well remove them from the reference catalog). (float, default None)

pixelMargin

Padding to add to 4 all edges of the bounding box (pixels) (int, default 250)

Valid Range = [0,inf)

requireProperMotion

Require that the fields needed to correct proper motion (epoch, pm_ra and pm_dec) are present? (bool, default False)

Methods Documentation

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.