MaskObjectsConfig#

class lsst.pipe.tasks.background.MaskObjectsConfig(*args, **kw)#

Bases: Config

Configuration for MaskObjectsTask

Attributes Summary

`detectSigma`	Detection threshold (standard deviations) (`float`, default `5.0`)
`detection`	Source detection (`ConfigurableInstance`, default `<class 'lsst.meas.algorithms.detection.SourceDetectionConfig'>`)
`doInterpolate`	Interpolate when removing objects? (`bool`, default `True`)
`interpolate`	Interpolation (`ConfigurableInstance`, default `<class 'lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig'>`)
`nIter`	Number of iterations (`int`, default `3`)
`subtractBackground`	Background subtraction (`ConfigurableInstance`, default `<class 'lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig'>`)

Methods Summary

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

Attributes Documentation

detectSigma#: Detection threshold (standard deviations) (float, default 5.0)

detection#: Source detection (ConfigurableInstance, default <class 'lsst.meas.algorithms.detection.SourceDetectionConfig'>)

doInterpolate#: Interpolate when removing objects? (bool, default True)

interpolate#: Interpolation (ConfigurableInstance, default <class 'lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig'>)

nIter#: Number of iterations (int, default 3)

subtractBackground#: Background subtraction (ConfigurableInstance, default <class 'lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig'>)

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.