LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
Public Member Functions | |
def | __init__ (self, statControl=None, **kwargs) |
def | run (self, ampImage, overscanImage, amp=None) |
def | measureConstantOverscan (self, image) |
def | getImageArray (self, image) |
def | maskOutliers (self, imageArray) |
def | collapseArrayMedian (self, maskedArray) |
def | splineFit (self, indices, collapsed, numBins) |
def | measureVectorOverscan (self, image) |
def | debugView (self, image, model, amp=None) |
Static Public Member Functions | |
def | integerConvert (image) |
def | transpose (imageArray) |
def | collapseArray (maskedArray) |
def | splineEval (indices, interp) |
def | maskExtrapolated (collapsed) |
Public Attributes | |
allowDebug | |
statControl | |
Static Public Attributes | |
ConfigClass = OverscanCorrectionTaskConfig | |
Correction task for overscan. 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 ---------- statControl : `lsst.afw.math.StatisticsControl`, optional Statistics control object.
Definition at line 75 of file overscan.py.
def lsst.ip.isr.overscan.OverscanCorrectionTask.__init__ | ( | self, | |
statControl = None , |
|||
** | kwargs | ||
) |
Definition at line 90 of file overscan.py.
|
static |
Collapse overscan array (and mask) to a 1-D vector of values. Parameters ---------- maskedArray : `numpy.ma.masked_array` Masked array of input overscan data. Returns ------- collapsed : `numpy.ma.masked_array` Single dimensional overscan data, combined with the mean.
Definition at line 311 of file overscan.py.
def lsst.ip.isr.overscan.OverscanCorrectionTask.collapseArrayMedian | ( | self, | |
maskedArray | |||
) |
Collapse overscan array (and mask) to a 1-D vector of using the correct integer median of row-values. Parameters ---------- maskedArray : `numpy.ma.masked_array` Masked array of input overscan data. Returns ------- collapsed : `numpy.ma.masked_array` Single dimensional overscan data, combined with the afwMath median.
Definition at line 329 of file overscan.py.
def lsst.ip.isr.overscan.OverscanCorrectionTask.debugView | ( | self, | |
image, | |||
model, | |||
amp = None |
|||
) |
Debug display for the final overscan solution. Parameters ---------- image : `lsst.afw.image.Image` Input image the overscan solution was determined from. model : `numpy.ndarray` or `float` Overscan model determined for the image. amp : `lsst.afw.cameraGeom.Amplifier`, optional Amplifier to extract diagnostic information.
Definition at line 491 of file overscan.py.
def lsst.ip.isr.overscan.OverscanCorrectionTask.getImageArray | ( | self, | |
image | |||
) |
Extract the numpy array from the input image. Parameters ---------- image : `lsst.afw.image.Image` or `lsst.afw.image.MaskedImage` Image data to pull array from. calcImage : `numpy.ndarray` Image data array for numpy operating.
Definition at line 248 of file overscan.py.
|
static |
Return an integer version of the input image. Parameters ---------- image : `numpy.ndarray`, `lsst.afw.image.Image` or `MaskedImage` Image to convert to integers. Returns ------- outI : `numpy.ndarray`, `lsst.afw.image.Image` or `MaskedImage` The integer converted image. Raises ------ RuntimeError Raised if the input image could not be converted.
Definition at line 185 of file overscan.py.
|
static |
Create mask if edges are extrapolated. Parameters ---------- collapsed : `numpy.ma.masked_array` Masked array to check the edges of. Returns ------- maskArray : `numpy.ndarray` Boolean numpy array of pixels to mask.
Definition at line 410 of file overscan.py.
def lsst.ip.isr.overscan.OverscanCorrectionTask.maskOutliers | ( | self, | |
imageArray | |||
) |
Mask outliers in a row of overscan data from a robust sigma clipping procedure. Parameters ---------- imageArray : `numpy.ndarray` Image to filter along numpy axis=1. Returns ------- maskedArray : `numpy.ma.masked_array` Masked image marking outliers.
Definition at line 288 of file overscan.py.
def lsst.ip.isr.overscan.OverscanCorrectionTask.measureConstantOverscan | ( | self, | |
image | |||
) |
Measure a constant overscan value. Parameters ---------- image : `lsst.afw.image.Image` or `lsst.afw.image.MaskedImage` Image data to measure the overscan from. Returns ------- results : `lsst.pipe.base.Struct` Overscan result with entries: - ``overscanValue``: Overscan value to subtract (`float`) - ``maskArray``: Placeholder for a mask array (`list`) - ``isTransposed``: Orientation of the overscan (`bool`)
Definition at line 219 of file overscan.py.
def lsst.ip.isr.overscan.OverscanCorrectionTask.measureVectorOverscan | ( | self, | |
image | |||
) |
Calculate the 1-d vector overscan from the input overscan image. Parameters ---------- image : `lsst.afw.image.MaskedImage` Image containing the overscan data. Returns ------- results : `lsst.pipe.base.Struct` Overscan result with entries: - ``overscanValue``: Overscan value to subtract (`float`) - ``maskArray`` : `list` [ `bool` ] List of rows that should be masked as ``SUSPECT`` when the overscan solution is applied. - ``isTransposed`` : `bool` Indicates if the overscan data was transposed during calcuation, noting along which axis the overscan should be subtracted.
Definition at line 438 of file overscan.py.
def lsst.ip.isr.overscan.OverscanCorrectionTask.run | ( | self, | |
ampImage, | |||
overscanImage, | |||
amp = None |
|||
) |
Measure and remove an overscan from an amplifier image. Parameters ---------- ampImage : `lsst.afw.image.Image` Image data that will have the overscan removed. overscanImage : `lsst.afw.image.Image` Overscan data that the overscan is measured from. amp : `lsst.afw.cameraGeom.Amplifier`, optional Amplifier to use for debugging purposes. 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 overscan image data (scalar or `lsst.afw.image.Image`). ``overscanImage`` Image of the overscan region with the overscan correction applied (`lsst.afw.image.Image`). This quantity is used to estimate the amplifier read noise empirically. Raises ------ RuntimeError Raised if an invalid overscan type is set.
Definition at line 101 of file overscan.py.
|
static |
Wrapper function to match spline evaluation API to polynomial fit API. Parameters ---------- indices : `numpy.ndarray` Locations to evaluate the spline. interp : `lsst.afw.math.interpolate` Interpolation object to use. Returns ------- values : `numpy.ndarray` Evaluated spline values at each index.
Definition at line 391 of file overscan.py.
def lsst.ip.isr.overscan.OverscanCorrectionTask.splineFit | ( | self, | |
indices, | |||
collapsed, | |||
numBins | |||
) |
Wrapper function to match spline fit API to polynomial fit API. Parameters ---------- indices : `numpy.ndarray` Locations to evaluate the spline. collapsed : `numpy.ndarray` Collapsed overscan values corresponding to the spline evaluation points. numBins : `int` Number of bins to use in constructing the spline. Returns ------- interp : `lsst.afw.math.Interpolate` Interpolation object for later evaluation.
Definition at line 357 of file overscan.py.
|
static |
Transpose input numpy array if necessary. Parameters ---------- imageArray : `numpy.ndarray` Image data to transpose. Returns ------- imageArray : `numpy.ndarray` Transposed image data. isTransposed : `bool` Indicates whether the input data was transposed.
Definition at line 268 of file overscan.py.
lsst.ip.isr.overscan.OverscanCorrectionTask.allowDebug |
Definition at line 92 of file overscan.py.
|
static |
Definition at line 87 of file overscan.py.
lsst.ip.isr.overscan.OverscanCorrectionTask.statControl |
Definition at line 95 of file overscan.py.