lsst.pipe.tasks  13.0-54-gc325bc5f+1
 All Classes Namespaces Files Functions Variables Groups Pages
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
 

Static Public Attributes

tuple magLimit
 
tuple reserveFraction
 
tuple reserveSeed
 
tuple fluxField
 
tuple applyColorTerms
 
tuple goodFlags
 
tuple badFlags
 
tuple sigmaMax
 
tuple nSigma
 
tuple useMedian
 
tuple nIter
 
tuple colorterms
 
tuple photoCatName
 
tuple magErrFloor
 
tuple doSelectUnresolved
 

Detailed Description

Config for PhotoCal

Definition at line 64 of file photoCal.py.

Member Function Documentation

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

Definition at line 154 of file photoCal.py.

Member Data Documentation

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

Definition at line 88 of file photoCal.py.

tuple lsst.pipe.tasks.photoCal.PhotoCalConfig.badFlags
static
Initial value:
1 = pexConf.ListField(
2  dtype=str,
3  default=["base_PixelFlags_flag_edge", "base_PixelFlags_flag_interpolated",
4  "base_PixelFlags_flag_saturated"],
5  doc="List of source flag fields that will cause a source to be rejected when they are set.",
6  )

Definition at line 104 of file photoCal.py.

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

Definition at line 131 of file photoCal.py.

tuple lsst.pipe.tasks.photoCal.PhotoCalConfig.doSelectUnresolved
static
Initial value:
1 = pexConf.Field(
2  dtype=bool,
3  default=True,
4  doc=("Use the extendedness parameter to select objects to use in photometric calibration?\n"
5  "This applies only to the sources detected on the exposure, not the reference catalog"),
6  )

Definition at line 147 of file photoCal.py.

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

Definition at line 82 of file photoCal.py.

tuple lsst.pipe.tasks.photoCal.PhotoCalConfig.goodFlags
static
Initial value:
1 = pexConf.ListField(
2  dtype=str,
3  default=[],
4  doc="List of source flag fields that must be set for a source to be used.",
5  )

Definition at line 99 of file photoCal.py.

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

Definition at line 141 of file photoCal.py.

tuple lsst.pipe.tasks.photoCal.PhotoCalConfig.magLimit
static
Initial value:
1 = pexConf.Field(
2  dtype=float,
3  default=22.0,
4  doc="Don't use objects fainter than this magnitude",
5  )

Definition at line 66 of file photoCal.py.

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

Definition at line 126 of file photoCal.py.

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

Definition at line 116 of file photoCal.py.

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

Definition at line 135 of file photoCal.py.

tuple lsst.pipe.tasks.photoCal.PhotoCalConfig.reserveFraction
static
Initial value:
1 = pexConf.Field(
2  dtype=float,
3  doc="Fraction of candidates to reserve from fitting; none if <= 0",
4  default=-1.0,
5  )

Definition at line 71 of file photoCal.py.

tuple lsst.pipe.tasks.photoCal.PhotoCalConfig.reserveSeed
static
Initial value:
1 = pexConf.Field(
2  dtype = int,
3  doc = "This number will be multiplied by the exposure ID "
4  "to set the random seed for reserving candidates",
5  default = 1,
6  )

Definition at line 76 of file photoCal.py.

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

Definition at line 110 of file photoCal.py.

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

Definition at line 121 of file photoCal.py.


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