lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig:

Public Member Functions
	setDefaults (self)
	validate (self)

Static Public Attributes
	doApplyFlatBackgroundRatio
	maskObjects
	doMaskObjects
	bgModel1
	undoBgModel1
	sky
	doSky
	bgModel2
	doBgModel2
	binning
	calExps
	calBkgs
	backgroundToPhotometricRatioHandles
	skyFrames
	camera
	skyCorr
	calExpMosaic
	calBkgMosaic

Detailed Description

Definition at line 145 of file skyCorrection.py.

Member Function Documentation

setDefaults()

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.setDefaults

(

self

)

Definition at line 193 of file skyCorrection.py.

    def setDefaults(self):
        Config.setDefaults(self)
        self.bgModel2.doSmooth = True
        self.bgModel2.minFrac = 0.3
        self.bgModel2.xSize = 256
        self.bgModel2.ySize = 256
        self.bgModel2.smoothScale = 1.0
 

validate()

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.validate

(

self

)

Definition at line 201 of file skyCorrection.py.

    def validate(self):
        super().validate()
        if self.undoBgModel1 and not self.doSky and not self.doBgModel2:
            raise ValueError("If undoBgModel1 is True, task requires at least one of doSky or doBgModel2.")
 
 

Member Data Documentation

backgroundToPhotometricRatioHandles

lsst.pipe.tasks.skyCorrection.SkyCorrectionConnections.backgroundToPhotometricRatioHandles

staticinherited

Initial value:

=  Input(
        doc="Ratio of a background-flattened image to a photometric-flattened image. "
        "Only used if doApplyFlatBackgroundRatio is True.",
        multiple=True,
        name="background_to_photometric_ratio",
        storageClass="Image",
        dimensions=["instrument", "visit", "detector"],
        deferLoad=True,
    )

Definition at line 91 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 160 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 178 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 187 of file skyCorrection.py.

calBkgMosaic

lsst.pipe.tasks.skyCorrection.SkyCorrectionConnections.calBkgMosaic

staticinherited

Initial value:

=  Output(
        doc="Full focal plane mosaicked image of the sky corrected calibrated exposure backgrounds.",
        name="calexpBackground_skyCorr_visit_mosaic",
        storageClass="ImageF",
        dimensions=["instrument", "visit"],
    )

Definition at line 129 of file skyCorrection.py.

calBkgs

lsst.pipe.tasks.skyCorrection.SkyCorrectionConnections.calBkgs

staticinherited

Initial value:

=  Input(
        doc="Subtracted backgrounds for input calibrated exposures.",
        name="calexpBackground",
        multiple=True,
        storageClass="Background",
        dimensions=["instrument", "visit", "detector"],
    )

Definition at line 84 of file skyCorrection.py.

calExpMosaic

lsst.pipe.tasks.skyCorrection.SkyCorrectionConnections.calExpMosaic

staticinherited

Initial value:

=  Output(
        doc="Full focal plane mosaicked image of the sky corrected calibrated exposures.",
        name="calexp_skyCorr_visit_mosaic",
        storageClass="ImageF",
        dimensions=["instrument", "visit"],
    )

Definition at line 123 of file skyCorrection.py.

calExps

lsst.pipe.tasks.skyCorrection.SkyCorrectionConnections.calExps

staticinherited

Initial value:

=  Input(
        doc="Background-subtracted calibrated exposures.",
        name="calexp",
        multiple=True,
        deferLoad=True,
        storageClass="ExposureF",
        dimensions=["instrument", "visit", "detector"],
    )

Definition at line 76 of file skyCorrection.py.

camera

lsst.pipe.tasks.skyCorrection.SkyCorrectionConnections.camera

staticinherited

Initial value:

=  PrerequisiteInput(
        doc="Input camera.",
        name="camera",
        storageClass="Camera",
        dimensions=["instrument"],
        isCalibration=True,
    )

Definition at line 109 of file skyCorrection.py.

doApplyFlatBackgroundRatio

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.doApplyFlatBackgroundRatio

static

Initial value:

=  Field(
        dtype=bool,
        default=False,
        doc="This should be True if the input image was processed with an illumination correction.",
    )

Definition at line 146 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 182 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 155 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 173 of file skyCorrection.py.

maskObjects

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.maskObjects

static

Initial value:

=  ConfigurableField(
        target=MaskObjectsTask,
        doc="Mask Objects",
    )

Definition at line 151 of file skyCorrection.py.

sky

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.sky

static

Initial value:

=  ConfigurableField(
        target=SkyMeasurementTask,
        doc="Sky measurement",
    )

Definition at line 169 of file skyCorrection.py.

skyCorr

lsst.pipe.tasks.skyCorrection.SkyCorrectionConnections.skyCorr

staticinherited

Initial value:

=  Output(
        doc="Sky correction data, to be subtracted from the calibrated exposures.",
        name="skyCorr",
        multiple=True,
        storageClass="Background",
        dimensions=["instrument", "visit", "detector"],
    )

Definition at line 116 of file skyCorrection.py.

skyFrames

lsst.pipe.tasks.skyCorrection.SkyCorrectionConnections.skyFrames

staticinherited

Initial value:

=  PrerequisiteInput(
        doc="Calibration sky frames.",
        name="sky",
        multiple=True,
        deferLoad=True,
        storageClass="ExposureF",
        dimensions=["instrument", "physical_filter", "detector"],
        isCalibration=True,
    )

Definition at line 100 of file skyCorrection.py.

undoBgModel1

lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig.undoBgModel1

static

Initial value:

=  Field(
        dtype=bool,
        default=False,
        doc="If True, adds back initial background model after sky and removes bgModel1 from the list",
    )

Definition at line 164 of file skyCorrection.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/pipe_tasks/g99af87f6a8+b0f4ad7b8d/python/lsst/pipe/tasks/skyCorrection.py