ParallelOverscanCorrectionTaskConfig

class lsst.ip.isr.ParallelOverscanCorrectionTaskConfig(*args, **kw)

Bases: OverscanCorrectionTaskConfigBase

Attributes Summary

doAbsoluteMaxDeviation	Apply the maxDeviation to the absolute value of the deviation? If False, this will be a one-sided cut for positive-only deviations (typically for parallel overscan subtraction.
doMedianSmoothingOutlierRejection	Do column-by-column median smoothing outlier rejection? Columns that are rejected in this way will be grown by parallelOverscanMaskedColumnGrowSize.
doParallelOverscanSaturation	Mask saturated pixels in parallel overscan region? (bool, default True)
fitType	The method for fitting the overscan bias level.
leadingToSkip	Number of leading values to skip in parallel overscan correction.
maskPlanes	Mask planes to reject when measuring overscan (List, default ['BAD', 'SAT'])
maxDeviation	Maximum deviation from median (in ADU) to mask in overscan correction; Will be applied to the absolute deviation if doAbsoluteMaxDeviation=True.
medianSmoothingKernel	Kernel (pixels) to use to smooth the parallel overscan columns.
medianSmoothingOutlierThreshold	Outlier threshold after parallel median smoothing (adu).
numSigmaClip	Rejection threshold (sigma) for collapsing overscan before fit (float, default 3.0)
order	Order of polynomial to fit if overscan fit type is a polynomial, or number of spline knots if overscan fit type is a spline.
overscanIsInt	Treat overscan as an integer image for purposes of fitType=MEDIAN and fitType=MEDIAN_PER_ROW.
parallelOverscanFraction	When the parallel overscan region median is greater than parallelOverscanFraction and the imaging region median is greater than parallelOverscanImageThreshold then parallel overscan subtraction will be turned off, as this is usually due to the region being flooded with spillover from a super-saturated flat.
parallelOverscanImageThreshold	When the parallel overscan region median is greater than parallelOverscanFraction and the imaging region median is greater than parallelOverscanImageThreshold then parallel overscan subtraction will be turned off, as this is usually due to the region being flooded with spillover from a super-saturated flat.
parallelOverscanMaskGrowSize	Grow the SAT mask in the parallel overscan region by this many pixels.
parallelOverscanMaskedColumnGrowSize	When a full column is masked in the parallel overscan (at less than saturation) the mask should be grown by this many pixels.
parallelOverscanSaturationLevel	The saturation level (adu) to use if not specified in call to maskParallelOverscanAmp.
parallelOverscanSaturationLevelAdjustmentFactor	The parallel overscan saturation level may be below that of the data region.
trailingToSkip	Number of trailing values to skip in parallel overscan correction.

Methods Summary

setDefaults()

Subclass hook for computing defaults.

Attributes Documentation

doAbsoluteMaxDeviation

Apply the maxDeviation to the absolute value of the deviation? If False, this will be a one-sided cut for positive-only deviations (typically for parallel overscan subtraction. (bool, default True)

doMedianSmoothingOutlierRejection

Do column-by-column median smoothing outlier rejection? Columns that are rejected in this way will be grown by parallelOverscanMaskedColumnGrowSize. (bool, default True)

doParallelOverscanSaturation

Mask saturated pixels in parallel overscan region? (bool, default True)

fitType

The method for fitting the overscan bias level. (str, default 'MEDIAN')

Allowed values:

'POLY'

Fit ordinary polynomial to the longest axis of the overscan region

'CHEB'

Fit Chebyshev polynomial to the longest axis of the overscan region

'LEG'

Fit Legendre polynomial to the longest axis of the overscan region

'NATURAL_SPLINE'

Fit natural spline to the longest axis of the overscan region

'CUBIC_SPLINE'

Fit cubic spline to the longest axis of the overscan region

'AKIMA_SPLINE'

Fit Akima spline to the longest axis of the overscan region

'MEAN'

Correct using the mean of the overscan region

'MEANCLIP'

Correct using a clipped mean of the overscan region

'MEDIAN'

Correct using the median of the overscan region

'MEDIAN_PER_ROW'

Correct using the median per row of the overscan region

'MEAN_PER_ROW'

Correct using the mean per row of the overscan region

'None'

Field is optional

leadingToSkip

Number of leading values to skip in parallel overscan correction. (int, default 0)

maskPlanes

Mask planes to reject when measuring overscan (List, default ['BAD', 'SAT'])

maxDeviation

Maximum deviation from median (in ADU) to mask in overscan correction; Will be applied to the absolute deviation if doAbsoluteMaxDeviation=True. (float, default 1000.0)

medianSmoothingKernel

Kernel (pixels) to use to smooth the parallel overscan columns. Must be odd. (int, default 5)

medianSmoothingOutlierThreshold

Outlier threshold after parallel median smoothing (adu). This is applied only to positive outliers. (float, default 5.0)

numSigmaClip

Rejection threshold (sigma) for collapsing overscan before fit (float, default 3.0)

order

Order of polynomial to fit if overscan fit type is a polynomial, or number of spline knots if overscan fit type is a spline. (int, default 1)

overscanIsInt

Treat overscan as an integer image for purposes of fitType=MEDIAN and fitType=MEDIAN_PER_ROW. (bool, default True)

parallelOverscanFraction

When the parallel overscan region median is greater than parallelOverscanFraction and the imaging region median is greater than parallelOverscanImageThreshold then parallel overscan subtraction will be turned off, as this is usually due to the region being flooded with spillover from a super-saturated flat. (float, default 0.5)

parallelOverscanImageThreshold

When the parallel overscan region median is greater than parallelOverscanFraction and the imaging region median is greater than parallelOverscanImageThreshold then parallel overscan subtraction will be turned off, as this is usually due to the region being flooded with spillover from a super-saturated flat. (float, default 10000.0)

parallelOverscanMaskGrowSize

Grow the SAT mask in the parallel overscan region by this many pixels. This value was determined from the ITL chip in the LATISS camera. (int, default 7)

parallelOverscanMaskedColumnGrowSize

When a full column is masked in the parallel overscan (at less than saturation) the mask should be grown by this many pixels. This value is determined from ITL chips in LATISS and LSSTCam. (int, default 2)

parallelOverscanSaturationLevel

The saturation level (adu) to use if not specified in call to maskParallelOverscanAmp. This should be low enough to capture all possible amplifiers for defect detection. (float, default 20000.0)

parallelOverscanSaturationLevelAdjustmentFactor

The parallel overscan saturation level may be below that of the data region. This factor is applied to the amplifier saturation value when evaluating saturation in the parallel overscan region. (float, default 0.75)

trailingToSkip

Number of trailing values to skip in parallel overscan correction. (int, default 0)

Methods Documentation

setDefaults()

Subclass hook for computing defaults.

Notes

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.