lsst.ip.isr  21.0.0-6-g4e60332+d0a7993a18
Public Member Functions | Static Public Attributes | List of all members
lsst.ip.isr.crosstalk.CrosstalkTask Class Reference
Inheritance diagram for lsst.ip.isr.crosstalk.CrosstalkTask:
lsst.ip.isr.crosstalk.NullCrosstalkTask

Public Member Functions

def prepCrosstalk (self, dataRef, crosstalk=None)
 
def run (self, exposure, crosstalk=None, crosstalkSources=None, isTrimmed=False)
 

Static Public Attributes

 ConfigClass = CrosstalkConfig
 

Detailed Description

Apply intra-detector crosstalk correction.

Definition at line 653 of file crosstalk.py.

Member Function Documentation

◆ prepCrosstalk()

def lsst.ip.isr.crosstalk.CrosstalkTask.prepCrosstalk (   self,
  dataRef,
  crosstalk = None 
)
Placeholder for crosstalk preparation method, e.g., for inter-detector crosstalk.

Parameters
----------
dataRef : `daf.persistence.butlerSubset.ButlerDataRef`
    Butler reference of the detector data to be processed.
crosstalk : `~lsst.ip.isr.CrosstalkConfig`
    Crosstalk calibration that will be used.

See also
--------
lsst.obs.decam.crosstalk.DecamCrosstalkTask.prepCrosstalk

Definition at line 658 of file crosstalk.py.

◆ run()

def lsst.ip.isr.crosstalk.CrosstalkTask.run (   self,
  exposure,
  crosstalk = None,
  crosstalkSources = None,
  isTrimmed = 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`
    The image is already trimmed.
    This should no longer be needed once DM-15409 is resolved.

Raises
------
RuntimeError
    Raised if called for a detector that does not have a
    crosstalk correction.

Definition at line 674 of file crosstalk.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 655 of file crosstalk.py.


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