lsst.pipe.drivers  17.0.1-10-g87f9f3f+16
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.drivers.skyCorrection.SkyCorrectionConfig Class Reference
Inheritance diagram for lsst.pipe.drivers.skyCorrection.SkyCorrectionConfig:

Public Member Functions

def setDefaults (self)
 

Static Public Attributes

 rawLinker
 
 calExpArray
 
 calBkgArray
 
 camera
 
 skyCalibs
 
 calExpCamera
 
 skyCorr
 
 bgModel = ConfigField(dtype=FocalPlaneBackgroundConfig, doc="Background model")
 
 bgModel2 = ConfigField(dtype=FocalPlaneBackgroundConfig, doc="2nd Background model")
 
 sky = ConfigurableField(target=SkyMeasurementTask, doc="Sky measurement")
 
 maskObjects = ConfigurableField(target=MaskObjectsTask, doc="Mask Objects")
 
 doMaskObjects = Field(dtype=bool, default=True, doc="Mask objects to find good sky?")
 
 doBgModel = Field(dtype=bool, default=True, doc="Do background model subtraction?")
 
 doBgModel2 = Field(dtype=bool, default=True, doc="Do cleanup background model subtraction?")
 
 doSky = Field(dtype=bool, default=True, doc="Do sky frame subtraction?")
 
 binning = Field(dtype=int, default=8, doc="Binning factor for constructing focal-plane images")
 
 calexpType
 

Detailed Description

Configuration for SkyCorrectionTask

Definition at line 60 of file skyCorrection.py.

Member Function Documentation

◆ setDefaults()

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

Definition at line 128 of file skyCorrection.py.

Member Data Documentation

◆ bgModel

lsst.pipe.drivers.skyCorrection.SkyCorrectionConfig.bgModel = ConfigField(dtype=FocalPlaneBackgroundConfig, doc="Background model")
static

Definition at line 116 of file skyCorrection.py.

◆ bgModel2

lsst.pipe.drivers.skyCorrection.SkyCorrectionConfig.bgModel2 = ConfigField(dtype=FocalPlaneBackgroundConfig, doc="2nd Background model")
static

Definition at line 117 of file skyCorrection.py.

◆ binning

lsst.pipe.drivers.skyCorrection.SkyCorrectionConfig.binning = Field(dtype=int, default=8, doc="Binning factor for constructing focal-plane images")
static

Definition at line 124 of file skyCorrection.py.

◆ calBkgArray

lsst.pipe.drivers.skyCorrection.SkyCorrectionConfig.calBkgArray
static
Initial value:
= pipeBase.InputDatasetField(
doc="Input background files to use",
name="calexpBackground",
scalar=False,
storageClass="Background",
dimensions=["instrument", "visit", "detector"],
)

Definition at line 78 of file skyCorrection.py.

◆ calExpArray

lsst.pipe.drivers.skyCorrection.SkyCorrectionConfig.calExpArray
static
Initial value:
= pipeBase.InputDatasetField(
doc="Input exposures to process",
name="calexp",
scalar=False,
storageClass="ExposureF",
dimensions=["instrument", "visit", "detector"],
)

Definition at line 71 of file skyCorrection.py.

◆ calExpCamera

lsst.pipe.drivers.skyCorrection.SkyCorrectionConfig.calExpCamera
static
Initial value:
= pipeBase.OutputDatasetField(
doc="Output camera image.",
name='calexp_camera',
scalar=True,
storageClass="ImageF",
dimensions=["instrument", "visit"],
)

Definition at line 101 of file skyCorrection.py.

◆ calexpType

lsst.pipe.drivers.skyCorrection.SkyCorrectionConfig.calexpType
static
Initial value:
= Field(dtype=str, default="calexp",
doc="Should be set to fakes_calexp if you want to process calexps with fakes in.")

Definition at line 125 of file skyCorrection.py.

◆ camera

lsst.pipe.drivers.skyCorrection.SkyCorrectionConfig.camera
static
Initial value:
= pipeBase.InputDatasetField(
doc="Input camera to use.",
name="camera",
scalar=True,
storageClass="TablePersistableCamera",
dimensions=["instrument", "calibration_label"],
)

Definition at line 86 of file skyCorrection.py.

◆ doBgModel

lsst.pipe.drivers.skyCorrection.SkyCorrectionConfig.doBgModel = Field(dtype=bool, default=True, doc="Do background model subtraction?")
static

Definition at line 121 of file skyCorrection.py.

◆ doBgModel2

lsst.pipe.drivers.skyCorrection.SkyCorrectionConfig.doBgModel2 = Field(dtype=bool, default=True, doc="Do cleanup background model subtraction?")
static

Definition at line 122 of file skyCorrection.py.

◆ doMaskObjects

lsst.pipe.drivers.skyCorrection.SkyCorrectionConfig.doMaskObjects = Field(dtype=bool, default=True, doc="Mask objects to find good sky?")
static

Definition at line 120 of file skyCorrection.py.

◆ doSky

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

Definition at line 123 of file skyCorrection.py.

◆ maskObjects

lsst.pipe.drivers.skyCorrection.SkyCorrectionConfig.maskObjects = ConfigurableField(target=MaskObjectsTask, doc="Mask Objects")
static

Definition at line 119 of file skyCorrection.py.

◆ rawLinker

lsst.pipe.drivers.skyCorrection.SkyCorrectionConfig.rawLinker
static
Initial value:
= pipeBase.InputDatasetField(
doc="Raw data to provide exp-visit linkage to connect calExp inputs to camera/sky calibs.",
name="raw",
scalar=False,
storageClass="ExposureU",
dimensions=["instrument", "exposure", "detector"],
)

Definition at line 63 of file skyCorrection.py.

◆ sky

lsst.pipe.drivers.skyCorrection.SkyCorrectionConfig.sky = ConfigurableField(target=SkyMeasurementTask, doc="Sky measurement")
static

Definition at line 118 of file skyCorrection.py.

◆ skyCalibs

lsst.pipe.drivers.skyCorrection.SkyCorrectionConfig.skyCalibs
static
Initial value:
= pipeBase.InputDatasetField(
doc="Input sky calibrations to use.",
name="sky",
scalar=False,
storageClass="ExposureF",
dimensions=["instrument", "physical_filter", "detector", "calibration_label"],
)

Definition at line 93 of file skyCorrection.py.

◆ skyCorr

lsst.pipe.drivers.skyCorrection.SkyCorrectionConfig.skyCorr
static
Initial value:
= pipeBase.OutputDatasetField(
doc="Output sky corrected images.",
name='skyCorr',
scalar=False,
storageClass="Background",
dimensions=["instrument", "visit", "detector"],
)

Definition at line 108 of file skyCorrection.py.


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