lsst.ip.isr g02d81e74bb+f5613e8b4f
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Static Protected Attributes | List of all members
lsst.ip.isr.overscan.SerialOverscanCorrectionTask Class Reference
Inheritance diagram for lsst.ip.isr.overscan.SerialOverscanCorrectionTask:
lsst.ip.isr.overscan.OverscanCorrectionTaskBase

Public Member Functions

 run (self, exposure, amp, isTransposed=False)
 

Static Public Attributes

 ConfigClass = SerialOverscanCorrectionTaskConfig
 

Static Protected Attributes

str _DefaultName = "serialOverscan"
 

Detailed Description

Correction task for serial overscan.

Parameters
----------
statControl : `lsst.afw.math.StatisticsControl`, optional
    Statistics control object.

Definition at line 1060 of file overscan.py.

Member Function Documentation

◆ run()

lsst.ip.isr.overscan.SerialOverscanCorrectionTask.run ( self,
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:

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

Reimplemented from lsst.ip.isr.overscan.OverscanCorrectionTaskBase.

Definition at line 1071 of file overscan.py.

Member Data Documentation

◆ _DefaultName

str lsst.ip.isr.overscan.SerialOverscanCorrectionTask._DefaultName = "serialOverscan"
staticprotected

Definition at line 1069 of file overscan.py.

◆ ConfigClass

lsst.ip.isr.overscan.SerialOverscanCorrectionTask.ConfigClass = SerialOverscanCorrectionTaskConfig
static

Definition at line 1068 of file overscan.py.


The documentation for this class was generated from the following file: