SerialOverscanCorrectionTask#
- class lsst.ip.isr.SerialOverscanCorrectionTask(statControl=None, **kwargs)#
Bases:
OverscanCorrectionTaskBaseCorrection task for serial overscan.
Parameters#
- statControl
lsst.afw.math.StatisticsControl, optional Statistics control object.
Methods Summary
run(exposure, amp[, isTransposed])Measure and remove serial overscan from an amplifier image.
Methods Documentation
- run(exposure, amp, isTransposed=False)#
Measure and remove serial overscan from an amplifier image.
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:
imageFitValue or fit subtracted from the amplifier image data (scalar or
lsst.afw.image.Image).overscanFitValue or fit subtracted from the serial overscan image data (scalar or
lsst.afw.image.Image).overscanImageImage 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.overscanMeanMean of the fit serial overscan region.
overscanMedianMedian of the fit serial overscan region.
overscanSigmaSigma of the fit serial overscan region.
residualMeanMean of the residual of the serial overscan region after correction.
residualMedianMedian of the residual of the serial overscan region after correction.
residualSigmaMean of the residual of the serial overscan region after correction.
Raises#
- RuntimeError
Raised if an invalid overscan type is set.
- exposure
- statControl