lsst.cp.pipe  21.0.0-19-g0e82efe+d8cd6b0ac0
Public Member Functions | Static Public Attributes | List of all members
lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveTask Class Reference
Inheritance diagram for lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveTask:

Public Member Functions

def runQuantum (self, butlerQC, inputRefs, outputRefs)
 
def run (self, inputPtc, dummy, camera, inputDims)
 
def averageCorrelations (self, xCorrList, name)
 
def quadraticCorrelations (self, xCorrList, fluxList, name)
 
def successiveOverRelax (self, source, maxIter=None, eLevel=None)
 

Static Public Attributes

 ConfigClass = BrighterFatterKernelSolveConfig
 

Detailed Description

Measure appropriate Brighter-Fatter Kernel from the PTC dataset.

Definition at line 142 of file makeBrighterFatterKernel.py.

Member Function Documentation

◆ averageCorrelations()

def lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveTask.averageCorrelations (   self,
  xCorrList,
  name 
)
Average input correlations.

Parameters
----------
xCorrList : `list` [`numpy.array`]
    List of cross-correlations.
name : `str`
    Name for log messages.

Returns
-------
meanXcorr : `numpy.array`
    The averaged cross-correlation.

Definition at line 325 of file makeBrighterFatterKernel.py.

◆ quadraticCorrelations()

def lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveTask.quadraticCorrelations (   self,
  xCorrList,
  fluxList,
  name 
)
Measure a quadratic correlation model.

Parameters
----------
xCorrList : `list` [`numpy.array`]
    List of cross-correlations.
fluxList : `numpy.array`
    Associated list of fluxes.
name : `str`
    Name for log messages.

Returns
-------
meanXcorr : `numpy.array`
    The averaged cross-correlation.

Definition at line 354 of file makeBrighterFatterKernel.py.

◆ run()

def lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveTask.run (   self,
  inputPtc,
  dummy,
  camera,
  inputDims 
)
Combine covariance information from PTC into brighter-fatter kernels.

Parameters
----------
inputPtc : `lsst.ip.isr.PhotonTransferCurveDataset`
    PTC data containing per-amplifier covariance measurements.
dummy : `lsst.afw.image.Exposure
    The exposure used to select the appropriate PTC dataset.
camera : `lsst.afw.cameraGeom.Camera`
    Camera to use for camera geometry information.
inputDims : `lsst.daf.butler.DataCoordinate` or `dict`
    DataIds to use to populate the output calibration.

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

    ``outputBfk`` : `lsst.ip.isr.BrighterFatterKernel`
        Resulting Brighter-Fatter Kernel.

Definition at line 169 of file makeBrighterFatterKernel.py.

◆ runQuantum()

def lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveTask.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 149 of file makeBrighterFatterKernel.py.

◆ successiveOverRelax()

def lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveTask.successiveOverRelax (   self,
  source,
  maxIter = None,
  eLevel = None 
)
An implementation of the successive over relaxation (SOR) method.

A numerical method for solving a system of linear equations
with faster convergence than the Gauss-Seidel method.

Parameters:
-----------
source : `numpy.ndarray`
    The input array.
maxIter : `int`, optional
    Maximum number of iterations to attempt before aborting.
eLevel : `float`, optional
    The target error level at which we deem convergence to have
    occurred.

Returns:
--------
output : `numpy.ndarray`
    The solution.

Definition at line 430 of file makeBrighterFatterKernel.py.

Member Data Documentation

◆ ConfigClass

lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveTask.ConfigClass = BrighterFatterKernelSolveConfig
static

Definition at line 146 of file makeBrighterFatterKernel.py.


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