lsst.ip.diffim.psfMatch.PsfMatchConfigAL Class Reference
Inheritance diagram for lsst.ip.diffim.psfMatch.PsfMatchConfigAL:
Public Member Functions | |
| setDefaults (self) | |
Detailed Description
The parameters specific to the "Alard-Lupton" (sum-of-Gaussian) Psf-matching basis
Definition at line 297 of file psfMatch.py.
Member Function Documentation
◆ setDefaults()
| lsst.ip.diffim.psfMatch.PsfMatchConfigAL.setDefaults | ( | self | ) |
Definition at line 300 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.
◆ alardDegGauss
|
static |
Initial value:
= pexConfig.ListField(
dtype=int,
doc="Polynomial order of spatial modification of base Gaussians. "
"List length must be `alardNGauss`.",
default=(4, 2, 2),
)
Definition at line 311 of file psfMatch.py.
◆ alardDegGaussDeconv
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Used if `scaleByFwhm==True`, degree of spatial modification of ALL base Gaussians "
"in AL basis during deconvolution",
default=3,
check=lambda x: x >= 1,
deprecated="No longer used. Will be removed after v29"
)
Definition at line 337 of file psfMatch.py.
◆ alardGaussBeta
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="Used if `scaleByFwhm==True`, scaling multiplier of base "
"Gaussian sigmas for automated sigma determination",
default=2.0,
check=lambda x: x >= 0.0,
)
Definition at line 324 of file psfMatch.py.
◆ alardMinSig
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="Used if `scaleByFwhm==True`, minimum sigma (pixels) for base Gaussians",
default=0.7,
check=lambda x: x >= 0.25
)
Definition at line 331 of file psfMatch.py.
◆ alardMinSigDeconv
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="Used if `scaleByFwhm==True`, minimum sigma (pixels) for base Gaussians during deconvolution; "
"make smaller than `alardMinSig` as this is only indirectly used",
default=0.4,
check=lambda x: x >= 0.25
)
Definition at line 345 of file psfMatch.py.
◆ alardNGauss
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of base Gaussians in alard-lupton kernel basis function generation.",
default=3,
check=lambda x: x >= 1
)
Definition at line 305 of file psfMatch.py.
◆ alardNGaussDeconv
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Used if `scaleByFwhm==True`, number of base Gaussians in AL basis during deconvolution",
default=3,
check=lambda x: x >= 1,
deprecated="No longer used. Will be removed after v29"
)
Definition at line 352 of file psfMatch.py.
◆ alardSigGauss
|
static |
Initial value:
= pexConfig.ListField(
dtype=float,
doc="Default sigma values in pixels of base Gaussians. "
"List length must be `alardNGauss`."
"Only used if the template and science image PSFs have equal size.",
default=(0.7, 1.5, 3.0),
)
Definition at line 317 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.
◆ 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.
◆ 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.
◆ 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.
◆ 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.
◆ 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 15 2026 00:05:28 for lsst.ip.diffim by
1.13.2