lsst.ip.isr gbf28802888+bf8a358e9b
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.ip.isr.crosstalk.CrosstalkConfig Class Reference
Inheritance diagram for lsst.ip.isr.crosstalk.CrosstalkConfig:

Public Member Functions

def getCrosstalk (self, detector=None)
 
def hasCrosstalk (self, detector=None)
 

Static Public Attributes

 minPixelToMask
 
 crosstalkMaskPlane
 
 crosstalkBackgroundMethod
 
 useConfigCoefficients
 
 crosstalkValues
 
 crosstalkShape
 

Detailed Description

Configuration for intra-detector crosstalk removal.

Definition at line 571 of file crosstalk.py.

Member Function Documentation

◆ getCrosstalk()

def 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 612 of file crosstalk.py.

◆ hasCrosstalk()

def 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 646 of file crosstalk.py.

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 583 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 578 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 606 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 598 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 573 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 593 of file crosstalk.py.


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