lsst.ip.diffim.psfMatch.PsfMatchConfigDF Class Reference
Inheritance diagram for lsst.ip.diffim.psfMatch.PsfMatchConfigDF:
Public Member Functions | |
| setDefaults (self) | |
Detailed Description
The parameters specific to the delta-function (one basis per-pixel) Psf-matching basis
Definition at line 361 of file psfMatch.py.
Member Function Documentation
◆ setDefaults()
| lsst.ip.diffim.psfMatch.PsfMatchConfigDF.setDefaults | ( | self | ) |
Definition at line 364 of file psfMatch.py.
Member Data Documentation
◆ afwBackgroundConfig
|
staticinherited |
Initial value:
= pexConfig.ConfigField("Controlling the Afw background fitting",
SubtractBackgroundConfig)
Definition at line 59 of file psfMatch.py.
◆ badMaskPlanes
|
staticinherited |
Initial value:
= pexConfig.ListField(
dtype=str,
doc=,
default=("NO_DATA", "EDGE", "SAT")
)
Definition at line 206 of file psfMatch.py.
◆ calculateKernelUncertainty
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
doc=,
default=False,
)
Definition at line 283 of file psfMatch.py.
◆ candidateCoreRadius
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=int,
doc=,
default=3,
check=lambda x: x >= 1
)
Definition at line 234 of file psfMatch.py.
◆ candidateResidualMeanMax
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
doc=,
default=0.25,
check=lambda x: x >= 0.0
)
Definition at line 212 of file psfMatch.py.
◆ candidateResidualStdMax
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
doc=,
default=1.50,
check=lambda x: x >= 0.0
)
Definition at line 220 of file psfMatch.py.
◆ centralRegularizationStencil
|
static |
Initial value:
= pexConfig.ChoiceField(
dtype=int,
doc="Type of stencil to approximate central derivative (for centralDifference only)",
default=9,
allowed={
5: "5-point stencil including only adjacent-in-x,y elements",
9: "9-point stencil including diagonal elements"
}
)
Definition at line 386 of file psfMatch.py.
◆ checkConditionNumber
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
doc=,
default=False,
)
Definition at line 197 of file psfMatch.py.
◆ conditionNumberType
|
staticinherited |
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="Use singular values (SVD) or eigen values (EIGENVALUE) to determine condition number",
default="EIGENVALUE",
allowed={
"SVD": "Use singular values",
"EIGENVALUE": "Use eigen values (faster)",
}
)
Definition at line 256 of file psfMatch.py.
◆ constantVarianceWeighting
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
doc=,
default=True,
)
Definition at line 277 of file psfMatch.py.
◆ fitForBackground
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Include terms (including kernel cross terms) for background in ip_diffim",
default=False,
)
Definition at line 67 of file psfMatch.py.
◆ forwardRegularizationOrders
|
static |
Initial value:
= pexConfig.ListField(
dtype=int,
doc="Array showing which order derivatives to penalize (for forwardDifference only)",
default=(1, 2),
itemCheck=lambda x: (x > 0) and (x < 4)
)
Definition at line 395 of file psfMatch.py.
◆ iterateSingleKernel
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
doc=,
default=False,
)
Definition at line 271 of file psfMatch.py.
◆ kernelBasisSet
|
staticinherited |
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="Type of basis set for PSF matching kernel.",
default="alard-lupton",
allowed={
"alard-lupton": ,
"delta-function":
}
)
Definition at line 72 of file psfMatch.py.
◆ kernelSize
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=int,
doc=,
default=21,
)
Definition at line 87 of file psfMatch.py.
◆ kernelSizeFwhmScaling
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
doc="Multiplier of the largest AL Gaussian basis sigma to get the kernel bbox (pixel) size.",
default=6.0,
check=lambda x: x >= 1.0
)
Definition at line 98 of file psfMatch.py.
◆ kernelSizeMax
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Maximum kernel bbox (pixel) size.",
default=35,
)
Definition at line 109 of file psfMatch.py.
◆ kernelSizeMin
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Minimum kernel bbox (pixel) size.",
default=21,
)
Definition at line 104 of file psfMatch.py.
◆ kernelSumClipping
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Do sigma clipping on the ensemble of kernel sums",
default=True,
)
Definition at line 187 of file psfMatch.py.
◆ lambdaMax
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc=,
default=2.0,
)
Definition at line 444 of file psfMatch.py.
◆ lambdaMin
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc=,
default=-1.0,
)
Definition at line 438 of file psfMatch.py.
◆ lambdaScaling
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="Fraction of the default lambda strength (N.R. 18.5.8) to use. 1e-4 or 1e-5",
default=1e-4,
)
Definition at line 423 of file psfMatch.py.
◆ lambdaStep
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc=,
default=0.1,
)
Definition at line 450 of file psfMatch.py.
◆ lambdaStepType
|
static |
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc=,
default="log",
allowed={
"log": "Step in log intervals; e.g. lambdaMin, lambdaMax, lambdaStep = -1.0, 2.0, 0.1",
"linear": "Step in linear intervals; e.g. lambdaMin, lambdaMax, lambdaStep = 0.1, 100, 0.1",
}
)
Definition at line 428 of file psfMatch.py.
◆ lambdaType
|
static |
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="How to choose the value of the regularization strength",
default="absolute",
allowed={
"absolute": "Use lambdaValue as the value of regularization strength",
"relative": "Use lambdaValue as fraction of the default regularization strength (N.R. 18.5.8)",
"minimizeBiasedRisk": "Minimize biased risk estimate",
"minimizeUnbiasedRisk": "Minimize unbiased risk estimate",
}
)
Definition at line 407 of file psfMatch.py.
◆ lambdaValue
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="Value used for absolute determinations of regularization strength",
default=0.2,
)
Definition at line 418 of file psfMatch.py.
◆ maxConditionNumber
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
doc="Maximum condition number for a well conditioned matrix",
default=5.0e7,
check=lambda x: x >= 0.0
)
Definition at line 250 of file psfMatch.py.
◆ maxKsumSigma
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
doc=,
default=3.0,
check=lambda x: x >= 0.0
)
Definition at line 243 of file psfMatch.py.
◆ maxSpatialConditionNumber
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
doc="Maximum condition number for a well conditioned spatial matrix",
default=1.0e10,
check=lambda x: x >= 0.0
)
Definition at line 265 of file psfMatch.py.
◆ maxSpatialIterations
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Maximum number of iterations for rejecting bad KernelCandidates in spatial fitting",
default=3,
check=lambda x: x >= 1 and x <= 5
)
Definition at line 153 of file psfMatch.py.
◆ nStarPerCell
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Maximum number of KernelCandidates in each SpatialCell to use in the spatial fitting. "
"Set to -1 to use all candidates in each cell.",
default=5,
)
Definition at line 147 of file psfMatch.py.
◆ numPrincipalComponents
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=int,
doc=,
default=5,
check=lambda x: x >= 3
)
Definition at line 175 of file psfMatch.py.
◆ regularizationBorderPenalty
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="Value of the penalty for kernel border pixels",
default=3.0,
check=lambda x: x >= 0.0
)
Definition at line 401 of file psfMatch.py.
◆ regularizationType
|
static |
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="Type of regularization.",
default="centralDifference",
allowed={
"centralDifference": "Penalize second derivative using 2-D stencil of central finite difference",
"forwardDifference": "Penalize first, second, third derivatives using forward finite differeces"
}
)
Definition at line 377 of file psfMatch.py.
◆ scaleByFwhm
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Scale kernelSize, alardGaussians by input Fwhm",
default=True,
)
Definition at line 93 of file psfMatch.py.
◆ singleKernelClipping
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Do sigma clipping on each raw kernel candidate",
default=True,
)
Definition at line 182 of file psfMatch.py.
◆ sizeCellX
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Size (rows) in pixels of each SpatialCell for spatial modeling",
default=128,
check=lambda x: x >= 32
)
Definition at line 135 of file psfMatch.py.
◆ sizeCellY
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Size (columns) in pixels of each SpatialCell for spatial modeling",
default=128,
check=lambda x: x >= 32
)
Definition at line 141 of file psfMatch.py.
◆ spatialBgOrder
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Spatial order of differential background variation",
default=1,
check=lambda x: x >= 0
)
Definition at line 129 of file psfMatch.py.
◆ spatialKernelClipping
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Do sigma clipping after building the spatial model",
default=True,
)
Definition at line 192 of file psfMatch.py.
◆ spatialKernelOrder
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Spatial order of convolution kernel variation",
default=2,
check=lambda x: x >= 0
)
Definition at line 123 of file psfMatch.py.
◆ spatialModelType
|
staticinherited |
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="Type of spatial functions for kernel and background",
default="chebyshev1",
allowed={
"chebyshev1": "Chebyshev polynomial of the first kind",
"polynomial": "Standard x,y polynomial",
}
)
Definition at line 114 of file psfMatch.py.
◆ subtractMeanForPca
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Subtract off the mean feature before doing the Pca",
default=True,
)
Definition at line 170 of file psfMatch.py.
◆ useAfwBackground
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Use afw background subtraction instead of ip_diffim",
default=False,
)
Definition at line 62 of file psfMatch.py.
◆ useBicForKernelBasis
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
doc=,
default=False,
)
Definition at line 290 of file psfMatch.py.
◆ useCoreStats
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
doc=,
default=False,
)
Definition at line 228 of file psfMatch.py.
◆ usePcaForSpatialKernel
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
doc=,
default=False,
)
Definition at line 159 of file psfMatch.py.
◆ useRegularization
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Use regularization to smooth the delta function kernels",
default=True,
)
Definition at line 372 of file psfMatch.py.
◆ warpingConfig
|
staticinherited |
Initial value:
= pexConfig.ConfigField("Config for warping exposures to a common alignment",
afwMath.WarperConfig)
Definition at line 57 of file psfMatch.py.
The documentation for this class was generated from the following file:
- python/lsst/ip/diffim/psfMatch.py
Generated on Wed Apr 22 2026 09:14:11 for lsst.ip.diffim by
1.13.2