PhotoCalConfig#

class lsst.pipe.tasks.photoCal.PhotoCalConfig(*args, **kw)#

Bases: Config

Config for PhotoCal.

Attributes Summary

`applyColorTerms`	Apply photometric color terms to reference stars? `True`: attempt to apply color terms; fail if color term data is not available for the specified reference catalog and filter.
`colorterms`	Library of photometric reference catalog name: color term dict (see also applyColorTerms).
`fluxField`	Name of the source instFlux field to use.
`magErrFloor`	Additional magnitude uncertainty to be added in quadrature with measurement errors.
`match`	Match to reference catalog (`DirectMatchConfigWithoutLoader`, default `<class 'lsst.meas.astrom.directMatch.DirectMatchConfigWithoutLoader'>`)
`nIter`	number of iterations (`int`, default `20`)
`nSigma`	clip at nSigma (`float`, default `3.0`)
`photoCatName`	Name of photometric reference catalog; used to select a color term dict in colorterms.
`reserve`	Reserve sources from fitting (`ConfigurableInstance`, default `<class 'lsst.meas.algorithms.reserveSourcesTask.ReserveSourcesConfig'>`)
`sigmaMax`	maximum sigma to use when clipping (`float`, default `0.25`)
`useMedian`	use median instead of mean to compute zeropoint (`bool`, default `True`)

Methods Summary

`setDefaults`()	Subclass hook for computing defaults.
`validate`()	Validate the Config, raising an exception if invalid.

Attributes Documentation

applyColorTerms#: Apply photometric color terms to reference stars? True: attempt to apply color terms; fail if color term data is not available for the specified reference catalog and filter. False: do not apply color terms. (bool, default False)

colorterms#: Library of photometric reference catalog name: color term dict (see also applyColorTerms). (ColortermLibrary, default <class 'lsst.pipe.tasks.colorterms.ColortermLibrary'>)

fluxField#: Name of the source instFlux field to use. The associated flag field (‘<name>_flags’) will be implicitly included in badFlags. (str, default 'slot_CalibFlux_instFlux')

magErrFloor#

Additional magnitude uncertainty to be added in quadrature with measurement errors. (float, default 0.0)

Valid Range = [0.0,inf)

match#: Match to reference catalog (DirectMatchConfigWithoutLoader, default <class 'lsst.meas.astrom.directMatch.DirectMatchConfigWithoutLoader'>)

nIter#: number of iterations (int, default 20)

nSigma#: clip at nSigma (float, default 3.0)

photoCatName#: Name of photometric reference catalog; used to select a color term dict in colorterms. See also applyColorTerms. (str, default None)

reserve#: Reserve sources from fitting (ConfigurableInstance, default <class 'lsst.meas.algorithms.reserveSourcesTask.ReserveSourcesConfig'>)

sigmaMax#: maximum sigma to use when clipping (float, default 0.25)

useMedian#: use median instead of mean to compute zeropoint (bool, default True)

Methods Documentation

setDefaults()#: Subclass hook for computing defaults.

Notes#

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

validate()#

Validate the Config, raising an exception if invalid.

Raises#

lsst.pex.config.FieldValidationError: Raised if verification fails.

Notes#

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.