ParallelOverscanCorrectionTask#

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

Bases: OverscanCorrectionTaskBase

Correction task for parallel overscan.

Parameters#

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

Methods Summary

`maskParallelOverscanAmp`(exposure, amp[, ...])	Mask parallel overscan, growing saturated pixels.
`run`(exposure, amp[, isTransposed])	Measure and remove parallel overscan from an amplifier image.

Methods Documentation

maskParallelOverscanAmp(exposure, amp, saturationLevel=None)#

Mask parallel overscan, growing saturated pixels.

This operates on the image in-place.

run(exposure, amp, isTransposed=False)#

Measure and remove parallel overscan from an amplifier image.

This method assumes that serial overscan has already been removed from the amplifier.

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 parallel overscan image data (scalar or lsst.afw.image.Image).
overscanImage: Image of the parallel overscan region with the parallel overscan correction applied (lsst.afw.image.Image). This quantity is used to estimate the amplifier read noise empirically.
overscanMean: Mean of the fit parallel overscan region.
overscanMedian: Median of the fit parallel overscan region.
overscanSigma: Sigma of the fit parallel overscan region.
residualMean: Mean of the residual of the parallel overscan region after correction.
residualMedian: Median of the residual of the parallel overscan region after correction.
residualSigma: Mean of the residual of the parallel overscan region after correction.