lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogConfig:

Public Member Functions
	validate (self)

Static Public Attributes
	refObjLoader
	doApplyColorTerms
	colorterms
	referenceSelector
	doReferenceSelection

Detailed Description

Config for LoadReferenceCatalogTask

Definition at line 44 of file loadReferenceCatalog.py.

Member Function Documentation

validate()

lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogConfig.validate

(

self

)

Definition at line 70 of file loadReferenceCatalog.py.

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

Member Data Documentation

colorterms

lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogConfig.colorterms

static

Initial value:

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

Definition at line 56 of file loadReferenceCatalog.py.

doApplyColorTerms

lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogConfig.doApplyColorTerms

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 50 of file loadReferenceCatalog.py.

doReferenceSelection

lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogConfig.doReferenceSelection

static

Initial value:

=  pexConfig.Field(
        doc="Run the reference selector on the reference catalog?",
        dtype=bool,
        default=True
    )

Definition at line 64 of file loadReferenceCatalog.py.

referenceSelector

lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogConfig.referenceSelector

static

Initial value:

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

Definition at line 60 of file loadReferenceCatalog.py.

refObjLoader

lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogConfig.refObjLoader

static

Initial value:

=  pexConfig.ConfigField(
        dtype=LoadReferenceObjectsConfig,
        doc="Configuration for the reference object loader.",
    )

Definition at line 46 of file loadReferenceCatalog.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/g29320951ab+012e1474a1/python/lsst/pipe/tasks/loadReferenceCatalog.py