lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsConfig Class Reference

Inheritance diagram for lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsConfig:

Public Member Functions
def	validate (self)

Static Public Attributes
	ref_dataset_name
	pixelMargin
	defaultFilter
	anyFilterMapsToThis
	filterMap
	requireProperMotion

Detailed Description

Definition at line 35 of file loadIndexedReferenceObjects.py.

Member Function Documentation

validate()

def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig.validate (   self )

inherited

Definition at line 893 of file loadReferenceObjects.py.

    def validate(self):
        super().validate()
        if self.filterMap != {} and self.anyFilterMapsToThis is not None:
            msg = "`filterMap` and `anyFilterMapsToThis` are mutually exclusive"
            raise pexConfig.FieldValidationError(LoadReferenceObjectsConfig.anyFilterMapsToThis,
                                                 self, msg)
 
 

Member Data Documentation

anyFilterMapsToThis

lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig.anyFilterMapsToThis

staticinherited

Initial value:

=  pexConfig.Field(
        doc=("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."),
        dtype=str,
        default=None,
        optional=True
    )

Definition at line 868 of file loadReferenceObjects.py.

defaultFilter

lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig.defaultFilter

staticinherited

Initial value:

=  pexConfig.Field(
        doc=("Default reference catalog filter to use if filter not specified in exposure;"
             " if blank then filter must be specified in exposure."),
        dtype=str,
        default="",
        deprecated="defaultFilter is deprecated by RFC-716. Will be removed after v22."
    )

Definition at line 861 of file loadReferenceObjects.py.

filterMap

lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig.filterMap

staticinherited

Initial value:

=  pexConfig.DictField(
        doc=("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."),
        keytype=str,
        itemtype=str,
        default={},
    )

Definition at line 878 of file loadReferenceObjects.py.

pixelMargin

lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig.pixelMargin

staticinherited

Initial value:

=  pexConfig.RangeField(
        doc="Padding to add to 4 all edges of the bounding box (pixels)",
        dtype=int,
        default=250,
        min=0,
    )

Definition at line 855 of file loadReferenceObjects.py.

ref_dataset_name

lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsConfig.ref_dataset_name

static

Initial value:

=  pexConfig.Field(
        dtype=str,
        default='cal_ref_cat',
        doc='Name of the ingested reference dataset'
    )

Definition at line 36 of file loadIndexedReferenceObjects.py.

requireProperMotion

lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig.requireProperMotion

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Require that the fields needed to correct proper motion "
            "(epoch, pm_ra and pm_dec) are present?",
        dtype=bool,
        default=False,
    )

Definition at line 886 of file loadReferenceObjects.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_algorithms/22.0.1-32-gf62ce7b1+aa4237961e/python/lsst/meas/algorithms/loadIndexedReferenceObjects.py