BrighterFatterKernelSolveTask¶
BrighterFatterKernelSolveTask
inverts the covariance matrix from a photon transfer curve dataset to produce a brighterfatter kernel.
Processing summary¶
BrighterFatterKernelSolveTask
runs these operations:
Scale and normalize the covariance matrix.
Tile the covariance matrix to produce the crosscorrelation in all four quadrants.
Invert crosscorrelation through successive over relaxation process.
Optionally average the peramplifier kernels into a perdetector kernel.
Python API summary¶
from lsst.cp.pipe.makeBrighterFatterKernel import BrighterFatterKernelSolveTask

class
BrighterFatterKernelSolveTask
(*, config=None, log=None, initInputs=None, **kwargs) Measure appropriate BrighterFatter Kernel from the PTC dataset
...
 attributeconfig
Access configuration fields and retargetable subtasks.

method
run
(inputPtc, dummy, camera, inputDims) Combine covariance information from PTC into brighterfatter kernels
...
See also
See the BrighterFatterKernelSolveTask
API reference for complete details.
Retargetable subtasks¶
No subtasks.
Configuration fields¶
connections¶
 Data type
lsst.pipe.base.config.BrighterFatterKernelSolveConfigConnections
 Field type
Configurations describing the connections of the PipelineTask to datatypes
correlationModelRadius¶
Build a model of the correlation coefficients for radii larger than this value in pixels?
correlationModelSlope¶
Slope of the correlation model for radii larger than correlationModelRadius
correlationQuadraticFit¶
Use a quadratic fit to find the correlations instead of simple averaging?
eLevelSuccessiveOverRelaxation¶
The target residual error for the successive overrelaxation method
forceZeroSum¶
Force the correlation matrix to have zero sum by adjusting the (0,0) value?
ignoreAmpsForAveraging¶
List of amp names to ignore when averaging the amplifier kernels into the detector kernel. Only relevant for level = DETECTOR
level¶
 Default
'AMP'
 Field type
str
ChoiceField
(optional) Choices
'AMP'
Every amplifier treated separately
'DETECTOR'
One kernel per detector
None
Field is optional
The level at which to calculate the brighterfatter kernels
maxIterSuccessiveOverRelaxation¶
The maximum number of iterations allowed for the successive overrelaxation method
nSigmaClip¶
Number of sigma to clip when calculating means for the crosscorrelation
saveLogOutput¶
Flag to enable/disable saving of log output for a task, enabled by default.
saveMetadata¶
Flag to enable/disable metadata saving for a task, enabled by default. Deprecated: This field is deprecated and will be removed after v26.
useAmatrix¶
Use the PTC ‘a’ matrix (Astier et al. 2019 equation 20) instead of the average of measured covariances?
xcorrCheckRejectLevel¶
Rejection level for the sum of the input crosscorrelations. Arrays which sum to greater than this are discarded before the clipped mean is calculated.