Config class for bright-fatter effect coefficient calculation.
Definition at line 52 of file makeBrighterFatterKernel.py.
◆ backgroundBinSize
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.backgroundBinSize |
|
static |
Initial value:= pexConfig.Field(
dtype=int,
doc="Size of the background bins",
default=128
)
Definition at line 190 of file makeBrighterFatterKernel.py.
◆ backgroundWarnLevel
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.backgroundWarnLevel |
|
static |
Initial value:= pexConfig.Field(
dtype=float,
doc="Log warnings if the mean of the fitted background is found to be above this level after " +
"differencing image pair.",
default=0.1
)
Definition at line 216 of file makeBrighterFatterKernel.py.
◆ biasCorr
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.biasCorr |
|
static |
Initial value:= pexConfig.Field(
dtype=float,
doc="An empirically determined correction factor, used to correct for the sigma-clipping of" +
" a non-Gaussian distribution. Post DM-15277, code will exist here to calculate appropriate values",
default=0.9241
)
Definition at line 184 of file makeBrighterFatterKernel.py.
◆ ccdKey
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.ccdKey |
|
static |
Initial value:= pexConfig.Field(
dtype=str,
doc="The key by which to pull a detector from a dataId, e.g. 'ccd' or 'detector'",
default='ccd',
)
Definition at line 106 of file makeBrighterFatterKernel.py.
◆ correlationModelRadius
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.correlationModelRadius |
|
static |
Initial value:= pexConfig.Field(
dtype=int,
doc="Build a model of the correlation coefficients for radii larger than this value in pixels?",
default=100,
)
Definition at line 96 of file makeBrighterFatterKernel.py.
◆ correlationModelSlope
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.correlationModelSlope |
|
static |
Initial value:= pexConfig.Field(
dtype=float,
doc="Slope of the correlation model for radii larger than correlationModelRadius",
default=-1.35,
)
Definition at line 101 of file makeBrighterFatterKernel.py.
◆ correlationQuadraticFit
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.correlationQuadraticFit |
|
static |
Initial value:= pexConfig.Field(
dtype=bool,
doc="Use a quadratic fit to find the correlations instead of simple averaging?",
default=False,
)
Definition at line 91 of file makeBrighterFatterKernel.py.
◆ doCalcGains
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.doCalcGains |
|
static |
Initial value:= pexConfig.Field(
dtype=bool,
doc="Measure the per-amplifier gains (using the photon transfer curve method)?",
default=True,
)
Definition at line 76 of file makeBrighterFatterKernel.py.
◆ doPlotPtcs
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.doPlotPtcs |
|
static |
Initial value:= pexConfig.Field(
dtype=bool,
doc="Plot the PTCs and butler.put() them as defined by the plotBrighterFatterPtc template",
default=False,
)
Definition at line 81 of file makeBrighterFatterKernel.py.
◆ eLevelSuccessiveOverRelaxation
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.eLevelSuccessiveOverRelaxation |
|
static |
Initial value:= pexConfig.Field(
dtype=float,
doc="The target residual error for the successive over-relaxation method",
default=5.0e-14
)
Definition at line 153 of file makeBrighterFatterKernel.py.
◆ fixPtcThroughOrigin
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.fixPtcThroughOrigin |
|
static |
Initial value:= pexConfig.Field(
dtype=bool,
doc="Constrain the fit of the photon transfer curve to go through the origin when measuring" +
"the gain?",
default=True
)
Definition at line 195 of file makeBrighterFatterKernel.py.
◆ forceZeroSum
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.forceZeroSum |
|
static |
Initial value:= pexConfig.Field(
dtype=bool,
doc="Force the correlation matrix to have zero sum by adjusting the (0,0) value?",
default=False,
)
Definition at line 86 of file makeBrighterFatterKernel.py.
◆ ignoreAmpsForAveraging
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.ignoreAmpsForAveraging |
|
static |
Initial value:= pexConfig.ListField(
dtype=str,
doc="List of amp names to ignore when averaging the amplifier kernels into the detector" +
" kernel. Only relevant for level = AMP",
default=[]
)
Definition at line 210 of file makeBrighterFatterKernel.py.
◆ isr
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.isr |
|
static |
◆ isrDesirableSteps
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.isrDesirableSteps |
|
static |
Initial value:= pexConfig.ListField(
dtype=str,
doc="isr operations that it is advisable to perform, but are not mission-critical." +
" WARNs are logged for any of these found to be False.",
default=['doBias', 'doDark', 'doCrosstalk', 'doDefect', 'doLinearize']
)
Definition at line 70 of file makeBrighterFatterKernel.py.
◆ isrForbiddenSteps
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.isrForbiddenSteps |
|
static |
Initial value:= pexConfig.ListField(
dtype=str,
doc="isr operations that must NOT be performed for valid results. Raises if any of these are True",
default=['doFlat', 'doFringe', 'doBrighterFatter', 'doUseOpticsTransmission',
'doUseFilterTransmission', 'doUseSensorTransmission', 'doUseAtmosphereTransmission']
)
Definition at line 64 of file makeBrighterFatterKernel.py.
◆ isrMandatorySteps
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.isrMandatorySteps |
|
static |
Initial value:= pexConfig.ListField(
dtype=str,
doc="isr operations that must be performed for valid results. Raises if any of these are False",
default=['doAssembleCcd']
)
Definition at line 59 of file makeBrighterFatterKernel.py.
◆ level
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.level |
|
static |
Initial value:= pexConfig.ChoiceField(
doc="The level at which to calculate the brighter-fatter kernels",
dtype=str,
default="DETECTOR",
allowed={
"AMP": "Every amplifier treated separately",
"DETECTOR": "One kernel per detector",
}
)
Definition at line 201 of file makeBrighterFatterKernel.py.
◆ maxIterRegression
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.maxIterRegression |
|
static |
Initial value:= pexConfig.Field(
dtype=int,
doc="Maximum number of iterations for the regression fitter",
default=2
)
Definition at line 127 of file makeBrighterFatterKernel.py.
◆ maxIterSuccessiveOverRelaxation
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.maxIterSuccessiveOverRelaxation |
|
static |
Initial value:= pexConfig.Field(
dtype=int,
doc="The maximum number of iterations allowed for the successive over-relaxation method",
default=10000
)
Definition at line 148 of file makeBrighterFatterKernel.py.
◆ maxLag
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.maxLag |
|
static |
Initial value:= pexConfig.Field(
dtype=int,
doc="The maximum lag (in pixels) to use when calculating the cross-correlation/kernel",
default=8
)
Definition at line 169 of file makeBrighterFatterKernel.py.
◆ maxMeanSignal
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.maxMeanSignal |
|
static |
Initial value:= pexConfig.DictField(
keytype=str,
itemtype=float,
doc="Maximum values (inclusive) of mean signal (in ADU) below which to consider, per amp."
" The same cut is applied to all amps if this dictionary is of the form"
" {'ALL_AMPS': value}",
default={'ALL_AMPS': 1e6},
)
Definition at line 119 of file makeBrighterFatterKernel.py.
◆ minMeanSignal
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.minMeanSignal |
|
static |
Initial value:= pexConfig.DictField(
keytype=str,
itemtype=float,
doc="Minimum values (inclusive) of mean signal (in ADU) above which to consider, per amp."
" The same cut is applied to all amps if this dictionary is of the form"
" {'ALL_AMPS': value}",
default={'ALL_AMPS': 0.0},
)
Definition at line 111 of file makeBrighterFatterKernel.py.
◆ nPixBorderGainCalc
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.nPixBorderGainCalc |
|
static |
Initial value:= pexConfig.Field(
dtype=int,
doc="The number of border pixels to exclude when calculating the gain",
default=10
)
Definition at line 174 of file makeBrighterFatterKernel.py.
◆ nPixBorderXCorr
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.nPixBorderXCorr |
|
static |
Initial value:= pexConfig.Field(
dtype=int,
doc="The number of border pixels to exclude when calculating the cross-correlation and kernel",
default=10
)
Definition at line 179 of file makeBrighterFatterKernel.py.
◆ nSigmaClipGainCalc
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.nSigmaClipGainCalc |
|
static |
Initial value:= pexConfig.Field(
dtype=int,
doc="Number of sigma to clip the pixel value distribution to during gain calculation",
default=5
)
Definition at line 132 of file makeBrighterFatterKernel.py.
◆ nSigmaClipKernelGen
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.nSigmaClipKernelGen |
|
static |
Initial value:= pexConfig.Field(
dtype=float,
doc="Number of sigma to clip to during pixel-wise clipping when generating the kernel. See " +
"the generateKernel docstring for more info.",
default=4
)
Definition at line 158 of file makeBrighterFatterKernel.py.
◆ nSigmaClipRegression
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.nSigmaClipRegression |
|
static |
Initial value:= pexConfig.Field(
dtype=int,
doc="Number of sigma to clip outliers from the line of best fit to during iterative regression",
default=4
)
Definition at line 137 of file makeBrighterFatterKernel.py.
◆ nSigmaClipXCorr
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.nSigmaClipXCorr |
|
static |
Initial value:= pexConfig.Field(
dtype=float,
doc="Number of sigma to clip when calculating means for the cross-correlation",
default=5
)
Definition at line 164 of file makeBrighterFatterKernel.py.
◆ xcorrCheckRejectLevel
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.xcorrCheckRejectLevel |
|
static |
Initial value:= pexConfig.Field(
dtype=float,
doc="Sanity check level for the sum of the input cross-correlations. Arrays which " +
"sum to greater than this are discarded before the clipped mean is calculated.",
default=2.0
)
Definition at line 142 of file makeBrighterFatterKernel.py.
The documentation for this class was generated from the following file: