|
def | __init__ (self, **kwargs) |
|
def | runQuantum (self, butlerQC, inputRefs, outputRefs) |
|
def | run (self, inputExps, inputScales=None, inputDims=None) |
|
def | getDimensions (self, expList) |
|
def | getSize (self, dimList) |
|
def | applyScale (self, exposure, scale=None) |
|
def | combine (self, target, expList, stats) |
|
def | combineHeaders (self, expList, calib, calibType="CALIB", scales=None) |
|
def | interpolateNans (self, exp) |
|
Task to combine calib exposures.
Definition at line 222 of file cpCombine.py.
◆ __init__()
def lsst.cp.pipe.cpCombine.CalibCombineTask.__init__ |
( |
|
self, |
|
|
** |
kwargs |
|
) |
| |
◆ applyScale()
def lsst.cp.pipe.cpCombine.CalibCombineTask.applyScale |
( |
|
self, |
|
|
|
exposure, |
|
|
|
scale = None |
|
) |
| |
Apply scale to input exposure.
This implementation applies a flux scaling: the input exposure is
divided by the provided scale.
Parameters
----------
exposure : `lsst.afw.image.Exposure`
Exposure to scale.
scale : `float` or `list` [`float`], optional
Constant scale to divide the exposure by.
Definition at line 388 of file cpCombine.py.
◆ combine()
def lsst.cp.pipe.cpCombine.CalibCombineTask.combine |
( |
|
self, |
|
|
|
target, |
|
|
|
expList, |
|
|
|
stats |
|
) |
| |
Combine multiple images.
Parameters
----------
target : `lsst.afw.image.Exposure`
Output exposure to construct.
expList : `list` [`lsst.afw.image.Exposure`]
Input exposures to combine.
stats : `lsst.afw.math.StatisticsControl`
Control explaining how to combine the input images.
Definition at line 410 of file cpCombine.py.
◆ combineHeaders()
def lsst.cp.pipe.cpCombine.CalibCombineTask.combineHeaders |
( |
|
self, |
|
|
|
expList, |
|
|
|
calib, |
|
|
|
calibType = "CALIB" , |
|
|
|
scales = None |
|
) |
| |
Combine input headers to determine the set of common headers,
supplemented by calibration inputs.
Parameters
----------
expList : `list` of `lsst.afw.image.Exposure`
Input list of exposures to combine.
calib : `lsst.afw.image.Exposure`
Output calibration to construct headers for.
calibType: `str`, optional
OBSTYPE the output should claim.
scales: `list` of `float`, optional
Scale values applied to each input to record.
Returns
-------
header : `lsst.daf.base.PropertyList`
Constructed header.
Definition at line 425 of file cpCombine.py.
◆ getDimensions()
def lsst.cp.pipe.cpCombine.CalibCombineTask.getDimensions |
( |
|
self, |
|
|
|
expList |
|
) |
| |
Get dimensions of the inputs.
Parameters
----------
expList : `list` [`lsst.afw.image.Exposure`]
Exps to check the sizes of.
Returns
-------
width, height : `int`
Unique set of input dimensions.
Definition at line 349 of file cpCombine.py.
◆ getSize()
def lsst.cp.pipe.cpCombine.CalibCombineTask.getSize |
( |
|
self, |
|
|
|
dimList |
|
) |
| |
Determine a consistent size, given a list of image sizes.
Parameters
-----------
dimList : iterable of `tuple` (`int`, `int`)
List of dimensions.
Raises
------
RuntimeError
If input dimensions are inconsistent.
Returns
--------
width, height : `int`
Common dimensions.
Definition at line 365 of file cpCombine.py.
◆ interpolateNans()
def lsst.cp.pipe.cpCombine.CalibCombineTask.interpolateNans |
( |
|
self, |
|
|
|
exp |
|
) |
| |
Interpolate over NANs in the combined image.
NANs can result from masked areas on the CCD. We don't want them getting
into our science images, so we replace them with the median of the image.
Parameters
----------
exp : `lsst.afw.image.Exposure`
Exp to check for NaNs.
Definition at line 505 of file cpCombine.py.
◆ run()
def lsst.cp.pipe.cpCombine.CalibCombineTask.run |
( |
|
self, |
|
|
|
inputExps, |
|
|
|
inputScales = None , |
|
|
|
inputDims = None |
|
) |
| |
Combine calib exposures for a single detector.
Parameters
----------
inputExps : `list` [`lsst.afw.image.Exposure`]
Input list of exposures to combine.
inputScales : `dict` [`dict` [`dict` [`float`]]], optional
Dictionary of scales, indexed by detector (`int`),
amplifier (`int`), and exposure (`int`). Used for
'inputList' scaling.
inputDims : `list` [`dict`]
List of dictionaries of input data dimensions/values.
Each list entry should contain:
``"exposure"``
exposure id value (`int`)
``"detector"``
detector id value (`int`)
Returns
-------
combinedExp : `lsst.afw.image.Exposure`
Final combined exposure generated from the inputs.
Raises
------
RuntimeError
Raised if no input data is found. Also raised if
config.exposureScaling == InputList, and a necessary scale
was not found.
Definition at line 241 of file cpCombine.py.
◆ runQuantum()
def lsst.cp.pipe.cpCombine.CalibCombineTask.runQuantum |
( |
|
self, |
|
|
|
butlerQC, |
|
|
|
inputRefs, |
|
|
|
outputRefs |
|
) |
| |
◆ ConfigClass
The documentation for this class was generated from the following file: