LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+ffe7eabc7e,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g36da64cc00+ea84795170,g3ddfee87b4+955a963fd8,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+955a963fd8,g591dd9f2cf+bac198a2cb,g5ec818987f+420292cfeb,g858d7b2824+d6c9a0a3b8,g876c692160+aabc49a3c3,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+e6cd765486,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+acd47f83f4,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+12c8382528,gba4ed39666+1ac82b564f,gbb8dafda3b+0574160a1f,gbeb006f7da+dea2fbb49f,gc28159a63d+c6dfa2ddaf,gc86a011abf+d6c9a0a3b8,gcf0d15dbbd+955a963fd8,gdaeeff99f8+1cafcb7cd4,gdc0c513512+d6c9a0a3b8,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,gee10cc3b42+90ebb246c7,gf1cff7945b+d6c9a0a3b8,w.2024.13
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.background.MaskObjectsConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.background.MaskObjectsConfig:
lsst.pex.config.config.Config lsst.pex.config.config.ConfigMeta

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.

785 def setDefaults(self):
786 self.detection.reEstimateBackground = False
787 self.detection.doTempLocalBackground = False
788 self.detection.doTempWideBackground = False
789 self.detection.thresholdValue = 2.5
790 self.subtractBackground.binSize = 1024
791 self.subtractBackground.useApprox = False
792 self.interpolate.binSize = 256
793 self.interpolate.useApprox = False
794

◆ 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.

795 def validate(self):
796 if (self.detection.reEstimateBackground
797 or self.detection.doTempLocalBackground
798 or self.detection.doTempWideBackground):
799 raise RuntimeError("Incorrect settings for object masking: reEstimateBackground, "
800 "doTempLocalBackground and doTempWideBackground must be False")
801
802

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: