lsst.ip.isr.crosstalk.CrosstalkConfig Class Reference

Inheritance diagram for lsst.ip.isr.crosstalk.CrosstalkConfig:

Public Member Functions
	getCrosstalk (self, detector=None)
	hasCrosstalk (self, detector=None)

Static Public Attributes
	minPixelToMask
	crosstalkMaskPlane
	crosstalkBackgroundMethod
	useConfigCoefficients
	crosstalkValues
	crosstalkShape

Detailed Description

Configuration for intra-detector crosstalk removal.

Definition at line 639 of file crosstalk.py.

Member Function Documentation

getCrosstalk()

lsst.ip.isr.crosstalk.CrosstalkConfig.getCrosstalk	(		self,
			detector = None )

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

Parameters
----------
detector : `lsst.afw.cameraGeom.detector`
    Detector that is to be crosstalk corrected.

Returns
-------
coeffs : `numpy.ndarray`
    Crosstalk coefficients that can be used to correct the detector.

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

Definition at line 680 of file crosstalk.py.

    def getCrosstalk(self, detector=None):
        """Return a 2-D numpy array of crosstalk coefficients in the proper
        shape.
 
        Parameters
        ----------
        detector : `lsst.afw.cameraGeom.detector`
            Detector that is to be crosstalk corrected.
 
        Returns
        -------
        coeffs : `numpy.ndarray`
            Crosstalk coefficients that can be used to correct the detector.
 
        Raises
        ------
        RuntimeError
            Raised if no coefficients could be generated from this
            detector/configuration.
        """
        if self.useConfigCoefficients is True:
            coeffs = np.array(self.crosstalkValues).reshape(self.crosstalkShape)
            if detector is not None:
                nAmp = len(detector)
                if coeffs.shape != (nAmp, nAmp):
                    raise RuntimeError("Constructed crosstalk coeffients do not match detector shape. "
                                       f"{coeffs.shape} {nAmp}")
            return coeffs
        elif detector is not None and detector.hasCrosstalk() is True:
            # Assume the detector defines itself consistently.
            return detector.getCrosstalk()
        else:
            raise RuntimeError("Attempted to correct crosstalk without crosstalk coefficients")
 

hasCrosstalk()

lsst.ip.isr.crosstalk.CrosstalkConfig.hasCrosstalk	(		self,
			detector = None )

Return a boolean indicating if crosstalk coefficients exist.

Parameters
----------
detector : `lsst.afw.cameraGeom.detector`
    Detector that is to be crosstalk corrected.

Returns
-------
hasCrosstalk : `bool`
    True if this detector/configuration has crosstalk coefficients
    defined.

Definition at line 714 of file crosstalk.py.

    def hasCrosstalk(self, detector=None):
        """Return a boolean indicating if crosstalk coefficients exist.
 
        Parameters
        ----------
        detector : `lsst.afw.cameraGeom.detector`
            Detector that is to be crosstalk corrected.
 
        Returns
        -------
        hasCrosstalk : `bool`
            True if this detector/configuration has crosstalk coefficients
            defined.
        """
        if self.useConfigCoefficients is True and self.crosstalkValues is not None:
            return True
        elif detector is not None and detector.hasCrosstalk() is True:
            return True
        else:
            return False
 
 

Member Data Documentation

crosstalkBackgroundMethod

lsst.ip.isr.crosstalk.CrosstalkConfig.crosstalkBackgroundMethod

static

Initial value:

=  ChoiceField(
        dtype=str,
        doc="Type of background subtraction to use when applying correction.",
        default="None",
        allowed={
            "None": "Do no background subtraction.",
            "AMP": "Subtract amplifier-by-amplifier background levels.",
            "DETECTOR": "Subtract detector level background."
        },
    )

Definition at line 651 of file crosstalk.py.

crosstalkMaskPlane

lsst.ip.isr.crosstalk.CrosstalkConfig.crosstalkMaskPlane

static

Initial value:

=  Field(
        dtype=str,
        doc="Name for crosstalk mask plane.",
        default="CROSSTALK"
    )

Definition at line 646 of file crosstalk.py.

crosstalkShape

lsst.ip.isr.crosstalk.CrosstalkConfig.crosstalkShape

static

Initial value:

=  ListField(
        dtype=int,
        doc="Shape of the coefficient array.  This should be equal to [nAmp, nAmp].",
        default=[1],
    )

Definition at line 674 of file crosstalk.py.

crosstalkValues

lsst.ip.isr.crosstalk.CrosstalkConfig.crosstalkValues

static

Initial value:

=  ListField(
        dtype=float,
        doc=("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."),
        default=[0.0],
    )

Definition at line 666 of file crosstalk.py.

minPixelToMask

lsst.ip.isr.crosstalk.CrosstalkConfig.minPixelToMask

static

Initial value:

=  Field(
        dtype=float,
        doc="Set crosstalk mask plane for pixels over this value.",
        default=45000
    )

Definition at line 641 of file crosstalk.py.

useConfigCoefficients

lsst.ip.isr.crosstalk.CrosstalkConfig.useConfigCoefficients

static

Initial value:

=  Field(
        dtype=bool,
        doc="Ignore the detector crosstalk information in favor of CrosstalkConfig values?",
        default=False,
    )

Definition at line 661 of file crosstalk.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/ip_isr/g02d81e74bb+21ad69e7e1/python/lsst/ip/isr/crosstalk.py