Inheritance diagram for lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig:
Detailed Description
Config class for bright-fatter effect coefficient calculation.
Definition at line 53 of file makeBrighterFatterKernel.py.
Member Data Documentation
◆ backgroundBinSize
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Size of the background bins",
default=128
)
Definition at line 191 of file makeBrighterFatterKernel.py.
◆ 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 217 of file makeBrighterFatterKernel.py.
◆ 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 185 of file makeBrighterFatterKernel.py.
◆ 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 107 of file makeBrighterFatterKernel.py.
◆ 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 97 of file makeBrighterFatterKernel.py.
◆ 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 102 of file makeBrighterFatterKernel.py.
◆ 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 92 of file makeBrighterFatterKernel.py.
◆ 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 77 of file makeBrighterFatterKernel.py.
◆ 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 82 of file makeBrighterFatterKernel.py.
◆ 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 154 of file makeBrighterFatterKernel.py.
◆ 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 196 of file makeBrighterFatterKernel.py.
◆ 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 87 of file makeBrighterFatterKernel.py.
◆ 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 211 of file makeBrighterFatterKernel.py.
◆ isr
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=IsrTask,
doc=,
)
Definition at line 56 of file makeBrighterFatterKernel.py.
◆ 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 71 of file makeBrighterFatterKernel.py.
◆ 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 65 of file makeBrighterFatterKernel.py.
◆ 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 60 of file makeBrighterFatterKernel.py.
◆ 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 202 of file makeBrighterFatterKernel.py.
◆ maxIterRegression
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Maximum number of iterations for the regression fitter",
default=2
)
Definition at line 128 of file makeBrighterFatterKernel.py.
◆ 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 149 of file makeBrighterFatterKernel.py.
◆ 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 170 of file makeBrighterFatterKernel.py.
◆ 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 120 of file makeBrighterFatterKernel.py.
◆ 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 112 of file makeBrighterFatterKernel.py.
◆ 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 175 of file makeBrighterFatterKernel.py.
◆ 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 180 of file makeBrighterFatterKernel.py.
◆ 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 133 of file makeBrighterFatterKernel.py.
◆ 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 159 of file makeBrighterFatterKernel.py.
◆ 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 138 of file makeBrighterFatterKernel.py.
◆ 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 165 of file makeBrighterFatterKernel.py.
◆ 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 143 of file makeBrighterFatterKernel.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.4.3/Linux64/cp_pipe/22.0.1+ebe8d3385e/python/lsst/cp/pipe/makeBrighterFatterKernel.py
