SerialOverscanCorrectionTask#

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

Bases: OverscanCorrectionTaskBase

Correction task for serial overscan.

Parameters#

statControllsst.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#

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.

Returns#

overscanResultslsst.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.

overscanMean

Mean of the fit serial overscan region.

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.