MeasureApCorrConfig#

class lsst.meas.algorithms.MeasureApCorrConfig(*args, **kw)#

Bases: Config

Configuration for MeasureApCorrTask.

Attributes Summary

`allowFailure`	Allow these measurement algorithms to fail without an exception.
`doFinalMedianShift`	Do final shift to ensure medians match.
`fitConfig`	Configuration used in fitting the aperture correction fields.
`minDegreesOfFreedom`	Minimum number of degrees of freedom (# of valid data points - # of parameters); if this is exceeded, the order of the fit is decreased (in both dimensions), and if we can't decrease it enough, we'll raise ValueError.
`numIter`	Number of iterations for robust MAD sigma clipping.
`numSigmaClip`	Number of robust MAD sigma to do clipping.
`refFluxName`	Field name prefix for the flux other measurements should be aperture corrected to match (`str`, default `'slot_CalibFlux'`)
`sourceSelector`	Selector that sets the stars that aperture corrections will be measured from.

Methods Summary

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

Attributes Documentation

allowFailure#: Allow these measurement algorithms to fail without an exception. (List, default [])

doFinalMedianShift#: Do final shift to ensure medians match. (bool, default True)

fitConfig#: Configuration used in fitting the aperture correction fields. (ChebyshevBoundedFieldConfig, default <class 'lsst.afw.math._chebyshevBoundedFieldConfig.ChebyshevBoundedFieldConfig'>)

minDegreesOfFreedom#

Minimum number of degrees of freedom (# of valid data points - # of parameters); if this is exceeded, the order of the fit is decreased (in both dimensions), and if we can’t decrease it enough, we’ll raise ValueError. (int, default 1)

Valid Range = [1,inf)

numIter#: Number of iterations for robust MAD sigma clipping. (int, default 4)

numSigmaClip#: Number of robust MAD sigma to do clipping. (float, default 4.0)

refFluxName#: Field name prefix for the flux other measurements should be aperture corrected to match (str, default 'slot_CalibFlux')

sourceSelector#: Selector that sets the stars that aperture corrections will be measured from. (RegistryInstanceDict, default 'science')

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.