Correction task for serial/parallel overscan.
(Will be deprecated)
This class contains a number of utilities that are easier to
understand and use when they are not embedded in nested if/else
loops.
Parameters
----------
statControl : `lsst.afw.math.StatisticsControl`, optional
Statistics control object.
Definition at line 878 of file overscan.py.
lsst.ip.isr.overscan.OverscanCorrectionTask.run |
( |
| self, |
|
|
| exposure, |
|
|
| amp, |
|
|
| isTransposed = False ) |
Measure and remove serial/parallel overscan from an amplifier image.
This will be deprecated.
Parameters
----------
exposure : `lsst.afw.image.Exposure`
Image data that will have the overscan corrections applied.
amp : `lsst.afw.cameraGeom.Amplifier`
Amplifier to use for debugging purposes.
isTransposed : `bool`, optional
Is the image transposed, such that serial and parallel
overscan regions are reversed? Default is False.
Returns
-------
overscanResults : `lsst.pipe.base.Struct`
Result struct with components:
``imageFit``
Value or fit subtracted from the amplifier image data
(scalar or `lsst.afw.image.Image`).
``overscanFit``
Value or fit subtracted from the serial overscan image
data (scalar or `lsst.afw.image.Image`).
``overscanImage``
Image of the serial overscan region with the serial
overscan correction applied
(`lsst.afw.image.Image`). This quantity is used to
estimate the amplifier read noise empirically.
``parallelOverscanFit``
Value or fit subtracted from the parallel overscan
image data (scalar, `lsst.afw.image.Image`, or None).
``parallelOverscanImage``
Image of the parallel overscan region with the
parallel overscan correction applied
(`lsst.afw.image.Image` or None).
``overscanMean``
Mean of the fit serial overscan region.
This and the following values will be tuples of
(serial, parallel) if doParallelOverscan=True.
``overscanMedian``
Median of the fit serial overscan region.
``overscanSigma``
Sigma of the fit serial overscan region.
``residualMean``
Mean of the residual of the serial overscan region after
correction.
``residualMedian``
Median of the residual of the serial overscan region after
correction.
``residualSigma``
Mean of the residual of the serial overscan region after
correction.
Raises
------
RuntimeError
Raised if an invalid overscan type is set.
Reimplemented from lsst.ip.isr.overscan.OverscanCorrectionTaskBase.
Definition at line 895 of file overscan.py.