OverscanCorrectionTask#

class lsst.ip.isr.OverscanCorrectionTask(statControl=None, **kwargs)#

Bases: OverscanCorrectionTaskBase

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#

statControllsst.afw.math.StatisticsControl, optional: Statistics control object.

Methods Summary

run(exposure, amp[, isTransposed])

Measure and remove serial/parallel overscan from an amplifier image.

Methods Documentation

run(exposure, amp, isTransposed=False)#

Measure and remove serial/parallel overscan from an amplifier image.

This will be deprecated.

exposurelsst.afw.image.Exposure: Image data that will have the overscan corrections applied.
amplsst.afw.cameraGeom.Amplifier: Amplifier to use for debugging purposes.
isTransposedbool, optional: Is the image transposed, such that serial and parallel overscan regions are reversed? Default is False.

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.