lsst.pipe.tasks.photoCal.PhotoCalConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.photoCal.PhotoCalConfig:

Public Member Functions
	validate (self)
	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()

lsst.pipe.tasks.photoCal.PhotoCalConfig.setDefaults

(

self

)

Definition at line 107 of file photoCal.py.

    def setDefaults(self):
        pexConf.Config.setDefaults(self)
        self.match.sourceSelection.doRequirePrimary = True
        self.match.sourceSelection.doFlags = True
        self.match.sourceSelection.flags.bad = [
            "base_PixelFlags_flag_edge",
            "base_PixelFlags_flag_interpolated",
            "base_PixelFlags_flag_saturated",
        ]
        self.match.sourceSelection.doUnresolved = True
 
 

validate()

lsst.pipe.tasks.photoCal.PhotoCalConfig.validate

(

self

)

Definition at line 100 of file photoCal.py.

    def validate(self):
        pexConf.Config.validate(self)
        if self.applyColorTerms and self.photoCatName is None:
            raise RuntimeError("applyColorTerms=True requires photoCatName is non-None")
        if self.applyColorTerms and len(self.colorterms.data) == 0:
            raise RuntimeError("applyColorTerms=True requires colorterms be provided")
 

Member Data Documentation

applyColorTerms

lsst.pipe.tasks.photoCal.PhotoCalConfig.applyColorTerms

static

Initial value:

=  pexConf.Field(
        dtype=bool,
        default=False,
        doc=("Apply photometric color terms to reference stars?\n"
             "`True`: attempt to apply color terms; fail if color term data is "
             "not available for the specified reference catalog and filter.\n"
             "`False`: do not apply color terms."),
        optional=True,
    )

Definition at line 53 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 (see also applyColorTerms).",
    )

Definition at line 83 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.\nThe associated flag field "
             "('<name>_flags') will be implicitly included in badFlags."),
    )

Definition at line 47 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 93 of file photoCal.py.

match

lsst.pipe.tasks.photoCal.PhotoCalConfig.match

static

Initial value:

=  pexConf.ConfigField("Match to reference catalog",
                                DirectMatchConfigWithoutLoader)

Definition at line 44 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 78 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 68 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.\n"
             "See also applyColorTerms."),
    )

Definition at line 87 of file photoCal.py.

reserve

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

static

Definition at line 46 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 62 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 73 of file photoCal.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/g14a832a312+ff425fae3c/python/lsst/pipe/tasks/photoCal.py