LSST Applications  21.0.0-131-g8cabc107+528f53ee53,22.0.0+00495a2688,22.0.0+0ef2527977,22.0.0+11a2aa21cd,22.0.0+269b7e55e3,22.0.0+2c6b6677a3,22.0.0+64c1bc5aa5,22.0.0+7b3a3f865e,22.0.0+e1b6d2281c,22.0.0+ff3c34362c,22.0.1-1-g1b65d06+c95cbdf3df,22.0.1-1-g7058be7+1cf78af69b,22.0.1-1-g7dab645+2a65e40b06,22.0.1-1-g8760c09+64c1bc5aa5,22.0.1-1-g949febb+64c1bc5aa5,22.0.1-1-ga324b9c+269b7e55e3,22.0.1-1-gf9d8b05+ff3c34362c,22.0.1-10-g781e53d+9b51d1cd24,22.0.1-10-gba590ab+b9624b875d,22.0.1-13-g76f9b8d+2c6b6677a3,22.0.1-14-g22236948+57af756299,22.0.1-18-g3db9cf4b+9b7092c56c,22.0.1-18-gb17765a+2264247a6b,22.0.1-2-g8ef0a89+2c6b6677a3,22.0.1-2-gcb770ba+c99495d3c6,22.0.1-24-g2e899d296+4206820b0d,22.0.1-3-g7aa11f2+2c6b6677a3,22.0.1-3-g8c1d971+f253ffa91f,22.0.1-3-g997b569+ff3b2f8649,22.0.1-4-g1930a60+6871d0c7f6,22.0.1-4-g5b7b756+6b209d634c,22.0.1-6-ga02864e+6871d0c7f6,22.0.1-7-g3402376+a1a2182ac4,22.0.1-7-g65f59fa+54b92689ce,master-gcc5351303a+e1b6d2281c,w.2021.32
LSST Data Management Base Package
Static Public Attributes | List of all members
lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveConfig Class Reference
Inheritance diagram for lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveConfig:
lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveConnections

Static Public Attributes

 level
 
 ignoreAmpsForAveraging
 
 xcorrCheckRejectLevel
 
 nSigmaClip
 
 forceZeroSum
 
 useAmatrix
 
 maxIterSuccessiveOverRelaxation
 
 eLevelSuccessiveOverRelaxation
 
 correlationQuadraticFit
 
 correlationModelRadius
 
 correlationModelSlope
 
 dummy
 
 camera
 
 inputPtc
 
 outputBFK
 

Detailed Description

Definition at line 74 of file makeBrighterFatterKernel.py.

Member Data Documentation

◆ camera

lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveConnections.camera
staticinherited
Initial value:
= cT.PrerequisiteInput(
name="camera",
doc="Camera associated with this data.",
storageClass="Camera",
dimensions=("instrument", ),
isCalibration=True,
lookupFunction=lookupStaticCalibration,
)

Definition at line 49 of file makeBrighterFatterKernel.py.

◆ correlationModelRadius

lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveConfig.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 130 of file makeBrighterFatterKernel.py.

◆ correlationModelSlope

lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveConfig.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 135 of file makeBrighterFatterKernel.py.

◆ correlationQuadraticFit

lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveConfig.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 125 of file makeBrighterFatterKernel.py.

◆ dummy

lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveConnections.dummy
staticinherited
Initial value:
= cT.Input(
name="raw",
doc="Dummy exposure.",
storageClass='Exposure',
dimensions=("instrument", "exposure", "detector"),
multiple=True,
deferLoad=True,
)

Definition at line 41 of file makeBrighterFatterKernel.py.

◆ eLevelSuccessiveOverRelaxation

lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveConfig.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 119 of file makeBrighterFatterKernel.py.

◆ forceZeroSum

lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveConfig.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 102 of file makeBrighterFatterKernel.py.

◆ ignoreAmpsForAveraging

lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveConfig.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 = DETECTOR",
default=[]
)

Definition at line 85 of file makeBrighterFatterKernel.py.

◆ inputPtc

lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveConnections.inputPtc
staticinherited
Initial value:
= cT.PrerequisiteInput(
name="ptc",
doc="Photon transfer curve dataset.",
storageClass="PhotonTransferCurveDataset",
dimensions=("instrument", "detector"),
isCalibration=True,
)

Definition at line 57 of file makeBrighterFatterKernel.py.

◆ level

lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveConfig.level
static
Initial value:
= pexConfig.ChoiceField(
doc="The level at which to calculate the brighter-fatter kernels",
dtype=str,
default="AMP",
allowed={
"AMP": "Every amplifier treated separately",
"DETECTOR": "One kernel per detector",
}
)

Definition at line 76 of file makeBrighterFatterKernel.py.

◆ maxIterSuccessiveOverRelaxation

lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveConfig.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 114 of file makeBrighterFatterKernel.py.

◆ nSigmaClip

lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveConfig.nSigmaClip
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 97 of file makeBrighterFatterKernel.py.

◆ outputBFK

lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveConnections.outputBFK
staticinherited
Initial value:
= cT.Output(
name="brighterFatterKernel",
doc="Output measured brighter-fatter kernel.",
storageClass="BrighterFatterKernel",
dimensions=("instrument", "detector"),
isCalibration=True,
)

Definition at line 65 of file makeBrighterFatterKernel.py.

◆ useAmatrix

lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveConfig.useAmatrix
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Use the PTC 'a' matrix (Astier et al. 2019 equation 20) "
"instead of the average of measured covariances?",
default=False,
)

Definition at line 107 of file makeBrighterFatterKernel.py.

◆ xcorrCheckRejectLevel

lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterKernelSolveConfig.xcorrCheckRejectLevel
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="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.",
default=2.0
)

Definition at line 91 of file makeBrighterFatterKernel.py.


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