lsst.pipe.tasks g59f6dce098+83b7f37e51
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

def setDefaults (self)
 
def validate (self)
 

Static Public Attributes

ConfigurableField maskObjects
 
Field doMaskObjects
 
ConfigField bgModel
 
Field doBgModel
 
ConfigField bgModel1
 
Field doBgModel1
 
ConfigurableField sky
 
Field doSky
 
ConfigField bgModel2
 
Field doBgModel2
 
Field binning
 

Detailed Description

Definition at line 160 of file skyCorrection.py.

Member Function Documentation

◆ setDefaults()

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

Definition at line 216 of file skyCorrection.py.

◆ validate()

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

Definition at line 224 of file skyCorrection.py.

Member Data Documentation

◆ bgModel

ConfigField 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 170 of file skyCorrection.py.

◆ bgModel1

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

Definition at line 182 of file skyCorrection.py.

◆ bgModel2

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

Definition at line 201 of file skyCorrection.py.

◆ binning

Field 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 210 of file skyCorrection.py.

◆ doBgModel

Field 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 175 of file skyCorrection.py.

◆ doBgModel1

Field 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 186 of file skyCorrection.py.

◆ doBgModel2

Field 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 205 of file skyCorrection.py.

◆ doMaskObjects

Field 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 165 of file skyCorrection.py.

◆ doSky

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

Definition at line 196 of file skyCorrection.py.

◆ maskObjects

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

Definition at line 161 of file skyCorrection.py.

◆ sky

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

Definition at line 192 of file skyCorrection.py.


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