lsst.pipe.tasks g85f8d04a89+8cd9ef0b15
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig:
lsst.pipe.tasks.skyCorrection.SkyCorrectionConnections

Public Member Functions

 setDefaults (self)
 
 validate (self)
 

Static Public Attributes

 maskObjects
 
 doMaskObjects
 
 bgModel
 
 doBgModel
 
 bgModel1
 
 doBgModel1
 
 sky
 
 doSky
 
 bgModel2
 
 doBgModel2
 
 binning
 

Detailed Description

Definition at line 162 of file skyCorrection.py.

Member Function Documentation

◆ setDefaults()

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.setDefaults (   self)

Definition at line 218 of file skyCorrection.py.

◆ validate()

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.validate (   self)

Definition at line 226 of file skyCorrection.py.

Member Data Documentation

◆ bgModel

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.bgModel
static
Initial value:
= ConfigField(
dtype=Config,
doc="Initial background model, prior to sky frame subtraction",
deprecated="This field is deprecated and will be removed after v26. Please use bgModel1 instead.",
)

Definition at line 172 of file skyCorrection.py.

◆ bgModel1

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.bgModel1
static
Initial value:
= ConfigField(
dtype=FocalPlaneBackgroundConfig,
doc="Initial background model, prior to sky frame subtraction",
)

Definition at line 184 of file skyCorrection.py.

◆ bgModel2

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.bgModel2
static
Initial value:
= ConfigField(
dtype=FocalPlaneBackgroundConfig,
doc="Final (cleanup) background model, after sky frame subtraction",
)

Definition at line 203 of file skyCorrection.py.

◆ binning

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.binning
static
Initial value:
= Field(
dtype=int,
default=8,
doc="Binning factor for constructing full focal plane '*_camera' output datasets",
)

Definition at line 212 of file skyCorrection.py.

◆ doBgModel

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.doBgModel
static
Initial value:
= Field(
dtype=bool,
default=None,
doc="Do initial background model subtraction (prior to sky frame subtraction)?",
optional=True,
deprecated="This field is deprecated and will be removed after v26. See RFC-898 for further details.",
)

Definition at line 177 of file skyCorrection.py.

◆ doBgModel1

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.doBgModel1
static
Initial value:
= Field(
dtype=bool,
default=True,
doc="Do initial background model subtraction (prior to sky frame subtraction)?",
deprecated="This field is deprecated and will be removed after v26. See RFC-898 for further details.",
)

Definition at line 188 of file skyCorrection.py.

◆ doBgModel2

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.doBgModel2
static
Initial value:
= Field(
dtype=bool,
default=True,
doc="Do final (cleanup) background model subtraction, after sky frame subtraction?",
)

Definition at line 207 of file skyCorrection.py.

◆ doMaskObjects

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.doMaskObjects
static
Initial value:
= Field(
dtype=bool,
default=True,
doc="Iteratively mask objects to find good sky?",
)

Definition at line 167 of file skyCorrection.py.

◆ doSky

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.doSky
static
Initial value:
= Field(
dtype=bool,
default=True,
doc="Do sky frame subtraction?",
)

Definition at line 198 of file skyCorrection.py.

◆ maskObjects

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.maskObjects
static
Initial value:
= ConfigurableField(
target=MaskObjectsTask,
doc="Mask Objects",
)

Definition at line 163 of file skyCorrection.py.

◆ sky

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.sky
static
Initial value:
= ConfigurableField(
target=SkyMeasurementTask,
doc="Sky measurement",
)

Definition at line 194 of file skyCorrection.py.


The documentation for this class was generated from the following file: