lsst.cp.pipe  16.0-6-g7235603+4
Static Public Attributes | List of all members
lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig Class Reference
Inheritance diagram for lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig:

Static Public Attributes

 isr
 
 isrMandatorySteps
 
 isrForbiddenSteps
 
 isrDesirableSteps
 
 doCalcGains
 
 ccdKey
 
 maxIterRegression
 
 nSigmaClipGainCalc
 
 nSigmaClipRegression
 
 xcorrCheckRejectLevel
 
 maxIterSuccessiveOverRelaxation
 
 eLevelSuccessiveOverRelaxation
 
 nSigmaClipKernelGen
 
 nSigmaClipXCorr
 
 maxLag
 
 nPixBorderGainCalc
 
 nPixBorderXCorr
 
 biasCorr
 
 backgroundBinSize
 
 fixPtcThroughOrigin
 
 level
 
 backgroundWarnLevel
 

Detailed Description

Config class for bright-fatter effect coefficient calculation.

Definition at line 45 of file makeBrighterFatterKernel.py.

Member Data Documentation

◆ 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 142 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 161 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 calulate appropriate values",
default=0.9241
)

Definition at line 136 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 74 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 69 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 105 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 147 of file makeBrighterFatterKernel.py.

◆ isr

lsst.cp.pipe.makeBrighterFatterKernel.MakeBrighterFatterKernelTaskConfig.isr
static
Initial value:
= pexConfig.ConfigurableField(
target=IsrTask,
doc=,
)

Definition at line 48 of file makeBrighterFatterKernel.py.

◆ 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 63 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', 'doAddDistortionModel', 'doBrighterFatter', 'doUseOpticsTransmission',
'doUseFilterTransmission', 'doUseSensorTransmission', 'doUseAtmosphereTransmission']
)

Definition at line 57 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 52 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 153 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=10
)

Definition at line 79 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 100 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 121 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 126 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 131 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 84 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 110 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=3
)

Definition at line 89 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 116 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 94 of file makeBrighterFatterKernel.py.


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