|
def | __init__ (self, args, kwargs) |
|
def | batchWallTime (cls, time, parsedCmd, numCores) |
|
def | run (self, expRef) |
|
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 | collect (self, cache) |
|
def | collectOriginal (self, cache, dataId) |
|
def | collectSky (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) |
|
Correct sky over entire focal plane
Definition at line 51 of file skyCorrection.py.
◆ __init__()
def lsst.pipe.drivers.skyCorrection.SkyCorrectionTask.__init__ |
( |
|
self, |
|
|
|
args, |
|
|
|
kwargs |
|
) |
| |
◆ 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 235 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 70 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 314 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 334 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 357 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 156 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 190 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 286 of file skyCorrection.py.
◆ run()
def lsst.pipe.drivers.skyCorrection.SkyCorrectionTask.run |
( |
|
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.
2. A sky frame.
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 88 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 257 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 212 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 378 of file skyCorrection.py.
◆ ConfigClass
The documentation for this class was generated from the following file: