lsst.pipe.tasks  21.0.0-150-g4dbbe83c+ead6db4ed9
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.photoCal.PhotoCalConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.photoCal.PhotoCalConfig:

Public Member Functions

def validate (self)
 
def setDefaults (self)
 

Static Public Attributes

 match
 
 reserve = pexConf.ConfigurableField(target=ReserveSourcesTask, doc="Reserve sources from fitting")
 
 fluxField
 
 applyColorTerms
 
 sigmaMax
 
 nSigma
 
 useMedian
 
 nIter
 
 colorterms
 
 photoCatName
 
 magErrFloor
 

Detailed Description

Config for PhotoCal

Definition at line 41 of file photoCal.py.

Member Function Documentation

◆ setDefaults()

def lsst.pipe.tasks.photoCal.PhotoCalConfig.setDefaults (   self)

Definition at line 108 of file photoCal.py.

◆ validate()

def lsst.pipe.tasks.photoCal.PhotoCalConfig.validate (   self)

Definition at line 101 of file photoCal.py.

Member Data Documentation

◆ applyColorTerms

lsst.pipe.tasks.photoCal.PhotoCalConfig.applyColorTerms
static
Initial value:
= pexConf.Field(
dtype=bool,
default=None,
doc=("Apply photometric color terms to reference stars? One of:\n"
"None: apply if colorterms and photoCatName are not None;\n"
" fail if color term data is not available for the specified ref catalog and filter.\n"
"True: always apply colorterms; fail if color term data is not available for the\n"
" specified reference catalog and filter.\n"
"False: do not apply."),
optional=True,
)

Definition at line 52 of file photoCal.py.

◆ colorterms

lsst.pipe.tasks.photoCal.PhotoCalConfig.colorterms
static
Initial value:
= pexConf.ConfigField(
dtype=ColortermLibrary,
doc="Library of photometric reference catalog name: color term dict",
)

Definition at line 84 of file photoCal.py.

◆ fluxField

lsst.pipe.tasks.photoCal.PhotoCalConfig.fluxField
static
Initial value:
= pexConf.Field(
dtype=str,
default="slot_CalibFlux_instFlux",
doc=("Name of the source instFlux field to use. The associated flag field\n"
"('<name>_flags') will be implicitly included in badFlags."),
)

Definition at line 46 of file photoCal.py.

◆ magErrFloor

lsst.pipe.tasks.photoCal.PhotoCalConfig.magErrFloor
static
Initial value:
= pexConf.RangeField(
dtype=float,
default=0.0,
doc="Additional magnitude uncertainty to be added in quadrature with measurement errors.",
min=0.0,
)

Definition at line 94 of file photoCal.py.

◆ match

lsst.pipe.tasks.photoCal.PhotoCalConfig.match
static
Initial value:
= pexConf.ConfigField("Match to reference catalog",
DirectMatchConfigWithoutLoader)

Definition at line 43 of file photoCal.py.

◆ nIter

lsst.pipe.tasks.photoCal.PhotoCalConfig.nIter
static
Initial value:
= pexConf.Field(
dtype=int,
default=20,
doc="number of iterations",
)

Definition at line 79 of file photoCal.py.

◆ nSigma

lsst.pipe.tasks.photoCal.PhotoCalConfig.nSigma
static
Initial value:
= pexConf.Field(
dtype=float,
default=3.0,
doc="clip at nSigma",
)

Definition at line 69 of file photoCal.py.

◆ photoCatName

lsst.pipe.tasks.photoCal.PhotoCalConfig.photoCatName
static
Initial value:
= pexConf.Field(
dtype=str,
optional=True,
doc=("Name of photometric reference catalog; used to select a color term dict in colorterms."
" see also applyColorTerms"),
)

Definition at line 88 of file photoCal.py.

◆ reserve

lsst.pipe.tasks.photoCal.PhotoCalConfig.reserve = pexConf.ConfigurableField(target=ReserveSourcesTask, doc="Reserve sources from fitting")
static

Definition at line 45 of file photoCal.py.

◆ sigmaMax

lsst.pipe.tasks.photoCal.PhotoCalConfig.sigmaMax
static
Initial value:
= pexConf.Field(
dtype=float,
default=0.25,
doc="maximum sigma to use when clipping",
optional=True,
)

Definition at line 63 of file photoCal.py.

◆ useMedian

lsst.pipe.tasks.photoCal.PhotoCalConfig.useMedian
static
Initial value:
= pexConf.Field(
dtype=bool,
default=True,
doc="use median instead of mean to compute zeropoint",
)

Definition at line 74 of file photoCal.py.


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