lsst.pipe.tasks gb77071e687+d21f51b6f1
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.skyCorrection.SkyCorrectionTask Class Reference
Inheritance diagram for lsst.pipe.tasks.skyCorrection.SkyCorrectionTask:

Public Member Functions

def runQuantum (self, butlerQC, inputRefs, outputRefs)
 
def __init__ (self, *args, **kwargs)
 
def focalPlaneBackgroundRun (self, camera, cacheExposures, idList, config)
 
def run (self, calExpArray, calBkgArray, skyCalibs, camera)
 
def loadImageRun (self, calExp, calExpBkg)
 
def subtractModelRun (self, exposure, bgModel)
 

Static Public Attributes

 ConfigClass = SkyCorrectionConfig
 

Detailed Description

Correct sky over entire focal plane

Definition at line 254 of file skyCorrection.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.skyCorrection.SkyCorrectionTask.__init__ (   self,
args,
**  kwargs 
)

Definition at line 282 of file skyCorrection.py.

Member Function Documentation

◆ focalPlaneBackgroundRun()

def lsst.pipe.tasks.skyCorrection.SkyCorrectionTask.focalPlaneBackgroundRun (   self,
  camera,
  cacheExposures,
  idList,
  config 
)
Perform full focal-plane background subtraction

This method runs on the master node.

Parameters
----------
camera : `lsst.afw.cameraGeom.Camera`
    Camera description.
cacheExposures : `list` of `lsst.afw.image.Exposures`
    List of loaded and processed input calExp.
idList : `list` of `int`
    List of detector ids to iterate over.
config : `lsst.pipe.drivers.background.FocalPlaneBackgroundConfig`
    Configuration to use for background subtraction.

Returns
-------
exposures : `list` of `lsst.afw.image.Image`
    List of binned images, for creating focal plane image.
newCacheBgList : `list` of `lsst.afwMath.backgroundList`
    Background lists generated.
cacheBgModel : `FocalPlaneBackground`
    Full focal plane background model.

Definition at line 288 of file skyCorrection.py.

◆ loadImageRun()

def lsst.pipe.tasks.skyCorrection.SkyCorrectionTask.loadImageRun (   self,
  calExp,
  calExpBkg 
)
Serial implementation of self.loadImage() for Gen3.

Load and restore background to calExp and calExpBkg.

Parameters
----------
calExp : `lsst.afw.image.Exposure`
    Detector level calExp image to process.
calExpBkg : `lsst.afw.math.BackgroundList`
    Detector level background list associated with the calExp.

Returns
-------
calExp : `lsst.afw.image.Exposure`
    Background restored calExp.
bgList : `lsst.afw.math.BackgroundList`
    New background list containing the restoration background.

Definition at line 438 of file skyCorrection.py.

◆ run()

def lsst.pipe.tasks.skyCorrection.SkyCorrectionTask.run (   self,
  calExpArray,
  calBkgArray,
  skyCalibs,
  camera 
)
Performa sky correction on an exposure.

Parameters
----------
calExpArray : `list` of `lsst.afw.image.Exposure`
    Array of detector input calExp images for the exposure to
    process.
calBkgArray : `list` of `lsst.afw.math.BackgroundList`
    Array of detector input background lists matching the
    calExps to process.
skyCalibs : `list` of `lsst.afw.image.Exposure`
    Array of SKY calibrations for the input detectors to be
    processed.
camera : `lsst.afw.cameraGeom.Camera`
    Camera matching the input data to process.

Returns
-------
results : `pipeBase.Struct` containing
    calExpCamera : `lsst.afw.image.Exposure`
        Full camera image of the sky-corrected data.
    skyCorr : `list` of `lsst.afw.math.BackgroundList`
        Detector-level sky-corrected background lists.

Definition at line 336 of file skyCorrection.py.

◆ runQuantum()

def lsst.pipe.tasks.skyCorrection.SkyCorrectionTask.runQuantum (   self,
  butlerQC,
  inputRefs,
  outputRefs 
)

Definition at line 259 of file skyCorrection.py.

◆ subtractModelRun()

def lsst.pipe.tasks.skyCorrection.SkyCorrectionTask.subtractModelRun (   self,
  exposure,
  bgModel 
)
Serial implementation of self.subtractModel() for Gen3.

Load and restore background to calExp and calExpBkg.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure to subtract the background model from.
bgModel : `lsst.pipe.drivers.background.FocalPlaneBackground`
    Full camera level background model.

Returns
-------
exposure : `lsst.afw.image.Exposure`
    Background subtracted input exposure.
bgModelCcd : `lsst.afw.math.BackgroundList`
    Detector level realization of the full background model.
bgModelMaskedImage : `lsst.afw.image.MaskedImage`
    Background model from the bgModelCcd realization.

Definition at line 473 of file skyCorrection.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.skyCorrection.SkyCorrectionTask.ConfigClass = SkyCorrectionConfig
static

Definition at line 256 of file skyCorrection.py.


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