lsst.cp.pipe  21.0.0-4-g42917e2+7988b1f7d3
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
lsst.cp.pipe.measureCrosstalk.CrosstalkSolveTask Class Reference
Inheritance diagram for lsst.cp.pipe.measureCrosstalk.CrosstalkSolveTask:

Public Member Functions

def runQuantum (self, butlerQC, inputRefs, outputRefs)
 
def run (self, inputRatios, inputFluxes=None, camera=None, inputDims=None, outputDims=None)
 
def measureCrosstalkCoefficients (self, ratios, rejIter, rejSigma)
 
def debugRatios (self, stepname, ratios, i, j, coeff=0.0, valid=False)
 

Static Public Member Functions

def sigmaClipCorrection (nSigClip)
 
def filterCrosstalkCalib (inCalib)
 

Static Public Attributes

 ConfigClass = CrosstalkSolveConfig
 

Detailed Description

Task to solve crosstalk from pixel ratios.

Definition at line 387 of file measureCrosstalk.py.

Member Function Documentation

◆ debugRatios()

def lsst.cp.pipe.measureCrosstalk.CrosstalkSolveTask.debugRatios (   self,
  stepname,
  ratios,
  i,
  j,
  coeff = 0.0,
  valid = False 
)
Utility function to examine the final CT ratio set.

Parameters
----------
stepname : `str`
    State of processing to view.
ratios : `dict` of `dict` of `np.ndarray`
    Array of measured CT ratios, indexed by source/victim
    amplifier.
i : `str`
    Index of the source amplifier.
j : `str`
    Index of the target amplifier.
coeff : `float`, optional
    Coefficient calculated to plot along with the simple mean.
valid : `bool`, optional
    Validity to be added to the plot title.

Definition at line 676 of file measureCrosstalk.py.

◆ filterCrosstalkCalib()

def lsst.cp.pipe.measureCrosstalk.CrosstalkSolveTask.filterCrosstalkCalib (   inCalib)
static
Apply valid constraints to the measured values.

Any measured coefficient that is determined to be invalid is
set to zero, and has the error set to nan.  The validation is
determined by checking that the measured coefficient is larger
than the calculated standard error of the mean.

Parameters
----------
inCalib : `lsst.ip.isr.CrosstalkCalib`
    Input calibration to filter.

Returns
-------
outCalib : `lsst.ip.isr.CrosstalkCalib`
     Filtered calibration.

Definition at line 644 of file measureCrosstalk.py.

◆ measureCrosstalkCoefficients()

def lsst.cp.pipe.measureCrosstalk.CrosstalkSolveTask.measureCrosstalkCoefficients (   self,
  ratios,
  rejIter,
  rejSigma 
)
Measure crosstalk coefficients from the ratios.

Given a list of ratios for each target/source amp combination,
we measure a sigma clipped mean and error.

The coefficient errors returned are the standard deviation of
the final set of clipped input ratios.

Parameters
----------
ratios : `dict` of `dict` of `numpy.ndarray`
   Catalog of arrays of ratios.
rejIter : `int`
   Number of rejection iterations.
rejSigma : `float`
   Rejection threshold (sigma).

Returns
-------
calib : `lsst.ip.isr.CrosstalkCalib`
    The output crosstalk calibration.

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

debug.display['measure'] : `bool`
    Display the CDF of the combined ratio measurements for
    a pair of source/target amplifiers from the final set of
    clipped input ratios.

Definition at line 540 of file measureCrosstalk.py.

◆ run()

def lsst.cp.pipe.measureCrosstalk.CrosstalkSolveTask.run (   self,
  inputRatios,
  inputFluxes = None,
  camera = None,
  inputDims = None,
  outputDims = None 
)
Combine ratios to produce crosstalk coefficients.

Parameters
----------
inputRatios : `list` [`dict` [`dict` [`dict` [`dict` [`list`]]]]]
    A list of nested dictionaries of ratios indexed by target
    and source chip, then by target and source amplifier.
inputFluxes : `list` [`dict` [`dict` [`list`]]]
    A list of nested dictionaries of source pixel fluxes, indexed
    by source chip and amplifier.
camera : `lsst.afw.cameraGeom.Camera`
    Input camera.
inputDims : `list` [`lsst.daf.butler.DataCoordinate`]
    DataIds to use to construct provenance.
outputDims : `list` [`lsst.daf.butler.DataCoordinate`]
    DataIds to use to populate the output calibration.

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

    ``outputCrosstalk`` : `lsst.ip.isr.CrosstalkCalib`
Final crosstalk calibration.
    ``outputProvenance`` : `lsst.ip.isr.IsrProvenance`
Provenance data for the new calibration.

Raises
------
RuntimeError
    Raised if the input data contains multiple target detectors.

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

debug.display['reduce'] : `bool`
    Display a histogram of the combined ratio measurements for
    a pair of source/target amplifiers from all input
    exposures/detectors.

Definition at line 415 of file measureCrosstalk.py.

◆ runQuantum()

def lsst.cp.pipe.measureCrosstalk.CrosstalkSolveTask.runQuantum (   self,
  butlerQC,
  inputRefs,
  outputRefs 
)
Ensure that the input and output dimensions are passed along.

Parameters
----------
butlerQC : `lsst.daf.butler.butlerQuantumContext.ButlerQuantumContext`
    Butler to operate on.
inputRefs : `lsst.pipe.base.connections.InputQuantizedConnection`
    Input data refs to load.
ouptutRefs : `lsst.pipe.base.connections.OutputQuantizedConnection`
    Output data refs to persist.

Definition at line 394 of file measureCrosstalk.py.

◆ sigmaClipCorrection()

def lsst.cp.pipe.measureCrosstalk.CrosstalkSolveTask.sigmaClipCorrection (   nSigClip)
static
Correct measured sigma to account for clipping.

If we clip our input data and then measure sigma, then the
measured sigma is smaller than the true value because real
points beyond the clip threshold have been removed.  This is a
small (1.5% at nSigClip=3) effect when nSigClip >~ 3, but the
default parameters for measure crosstalk use nSigClip=2.0.
This causes the measured sigma to be about 15% smaller than
real.  This formula corrects the issue, for the symmetric case
(upper clip threshold equal to lower clip threshold).

Parameters
----------
nSigClip : `float`
    Number of sigma the measurement was clipped by.

Returns
-------
scaleFactor : `float`
    Scale factor to increase the measured sigma by.

Definition at line 617 of file measureCrosstalk.py.

Member Data Documentation

◆ ConfigClass

lsst.cp.pipe.measureCrosstalk.CrosstalkSolveTask.ConfigClass = CrosstalkSolveConfig
static

Definition at line 391 of file measureCrosstalk.py.


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