lsst.pipe.drivers  17.0.1-3-g9730928+11
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.drivers.skyCorrection.SkyCorrectionTask Class Reference
Inheritance diagram for lsst.pipe.drivers.skyCorrection.SkyCorrectionTask:
lsst::ctrl::pool::parallel::BatchPoolTask lsst::ctrl::pool::parallel::BatchCmdLineTask

Public Member Functions

def __init__ (self, args, kwargs)
 
def batchWallTime (cls, time, parsedCmd, numCores)
 
def runDataRef (self, expRef)
 
def focalPlaneBackground (self, camera, pool, dataIdList, config)
 
def loadImage (self, cache, dataId)
 
def measureSkyFrame (self, cache, dataId)
 
def subtractSkyFrame (self, cache, dataId, scale)
 
def accumulateModel (self, cache, data)
 
def subtractModel (self, cache, dataId, bgModel)
 
def realiseModel (self, cache, dataId, bgModel)
 
def collectBinnedImage (self, exposure, image)
 
def collect (self, cache)
 
def collectOriginal (self, cache, dataId)
 
def collectSky (self, cache, dataId)
 
def collectMask (self, cache, dataId)
 
def write (self, cache, dataId)
 
def parseAndRun (cls, args, kwargs)
 
def parseAndSubmit (cls, args=None, kwargs)
 
def batchWallTime (cls, time, parsedCmd, numCores)
 
def batchCommand (cls, args)
 
def logOperation (self, operation, catch=False, trace=True)
 

Static Public Attributes

 ConfigClass = SkyCorrectionConfig
 

Detailed Description

Correct sky over entire focal plane

Definition at line 58 of file skyCorrection.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 63 of file skyCorrection.py.

Member Function Documentation

◆ accumulateModel()

def lsst.pipe.drivers.skyCorrection.SkyCorrectionTask.accumulateModel (   self,
  cache,
  data 
)
Fit background model for CCD

This method runs on the slave nodes.

Parameters
----------
cache : `lsst.pipe.base.Struct`
    Process pool cache.
data : `lsst.pipe.base.Struct`
    Data identifier, with `dataId` (data identifier) and `bgModel`
    (background model) elements.

Returns
-------
bgModel : `lsst.pipe.drivers.background.FocalPlaneBackground`
    Background model.

Definition at line 268 of file skyCorrection.py.

◆ batchWallTime()

def lsst.pipe.drivers.skyCorrection.SkyCorrectionTask.batchWallTime (   cls,
  time,
  parsedCmd,
  numCores 
)
Return walltime request for batch job

Subclasses should override if the walltime should be calculated
differently (e.g., addition of some serial time).

Parameters
----------
time : `float`
    Requested time per iteration.
parsedCmd : `argparse.Namespace`
    Results of argument parsing.
numCores : `int`
    Number of cores.

Definition at line 77 of file skyCorrection.py.

◆ collect()

def lsst.pipe.drivers.skyCorrection.SkyCorrectionTask.collect (   self,
  cache 
)
Collect exposure for potential visualisation

This method runs on the slave nodes.

Parameters
----------
cache : `lsst.pipe.base.Struct`
    Process pool cache.

Returns
-------
detId : `int`
    Detector identifier.
image : `lsst.afw.image.MaskedImage`
    Binned image.

Definition at line 366 of file skyCorrection.py.

◆ collectBinnedImage()

def lsst.pipe.drivers.skyCorrection.SkyCorrectionTask.collectBinnedImage (   self,
  exposure,
  image 
)
Return the binned image required for visualization

This method just helps to cut down on boilerplate.

Parameters
----------
image : `lsst.afw.image.MaskedImage`
    Image to go into visualisation.

Returns
-------
detId : `int`
    Detector identifier.
image : `lsst.afw.image.MaskedImage`
    Binned image.

Definition at line 347 of file skyCorrection.py.

◆ collectMask()

def lsst.pipe.drivers.skyCorrection.SkyCorrectionTask.collectMask (   self,
  cache,
  dataId 
)
Collect mask for visualisation

This method runs on the slave nodes.

Parameters
----------
cache : `lsst.pipe.base.Struct`
    Process pool cache.
dataId : `dict`
    Data identifier.

Returns
-------
detId : `int`
    Detector identifier.
image : `lsst.afw.image.Image`
    Binned image.

Definition at line 428 of file skyCorrection.py.

◆ collectOriginal()

def lsst.pipe.drivers.skyCorrection.SkyCorrectionTask.collectOriginal (   self,
  cache,
  dataId 
)
Collect original image for visualisation

This method runs on the slave nodes.

Parameters
----------
cache : `lsst.pipe.base.Struct`
    Process pool cache.
dataId : `dict`
    Data identifier.

Returns
-------
detId : `int`
    Detector identifier.
image : `lsst.afw.image.MaskedImage`
    Binned image.

Definition at line 385 of file skyCorrection.py.

◆ collectSky()

def lsst.pipe.drivers.skyCorrection.SkyCorrectionTask.collectSky (   self,
  cache,
  dataId 
)
Collect original image for visualisation

This method runs on the slave nodes.

Parameters
----------
cache : `lsst.pipe.base.Struct`
    Process pool cache.
dataId : `dict`
    Data identifier.

Returns
-------
detId : `int`
    Detector identifier.
image : `lsst.afw.image.MaskedImage`
    Binned image.

Definition at line 407 of file skyCorrection.py.

◆ focalPlaneBackground()

def lsst.pipe.drivers.skyCorrection.SkyCorrectionTask.focalPlaneBackground (   self,
  camera,
  pool,
  dataIdList,
  config 
)
Perform full focal-plane background subtraction

This method runs on the master node.

Parameters
----------
camera : `lsst.afw.cameraGeom.Camera`
    Camera description.
pool : `lsst.ctrl.pool.Pool`
    Process pool.
dataIdList : iterable of `dict`
    List of data identifiers for the CCDs.
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.

Definition at line 157 of file skyCorrection.py.

◆ loadImage()

def lsst.pipe.drivers.skyCorrection.SkyCorrectionTask.loadImage (   self,
  cache,
  dataId 
)
Load original image and restore the sky

This method runs on the slave nodes.

Parameters
----------
cache : `lsst.pipe.base.Struct`
    Process pool cache.
dataId : `dict`
    Data identifier.

Returns
-------
exposure : `lsst.afw.image.Exposure`
    Resultant exposure.

Definition at line 186 of file skyCorrection.py.

◆ measureSkyFrame()

def lsst.pipe.drivers.skyCorrection.SkyCorrectionTask.measureSkyFrame (   self,
  cache,
  dataId 
)
Measure scale for sky frame

This method runs on the slave nodes.

Parameters
----------
cache : `lsst.pipe.base.Struct`
    Process pool cache.
dataId : `dict`
    Data identifier.

Returns
-------
scale : `float`
    Scale for sky frame.

Definition at line 223 of file skyCorrection.py.

◆ realiseModel()

def lsst.pipe.drivers.skyCorrection.SkyCorrectionTask.realiseModel (   self,
  cache,
  dataId,
  bgModel 
)
Generate an image of the background model for visualisation

Useful for debugging.

Parameters
----------
cache : `lsst.pipe.base.Struct`
    Process pool cache.
dataId : `dict`
    Data identifier.
bgModel : `lsst.pipe.drivers.background.FocalPlaneBackround`
    Background model.

Returns
-------
detId : `int`
    Detector identifier.
image : `lsst.afw.image.MaskedImage`
    Binned background model image.

Definition at line 319 of file skyCorrection.py.

◆ runDataRef()

def lsst.pipe.drivers.skyCorrection.SkyCorrectionTask.runDataRef (   self,
  expRef 
)
Perform sky correction on an exposure

We restore the original sky, and remove it again using multiple
algorithms. We optionally apply:

1. A large-scale background model.
    This step removes very-large-scale sky such as moonlight.
2. A sky frame.
3. A medium-scale background model.
    This step removes residual sky (This is smooth on the focal plane).

Only the master node executes this method. The data is held on
the slave nodes, which do all the hard work.

Parameters
----------
expRef : `lsst.daf.persistence.ButlerDataRef`
    Data reference for exposure.

Definition at line 95 of file skyCorrection.py.

◆ subtractModel()

def lsst.pipe.drivers.skyCorrection.SkyCorrectionTask.subtractModel (   self,
  cache,
  dataId,
  bgModel 
)
Subtract background model

This method runs on the slave nodes.

Parameters
----------
cache : `lsst.pipe.base.Struct`
    Process pool cache.
dataId : `dict`
    Data identifier.
bgModel : `lsst.pipe.drivers.background.FocalPlaneBackround`
    Background model.

Returns
-------
exposure : `lsst.afw.image.Exposure`
    Resultant exposure.

Definition at line 290 of file skyCorrection.py.

◆ subtractSkyFrame()

def lsst.pipe.drivers.skyCorrection.SkyCorrectionTask.subtractSkyFrame (   self,
  cache,
  dataId,
  scale 
)
Subtract sky frame

This method runs on the slave nodes.

Parameters
----------
cache : `lsst.pipe.base.Struct`
    Process pool cache.
dataId : `dict`
    Data identifier.
scale : `float`
    Scale for sky frame.

Returns
-------
exposure : `lsst.afw.image.Exposure`
    Resultant exposure.

Definition at line 245 of file skyCorrection.py.

◆ write()

def lsst.pipe.drivers.skyCorrection.SkyCorrectionTask.write (   self,
  cache,
  dataId 
)
Write resultant background list

This method runs on the slave nodes.

Parameters
----------
cache : `lsst.pipe.base.Struct`
    Process pool cache.
dataId : `dict`
    Data identifier.

Definition at line 452 of file skyCorrection.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 60 of file skyCorrection.py.


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