LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
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 = pexConf.Field(dtype=float, doc="Don't use objects fainter than this magnitude", default=22.0)
 
tuple doWriteOutput
 
tuple fluxField
 
tuple applyColorTerms
 
tuple goodFlags
 
tuple badFlags
 
tuple sigmaMax
 
tuple nSigma
 
tuple useMedian
 
tuple nIter
 
tuple colorterms
 
tuple photoCatName
 
tuple magErrFloor
 

Detailed Description

Definition at line 53 of file photoCal.py.

Member Function Documentation

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

Definition at line 127 of file photoCal.py.

127 
128  def validate(self):
129  pexConf.Config.validate(self)
130  if self.applyColorTerms and self.photoCatName is None:
131  raise RuntimeError("applyColorTerms=True requires photoCatName is non-None")
132  if self.applyColorTerms and len(self.colorterms.data) == 0:
133  raise RuntimeError("applyColorTerms=True requires colorterms be provided")
134 

Member Data Documentation

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

Definition at line 67 of file photoCal.py.

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

Definition at line 83 of file photoCal.py.

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

Definition at line 110 of file photoCal.py.

tuple lsst.pipe.tasks.photoCal.PhotoCalConfig.doWriteOutput
static
Initial value:
1 = pexConf.Field(
2  doc= "Write a field name astrom_usedByPhotoCal to the schema",
3  dtype=bool,
4  default=True,
5  )

Definition at line 56 of file photoCal.py.

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

Definition at line 61 of file photoCal.py.

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

Definition at line 78 of file photoCal.py.

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

Definition at line 120 of file photoCal.py.

tuple lsst.pipe.tasks.photoCal.PhotoCalConfig.magLimit = pexConf.Field(dtype=float, doc="Don't use objects fainter than this magnitude", default=22.0)
static

Definition at line 55 of file photoCal.py.

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

Definition at line 105 of file photoCal.py.

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

Definition at line 95 of file photoCal.py.

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

Definition at line 114 of file photoCal.py.

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

Definition at line 89 of file photoCal.py.

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

Definition at line 100 of file photoCal.py.

The documentation for this class was generated from the following file:
Generated on Thu Sep 24 2015 02:29:43 for LSSTApplications by   doxygen 1.8.5