Config for PhotoCal
Definition at line 63 of file photoCal.py.
◆ validate()
def lsst.pipe.tasks.photoCal.PhotoCalConfig.validate |
( |
|
self | ) |
|
◆ 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 87 of file photoCal.py.
◆ badFlags
lsst.pipe.tasks.photoCal.PhotoCalConfig.badFlags |
|
static |
Initial value:= pexConf.ListField(
dtype=str,
default=["base_PixelFlags_flag_edge", "base_PixelFlags_flag_interpolated",
"base_PixelFlags_flag_saturated"],
doc="List of source flag fields that will cause a source to be rejected when they are set.",
)
Definition at line 103 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 130 of file photoCal.py.
◆ doSelectUnresolved
lsst.pipe.tasks.photoCal.PhotoCalConfig.doSelectUnresolved |
|
static |
Initial value:= pexConf.Field(
dtype=bool,
default=True,
doc=("Use the extendedness parameter to select objects to use in photometric calibration?\n"
"This applies only to the sources detected on the exposure, not the reference catalog"),
)
Definition at line 146 of file photoCal.py.
◆ fluxField
lsst.pipe.tasks.photoCal.PhotoCalConfig.fluxField |
|
static |
Initial value:= pexConf.Field(
dtype=str,
default="slot_CalibFlux_flux",
doc=("Name of the source flux field to use. The associated flag field\n"
"('<name>_flags') will be implicitly included in badFlags."),
)
Definition at line 81 of file photoCal.py.
◆ goodFlags
lsst.pipe.tasks.photoCal.PhotoCalConfig.goodFlags |
|
static |
Initial value:= pexConf.ListField(
dtype=str,
default=[],
doc="List of source flag fields that must be set for a source to be used.",
)
Definition at line 98 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 140 of file photoCal.py.
◆ magLimit
lsst.pipe.tasks.photoCal.PhotoCalConfig.magLimit |
|
static |
Initial value:= pexConf.Field(
dtype=float,
default=22.0,
doc="Don't use objects fainter than this magnitude",
)
Definition at line 65 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 125 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 115 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 134 of file photoCal.py.
◆ reserveFraction
lsst.pipe.tasks.photoCal.PhotoCalConfig.reserveFraction |
|
static |
Initial value:= pexConf.Field(
dtype=float,
doc="Fraction of candidates to reserve from fitting; none if <= 0",
default=-1.0,
)
Definition at line 70 of file photoCal.py.
◆ reserveSeed
lsst.pipe.tasks.photoCal.PhotoCalConfig.reserveSeed |
|
static |
Initial value:= pexConf.Field(
dtype=int,
doc="This number will be multiplied by the exposure ID "
"to set the random seed for reserving candidates",
default=1,
)
Definition at line 75 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 109 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 120 of file photoCal.py.
The documentation for this class was generated from the following file: