lsst.ip.isr gd2a69bfd97+d18973ec71
Loading...
Searching...
No Matches
lsst.ip.isr.crosstalk.CrosstalkTask Class Reference
Inheritance diagram for lsst.ip.isr.crosstalk.CrosstalkTask:
lsst.ip.isr.crosstalk.NullCrosstalkTask

Public Member Functions

 run (self, exposure, crosstalk=None, crosstalkSources=None, isTrimmed=None, camera=None, parallelOverscanRegion=None, detectorConfig=None, fullAmplifier=False, gains=None, badAmpDict=None, ignoreVariance=False)
 

Static Public Attributes

 ConfigClass = CrosstalkConfig
 

Static Protected Attributes

str _DefaultName = 'isrCrosstalk'
 

Detailed Description

Apply intra-detector crosstalk correction.

Definition at line 1006 of file crosstalk.py.

Member Function Documentation

◆ run()

lsst.ip.isr.crosstalk.CrosstalkTask.run ( self,
exposure,
crosstalk = None,
crosstalkSources = None,
isTrimmed = None,
camera = None,
parallelOverscanRegion = None,
detectorConfig = None,
fullAmplifier = False,
gains = None,
badAmpDict = None,
ignoreVariance = False )
Apply intra-detector crosstalk correction

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure for which to remove crosstalk.
crosstalkCalib : `lsst.ip.isr.CrosstalkCalib`, optional
    External crosstalk calibration to apply.  Constructed from
    detector if not found.
crosstalkSources : `defaultdict`, optional
    Image data for other detectors that are sources of
    crosstalk in exposure.  The keys are expected to be names
    of the other detectors, with the values containing
    `lsst.afw.image.Exposure` at the same level of processing
    as ``exposure``.
    The default for intra-detector crosstalk here is None.
isTrimmed : `bool`, optional
    This option has been deprecated and does not do anything.
    It will be removed after v29.
camera : `lsst.afw.cameraGeom.Camera`, optional
    Camera associated with this exposure.  Only used for
    inter-chip matching.
parallelOverscanRegion : `bool`, optional
    This option has been deprecated and will be removed after v29.
detectorConfig : `lsst.ip.isr.OverscanDetectorConfig`, optional
    This option has been deprecated and will be removed after v29.
fullAmplifier : `bool`, optional
    Use full amplifier and not just imaging region.
gains : `dict` [`str`, `float`], optional
    Dictionary of amp name to gain.  Required if there is a unit
    mismatch between the exposure and the crosstalk matrix.
badAmpDict : `dict` [`str`, `bool`], optional
    Dictionary to identify bad amplifiers that should not be
    source or target for crosstalk correction.
ignoreVariance : `bool`, optional
    Ignore variance plane when applying crosstalk?

Raises
------
RuntimeError
    Raised if called for a detector that does not have a
    crosstalk correction.  Also raised if the crosstalkSource
    is not an expected type.

Reimplemented in lsst.ip.isr.crosstalk.NullCrosstalkTask.

Definition at line 1011 of file crosstalk.py.

Member Data Documentation

◆ _DefaultName

str lsst.ip.isr.crosstalk.CrosstalkTask._DefaultName = 'isrCrosstalk'
staticprotected

Definition at line 1009 of file crosstalk.py.

◆ ConfigClass

lsst.ip.isr.crosstalk.CrosstalkTask.ConfigClass = CrosstalkConfig
static

Definition at line 1008 of file crosstalk.py.


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