BrighterFatterKernelSolveConfig#

class lsst.cp.pipe.BrighterFatterKernelSolveConfig(*args, **kw)#

Bases: PipelineTaskConfig

Attributes Summary

`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`correlationModelRadius`	Build a model of the correlation coefficients for radii larger than this value in pixels? (`int`, default `100`)
`correlationModelSlope`	Slope of the correlation model for radii larger than correlationModelRadius (`float`, default `-1.35`)
`correlationQuadraticFit`	Use a quadratic fit to find the correlations instead of simple averaging? (`bool`, default `False`)
`covModelFluxSample`	Flux level in electrons at which to sample the full covariancemodel if useCovModelSample=True.
`doCheckValidity`	Check the AMP kernels for basic validity criteria? Will set bfk.valid for each amp.
`eLevelSuccessiveOverRelaxation`	The target residual error for the successive over-relaxation method (`float`, default `5e-14`)
`forceZeroSum`	Force the correlation matrix to have zero sum by adjusting the (0,0) value?Defaults to true bsed on recommendation of Broughton et al. 2024.
`fractionK00ForKernelMax`	All kernel values must be less than value*abs(K_00) to be valid.
`ignoreAmpsForAveraging`	List of amp names to ignore when averaging the amplifier kernels into the detector kernel.
`level`	The level at which to calculate the brighter-fatter kernels (`str`, default `'AMP'`)
`maxIterSuccessiveOverRelaxation`	The maximum number of iterations allowed for the successive over-relaxation method (`int`, default `10000`)
`nSigmaClip`	Number of sigma to clip when calculating means for the cross-correlation (`float`, default `5`)
`nSigmaTolForValidEdge`	A valid kernel will have all pixels in a 3px picture frame (edges) be within +/- nSigmaTolForValidEdge of zero.
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.
`useAmatrix`	Use the PTC 'a' matrix (Astier et al. 2019 equation 20) instead of the average of measured covariances? (`bool`, default `False`).
`useBfkPtc`	Use a BFK ptc in a single pipeline? (`bool`, default `False`)
`useCovModelSample`	Use the covariance matrix sampled from the full covariance model (Astier et al. 2019 equation 20) instead of the average measured covariances? (`bool`, default `False`).
`xcorrCheckRejectLevel`	Rejection level for the sum of the input cross-correlations.

Attributes Documentation

connections: pexConfig.ConfigField#: Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

correlationModelRadius#: Build a model of the correlation coefficients for radii larger than this value in pixels? (int, default 100)

correlationModelSlope#: Slope of the correlation model for radii larger than correlationModelRadius (float, default -1.35)

correlationQuadraticFit#: Use a quadratic fit to find the correlations instead of simple averaging? (bool, default False)

covModelFluxSample#: Flux level in electrons at which to sample the full covariancemodel if useCovModelSample=True. The same level is applied to allamps if this parameter [dict] is passed as {‘ALL_AMPS’: value} (Dict, default {'ALL_AMPS': 25000.0})

doCheckValidity#: Check the AMP kernels for basic validity criteria? Will set bfk.valid for each amp. (bool, default True)

eLevelSuccessiveOverRelaxation#: The target residual error for the successive over-relaxation method (float, default 5e-14)

forceZeroSum#: Force the correlation matrix to have zero sum by adjusting the (0,0) value?Defaults to true bsed on recommendation of Broughton et al. 2024. (bool, default True)

fractionK00ForKernelMax#: All kernel values must be less than value*abs(K_00) to be valid. (float, default 0.025)

ignoreAmpsForAveraging#: List of amp names to ignore when averaging the amplifier kernels into the detector kernel. Only relevant for level = DETECTOR (List, default [])

level#

The level at which to calculate the brighter-fatter kernels (str, default 'AMP')

Allowed values:

'AMP': Every amplifier treated separately
'DETECTOR': One kernel per detector
'None': Field is optional

maxIterSuccessiveOverRelaxation#: The maximum number of iterations allowed for the successive over-relaxation method (int, default 10000)

nSigmaClip#: Number of sigma to clip when calculating means for the cross-correlation (float, default 5)

nSigmaTolForValidEdge#: A valid kernel will have all pixels in a 3px picture frame (edges) be within +/- nSigmaTolForValidEdge of zero. (float, default 5.0)

saveLogOutput#: Flag to enable/disable saving of log output for a task, enabled by default. (bool, default True)

useAmatrix#: Use the PTC ‘a’ matrix (Astier et al. 2019 equation 20) instead of the average of measured covariances? (bool, default False)

useBfkPtc#: Use a BFK ptc in a single pipeline? (bool, default False)

useCovModelSample#: Use the covariance matrix sampled from the full covariance model (Astier et al. 2019 equation 20) instead of the average measured covariances? (bool, default False)

xcorrCheckRejectLevel#: Rejection level for the sum of the input cross-correlations. Arrays which sum to greater than this are discarded before the clipped mean is calculated. (float, default 2.0)