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

Public Member Functions
def	prepCrosstalk (self, dataRef, crosstalk=None)

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

Static Public Attributes
	ConfigClass = CrosstalkConfig

Detailed Description

Apply intra-detector crosstalk correction.

Definition at line 659 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

Reimplemented in lsst.obs.decam.crosstalk.DecamCrosstalkTask.

Definition at line 664 of file crosstalk.py.

     def 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
         """
         return
  

◆ run()

def lsst.ip.isr.crosstalk.CrosstalkTask.run	(	self,
		exposure,
		crosstalk = `None`,
		crosstalkSources = `None`,
		isTrimmed = `False`,
		camera = `None`
	)

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
    The image is already trimmed.
    This should no longer be needed once DM-15409 is resolved.
camera : `lsst.afw.cameraGeom.Camera`, optional
    Camera associated with this exposure.  Only used for
    inter-chip matching.

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.

Definition at line 680 of file crosstalk.py.

             crosstalkSources=None, isTrimmed=False, camera=None):
         """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
             The image is already trimmed.
             This should no longer be needed once DM-15409 is resolved.
         camera : `lsst.afw.cameraGeom.Camera`, optional
             Camera associated with this exposure.  Only used for
             inter-chip matching.
  
         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.
         """
         if not crosstalk:
             crosstalk = CrosstalkCalib(log=self.log)
             crosstalk = crosstalk.fromDetector(exposure.getDetector(),
                                                coeffVector=self.config.crosstalkValues)
         if not crosstalk.log:
             crosstalk.log = self.log
         if not crosstalk.hasCrosstalk:
             raise RuntimeError("Attempted to correct crosstalk without crosstalk coefficients.")
  
         else:
             self.log.info("Applying crosstalk correction.")
             crosstalk.subtractCrosstalk(exposure, crosstalkCoeffs=crosstalk.coeffs,
                                         minPixelToMask=self.config.minPixelToMask,
                                         crosstalkStr=self.config.crosstalkMaskPlane, isTrimmed=isTrimmed,
                                         backgroundMethod=self.config.crosstalkBackgroundMethod)
  
             if crosstalk.interChip:
                 if crosstalkSources:
                     # Parse crosstalkSources: Identify which detectors we have available
                     if isinstance(crosstalkSources[0], lsst.afw.image.Exposure):
                         # Received afwImage.Exposure
                         sourceNames = [exp.getDetector().getName() for exp in crosstalkSources]
                     elif isinstance(crosstalkSources[0], lsst.daf.butler.DeferredDatasetHandle):
                         # Received dafButler.DeferredDatasetHandle
                         detectorList = [source.dataId['detector'] for source in crosstalkSources]
                         sourceNames = [camera[detector].getName() for detector in detectorList]
                     else:
                         raise RuntimeError("Unknown object passed as crosstalk sources.",
                                            type(crosstalkSources[0]))
  
                     for detName in crosstalk.interChip:
                         if detName not in sourceNames:
                             self.log.warning("Crosstalk lists %s, not found in sources: %s",
                                              detName, sourceNames)
                             continue
                         # Get the coefficients.
                         interChipCoeffs = crosstalk.interChip[detName]
  
                         sourceExposure = crosstalkSources[sourceNames.index(detName)]
                         if isinstance(sourceExposure, lsst.daf.butler.DeferredDatasetHandle):
                             # Dereference the dafButler.DeferredDatasetHandle.
                             sourceExposure = sourceExposure.get()
                         if not isinstance(sourceExposure, lsst.afw.image.Exposure):
                             raise RuntimeError("Unknown object passed as crosstalk sources.",
                                                type(sourceExposure))
  
                         self.log.info("Correcting detector %s with ctSource %s",
                                       exposure.getDetector().getName(),
                                       sourceExposure.getDetector().getName())
                         crosstalk.subtractCrosstalk(exposure, sourceExposure=sourceExposure,
                                                     crosstalkCoeffs=interChipCoeffs,
                                                     minPixelToMask=self.config.minPixelToMask,
                                                     crosstalkStr=self.config.crosstalkMaskPlane,
                                                     isTrimmed=isTrimmed,
                                                     backgroundMethod=self.config.crosstalkBackgroundMethod)
                 else:
                     self.log.warning("Crosstalk contains interChip coefficients, but no sources found!")
  
  

Member Data Documentation

◆ ConfigClass

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

static

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-0.7.0/Linux64/ip_isr/22.0.1-27-g97737f7+2a20fdde0d/python/lsst/ip/isr/crosstalk.py