lsst.cp.pipe  21.0.0-12-gf4ce030+76814010d2
Public Member Functions | Static Public Attributes | List of all members
lsst.cp.pipe.measureCrosstalk.CrosstalkExtractTask Class Reference
Inheritance diagram for lsst.cp.pipe.measureCrosstalk.CrosstalkExtractTask:

Public Member Functions

def run (self, inputExp, sourceExps=[])
 
def debugView (self, stepname, exposure)
 
def debugPixels (self, stepname, pixelsIn, pixelsOut, sourceName, targetName)
 

Static Public Attributes

 ConfigClass = CrosstalkExtractConfig
 

Detailed Description

Task to measure pixel ratios to find crosstalk.

Definition at line 128 of file measureCrosstalk.py.

Member Function Documentation

◆ debugPixels()

def lsst.cp.pipe.measureCrosstalk.CrosstalkExtractTask.debugPixels (   self,
  stepname,
  pixelsIn,
  pixelsOut,
  sourceName,
  targetName 
)
Utility function to examine the CT ratio pixel values.

Parameters
----------
stepname : `str`
    State of processing to view.
pixelsIn : `np.ndarray`
    Pixel values from the potential crosstalk source.
pixelsOut : `np.ndarray`
    Pixel values from the potential crosstalk target.
sourceName : `str`
    Source amplifier name
targetName : `str`
    Target amplifier name

Definition at line 282 of file measureCrosstalk.py.

◆ debugView()

def lsst.cp.pipe.measureCrosstalk.CrosstalkExtractTask.debugView (   self,
  stepname,
  exposure 
)
Utility function to examine the image being processed.

Parameters
----------
stepname : `str`
    State of processing to view.
exposure : `lsst.afw.image.Exposure`
    Exposure to view.

Definition at line 260 of file measureCrosstalk.py.

◆ run()

def lsst.cp.pipe.measureCrosstalk.CrosstalkExtractTask.run (   self,
  inputExp,
  sourceExps = [] 
)
Measure pixel ratios between amplifiers in inputExp.

Extract crosstalk ratios between different amplifiers.

For pixels above ``config.threshold``, we calculate the ratio
between each background-subtracted target amp and the source
amp. We return a list of ratios for each pixel for each
target/source combination, as nested dictionary containing the
ratio.

Parameters
----------
inputExp : `lsst.afw.image.Exposure`
    Input exposure to measure pixel ratios on.
sourceExp : `list` [`lsst.afw.image.Exposure`], optional
    List of chips to use as sources to measure inter-chip
    crosstalk.

Returns
-------
results : `lsst.pipe.base.Struct`
    The results struct containing:

    ``outputRatios`` : `dict` [`dict` [`dict` [`dict` [`list`]]]]
         A catalog of ratio lists.  The dictionaries are
         indexed such that:
         outputRatios[targetChip][sourceChip][targetAmp][sourceAmp]
         contains the ratio list for that combination.
    ``outputFluxes`` : `dict` [`dict` [`list`]]
         A catalog of flux lists.  The dictionaries are
         indexed such that:
         outputFluxes[sourceChip][sourceAmp]
         contains the flux list used in the outputRatios.

Notes
-----
The lsstDebug.Info() method can be rewritten for __name__ =
`lsst.cp.pipe.measureCrosstalk`, and supports the parameters:

debug.display['extract'] : `bool`
    Display the exposure under consideration, with the pixels used
    for crosstalk measurement indicated by the DETECTED mask plane.
debug.display['pixels'] : `bool`
    Display a plot of the ratio calculated for each pixel used in this
    exposure, split by amplifier pairs.  The median value is listed
    for reference.

Definition at line 135 of file measureCrosstalk.py.

Member Data Documentation

◆ ConfigClass

lsst.cp.pipe.measureCrosstalk.CrosstalkExtractTask.ConfigClass = CrosstalkExtractConfig
static

Definition at line 132 of file measureCrosstalk.py.


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