Inheritance diagram for lsst.pipe.drivers.skyCorrection.SkyCorrectionTask:

Public Member Functions
def	runQuantum (self, butlerQC, inputRefs, outputRefs)

def	__init__ (self, args, kwargs)

def	batchWallTime (cls, time, parsedCmd, numCores)

def	runDataRef (self, expRef)

def	focalPlaneBackground (self, camera, pool, dataIdList, config)

def	focalPlaneBackgroundRun (self, camera, cacheExposures, idList, config)

def	run (self, calExpArray, calBkgArray, skyCalibs, camera)

def	loadImage (self, cache, dataId)

def	loadImageRun (self, calExp, calExpBkg)

def	measureSkyFrame (self, cache, dataId)

def	subtractSkyFrame (self, cache, dataId, scale)

def	accumulateModel (self, cache, data)

def	subtractModel (self, cache, dataId, bgModel)

def	subtractModelRun (self, exposure, 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 133 of file skyCorrection.py.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 144 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 545 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 160 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 672 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 653 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 734 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 691 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 713 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 245 of file skyCorrection.py.

◆ focalPlaneBackgroundRun()

def lsst.pipe.drivers.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 274 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 428 of file skyCorrection.py.

◆ loadImageRun()

def lsst.pipe.drivers.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 465 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 500 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 625 of file skyCorrection.py.

◆ run()

def lsst.pipe.drivers.skyCorrection.SkyCorrectionTask.run	(	self,
		calExpArray,
		calBkgArray,
		skyCalibs,
		camera
	)

Duplicate runDataRef method without ctrl_pool for Gen3.

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.

See Also
--------
~lsst.pipe.drivers.SkyCorrectionTask.runDataRef()

Definition at line 322 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.

See Also
--------
~lsst.pipe.drivers.SkyCorrectionTask.run

Definition at line 178 of file skyCorrection.py.

◆ runQuantum()

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

Definition at line 138 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 567 of file skyCorrection.py.

◆ subtractModelRun()

def lsst.pipe.drivers.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 596 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 522 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 758 of file skyCorrection.py.

Member Data Documentation

◆ ConfigClass

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

static

Definition at line 135 of file skyCorrection.py.

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

python/lsst/pipe/drivers/skyCorrection.py

Public Member Functions

Static Public Attributes