lsst.pipe.tasks.background.MaskObjectsConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.background.MaskObjectsConfig:

Public Member Functions
	setDefaults (self)
	validate (self)

Static Public Attributes
	nIter = Field(dtype=int, default=3, doc="Number of iterations")
	subtractBackground
	detection = ConfigurableField(target=measAlg.SourceDetectionTask, doc="Source detection")
	detectSigma = Field(dtype=float, default=5.0, doc="Detection threshold (standard deviations)")
	doInterpolate = Field(dtype=bool, default=True, doc="Interpolate when removing objects?")
	interpolate = ConfigurableField(target=measAlg.SubtractBackgroundTask, doc="Interpolation")

Detailed Description

Configuration for MaskObjectsTask

Definition at line 775 of file background.py.

Member Function Documentation

setDefaults()

lsst.pipe.tasks.background.MaskObjectsConfig.setDefaults

(

self

)

Subclass hook for computing defaults.

Notes
-----
Derived `~lsst.pex.config.Config` classes that must compute defaults
rather than using the `~lsst.pex.config.Field` instances's defaults
should do so here. To correctly use inherited defaults,
implementations of ``setDefaults`` must call their base class's
``setDefaults``.

Reimplemented from lsst.pex.config.config.Config.

Definition at line 785 of file background.py.

    def setDefaults(self):
        self.detection.reEstimateBackground = False
        self.detection.doTempLocalBackground = False
        self.detection.doTempWideBackground = False
        self.detection.thresholdValue = 2.5
        self.subtractBackground.binSize = 1024
        self.subtractBackground.useApprox = False
        self.interpolate.binSize = 256
        self.interpolate.useApprox = False
 

validate()

lsst.pipe.tasks.background.MaskObjectsConfig.validate

(

self

)

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 `~lsst.pex.config.Field.validate` methods.

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

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

Reimplemented from lsst.pex.config.config.Config.

Definition at line 795 of file background.py.

    def validate(self):
        if (self.detection.reEstimateBackground
                or self.detection.doTempLocalBackground
                or self.detection.doTempWideBackground):
            raise RuntimeError("Incorrect settings for object masking: reEstimateBackground, "
                               "doTempLocalBackground and doTempWideBackground must be False")
 
 

Member Data Documentation

detection

lsst.pipe.tasks.background.MaskObjectsConfig.detection = ConfigurableField(target=measAlg.SourceDetectionTask, doc="Source detection")

static

Definition at line 780 of file background.py.

detectSigma

lsst.pipe.tasks.background.MaskObjectsConfig.detectSigma = Field(dtype=float, default=5.0, doc="Detection threshold (standard deviations)")

static

Definition at line 781 of file background.py.

doInterpolate

lsst.pipe.tasks.background.MaskObjectsConfig.doInterpolate = Field(dtype=bool, default=True, doc="Interpolate when removing objects?")

static

Definition at line 782 of file background.py.

interpolate

lsst.pipe.tasks.background.MaskObjectsConfig.interpolate = ConfigurableField(target=measAlg.SubtractBackgroundTask, doc="Interpolation")

static

Definition at line 783 of file background.py.

nIter

lsst.pipe.tasks.background.MaskObjectsConfig.nIter = Field(dtype=int, default=3, doc="Number of iterations")

static

Definition at line 777 of file background.py.

subtractBackground

lsst.pipe.tasks.background.MaskObjectsConfig.subtractBackground

static

Initial value:

=  ConfigurableField(target=measAlg.SubtractBackgroundTask,
                                           doc="Background subtraction")

Definition at line 778 of file background.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/gc07e1c2157+a98bf949bb/python/lsst/pipe/tasks/background.py