CrosstalkConfig

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

Bases: Config

Configuration for intra-detector crosstalk removal.

Attributes Summary

crosstalkBackgroundMethod	Type of background subtraction to use when applying correction.
crosstalkMaskPlane	Name for crosstalk mask plane.
crosstalkShape	Shape of the coefficient array.
crosstalkValues	Amplifier-indexed crosstalk coefficients to use.
doQuadraticCrosstalkCorrection	Use quadratic crosstalk coefficients in the crosstalk correction (bool, default False)
doSubtrahendMasking	Use subtrahend image thresholding instead of input image thesholding to set crosstalk mask? (bool, default False)
minPixelToMask	Set crosstalk mask plane for pixels over this value.
useConfigCoefficients	Ignore the detector crosstalk information in favor of CrosstalkConfig values? (bool, default False)

Methods Summary

getCrosstalk([detector])	Return a 2-D numpy array of crosstalk coefficients in the proper shape.
hasCrosstalk([detector])	Return a boolean indicating if crosstalk coefficients exist.

Attributes Documentation

crosstalkBackgroundMethod

Type of background subtraction to use when applying correction. (str, default 'None')

Allowed values:

'None'

Do no background subtraction.

'AMP'

Subtract amplifier-by-amplifier background levels.

'DETECTOR'

Subtract detector level background.

'None'

Field is optional

crosstalkMaskPlane

Name for crosstalk mask plane. (str, default 'CROSSTALK')

crosstalkShape

Shape of the coefficient array. This should be equal to [nAmp, nAmp]. (List, default [1])

crosstalkValues

Amplifier-indexed crosstalk coefficients to use. This should be arranged as a 1 x nAmp**2 list of coefficients, such that when reshaped by crosstalkShape, the result is nAmp x nAmp. This matrix should be structured so CT * [amp0 amp1 amp2 …]^T returns the column vector [corr0 corr1 corr2 …]^T. (List, default [0.0])

doQuadraticCrosstalkCorrection

Use quadratic crosstalk coefficients in the crosstalk correction (bool, default False)

doSubtrahendMasking

Use subtrahend image thresholding instead of input image thesholding to set crosstalk mask? (bool, default False)

minPixelToMask

Set crosstalk mask plane for pixels over this value. (float, default 45000)

useConfigCoefficients

Ignore the detector crosstalk information in favor of CrosstalkConfig values? (bool, default False)

Methods Documentation

getCrosstalk(detector=None)

Return a 2-D numpy array of crosstalk coefficients in the proper shape.

Parameters

detectorlsst.afw.cameraGeom.detector

Detector that is to be crosstalk corrected.

Returns

coeffsnumpy.ndarray

Crosstalk coefficients that can be used to correct the detector.

Raises

RuntimeError

Raised if no coefficients could be generated from this detector/configuration.

hasCrosstalk(detector=None)

Return a boolean indicating if crosstalk coefficients exist.

Parameters

detectorlsst.afw.cameraGeom.detector

Detector that is to be crosstalk corrected.

Returns

hasCrosstalkbool

True if this detector/configuration has crosstalk coefficients defined.