lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogConfig Class Reference

Inheritance diagram for lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogConfig:

Public Member Functions
def	validate (self)

Static Public Attributes
	refObjLoader
	filterMap
	applyColorTerms
	colorterms
	referenceSelector

Detailed Description

Config for FgcmLoadReferenceCatalogTask

Definition at line 48 of file fgcmLoadReferenceCatalog.py.

Member Function Documentation

validate()

def lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogConfig.validate

(

self

)

Definition at line 76 of file fgcmLoadReferenceCatalog.py.

    def validate(self):
        super().validate()
        if not self.filterMap:
            msg = 'Must set filterMap'
            raise pexConfig.FieldValidationError(FgcmLoadReferenceCatalogConfig.filterMap, self, msg)
        if self.applyColorTerms and len(self.colorterms.data) == 0:
            msg = "applyColorTerms=True requires the `colorterms` field be set to a ColortermLibrary."
            raise pexConfig.FieldValidationError(FgcmLoadReferenceCatalogConfig.colorterms, self, msg)
 
 

Member Data Documentation

applyColorTerms

lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogConfig.applyColorTerms

static

Initial value:

=  pexConfig.Field(
        doc=("Apply photometric color terms to reference stars?"
             "Requires that colorterms be set to a ColorTermLibrary"),
        dtype=bool,
        default=True
    )

Definition at line 61 of file fgcmLoadReferenceCatalog.py.

colorterms

lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogConfig.colorterms

static

Initial value:

=  pexConfig.ConfigField(
        doc="Library of photometric reference catalog name to color term dict.",
        dtype=ColortermLibrary,
    )

Definition at line 67 of file fgcmLoadReferenceCatalog.py.

filterMap

lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogConfig.filterMap

static

Initial value:

=  pexConfig.DictField(
        doc="Mapping from physicalFilter label to reference filter name.",
        keytype=str,
        itemtype=str,
        default={},
    )

Definition at line 55 of file fgcmLoadReferenceCatalog.py.

referenceSelector

lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogConfig.referenceSelector

static

Initial value:

=  pexConfig.ConfigurableField(
        target=ReferenceSourceSelectorTask,
        doc="Selection of reference sources",
    )

Definition at line 71 of file fgcmLoadReferenceCatalog.py.

refObjLoader

lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogConfig.refObjLoader

static

Initial value:

=  pexConfig.ConfigurableField(
        target=LoadIndexedReferenceObjectsTask,
        doc="Reference object loader for photometry",
    )

Definition at line 51 of file fgcmLoadReferenceCatalog.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/fgcmcal/22.0.1-15-g6a90155+515f58c32b/python/lsst/fgcmcal/fgcmLoadReferenceCatalog.py