LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.ip.diffim.psfMatch.PsfMatchConfigDF Class Reference
Inheritance diagram for lsst.ip.diffim.psfMatch.PsfMatchConfigDF:
lsst.ip.diffim.psfMatch.PsfMatchConfig lsst.ip.diffim.snapPsfMatch.SnapPsfMatchConfigDF

Public Member Functions

def setDefaults (self)
 

Public Attributes

 kernelBasisSet
 
 maxConditionNumber
 
 usePcaForSpatialKernel
 
 subtractMeanForPca
 
 useBicForKernelBasis
 

Static Public Attributes

 useRegularization
 
 regularizationType
 
 centralRegularizationStencil
 
 forwardRegularizationOrders
 
 regularizationBorderPenalty
 
 lambdaType
 
 lambdaValue
 
 lambdaScaling
 
 lambdaStepType
 
 lambdaMin
 
 lambdaMax
 
 lambdaStep
 
 warpingConfig
 
 detectionConfig
 
 afwBackgroundConfig
 
 useAfwBackground
 
 fitForBackground
 
 kernelSize
 
 scaleByFwhm
 
 kernelSizeFwhmScaling
 
 kernelSizeMin
 
 kernelSizeMax
 
 spatialModelType
 
 spatialKernelOrder
 
 spatialBgOrder
 
 sizeCellX
 
 sizeCellY
 
 nStarPerCell
 
 maxSpatialIterations
 
 numPrincipalComponents
 
 singleKernelClipping
 
 kernelSumClipping
 
 spatialKernelClipping
 
 checkConditionNumber
 
 badMaskPlanes
 
 candidateResidualMeanMax
 
 candidateResidualStdMax
 
 useCoreStats
 
 candidateCoreRadius
 
 maxKsumSigma
 
 conditionNumberType
 
 maxSpatialConditionNumber
 
 iterateSingleKernel
 
 constantVarianceWeighting
 
 calculateKernelUncertainty
 

Detailed Description

The parameters specific to the delta-function (one basis per-pixel) Psf-matching basis

Definition at line 431 of file psfMatch.py.

Member Function Documentation

◆ setDefaults()

def lsst.ip.diffim.psfMatch.PsfMatchConfigDF.setDefaults (   self)

Reimplemented in lsst.ip.diffim.snapPsfMatch.SnapPsfMatchConfigDF.

Definition at line 434 of file psfMatch.py.

434  def setDefaults(self):
435  PsfMatchConfig.setDefaults(self)
436  self.kernelBasisSet = "delta-function"
437  self.maxConditionNumber = 5.0e6
438  self.usePcaForSpatialKernel = True
439  self.subtractMeanForPca = True
440  self.useBicForKernelBasis = False
441 

Member Data Documentation

◆ afwBackgroundConfig

lsst.ip.diffim.psfMatch.PsfMatchConfig.afwBackgroundConfig
staticinherited
Initial value:
= pexConfig.ConfigField("Controlling the Afw background fitting",
SubtractBackgroundConfig)

Definition at line 132 of file psfMatch.py.

◆ badMaskPlanes

lsst.ip.diffim.psfMatch.PsfMatchConfig.badMaskPlanes
staticinherited
Initial value:
= pexConfig.ListField(
dtype=str,
doc=,
default=("NO_DATA", "EDGE", "SAT")
)

Definition at line 279 of file psfMatch.py.

◆ calculateKernelUncertainty

lsst.ip.diffim.psfMatch.PsfMatchConfig.calculateKernelUncertainty
staticinherited
Initial value:
= pexConfig.Field(
dtype=bool,
doc=,
default=False,
)

Definition at line 356 of file psfMatch.py.

◆ candidateCoreRadius

lsst.ip.diffim.psfMatch.PsfMatchConfig.candidateCoreRadius
staticinherited
Initial value:
= pexConfig.Field(
dtype=int,
doc=,
default=3,
check=lambda x: x >= 1
)

Definition at line 307 of file psfMatch.py.

◆ candidateResidualMeanMax

lsst.ip.diffim.psfMatch.PsfMatchConfig.candidateResidualMeanMax
staticinherited
Initial value:
= pexConfig.Field(
dtype=float,
doc=,
default=0.25,
check=lambda x: x >= 0.0
)

Definition at line 285 of file psfMatch.py.

◆ candidateResidualStdMax

lsst.ip.diffim.psfMatch.PsfMatchConfig.candidateResidualStdMax
staticinherited
Initial value:
= pexConfig.Field(
dtype=float,
doc=,
default=1.50,
check=lambda x: x >= 0.0
)

Definition at line 293 of file psfMatch.py.

◆ centralRegularizationStencil

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.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 456 of file psfMatch.py.

◆ checkConditionNumber

lsst.ip.diffim.psfMatch.PsfMatchConfig.checkConditionNumber
staticinherited
Initial value:
= pexConfig.Field(
dtype=bool,
doc=,
default=False,
)

Definition at line 270 of file psfMatch.py.

◆ conditionNumberType

lsst.ip.diffim.psfMatch.PsfMatchConfig.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 329 of file psfMatch.py.

◆ constantVarianceWeighting

lsst.ip.diffim.psfMatch.PsfMatchConfig.constantVarianceWeighting
staticinherited
Initial value:
= pexConfig.Field(
dtype=bool,
doc=,
default=True,
)

Definition at line 350 of file psfMatch.py.

◆ detectionConfig

lsst.ip.diffim.psfMatch.PsfMatchConfig.detectionConfig
staticinherited
Initial value:
= pexConfig.ConfigField("Controlling the detection of sources for kernel building",
DetectionConfig)

Definition at line 130 of file psfMatch.py.

◆ fitForBackground

lsst.ip.diffim.psfMatch.PsfMatchConfig.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 140 of file psfMatch.py.

◆ forwardRegularizationOrders

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.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 465 of file psfMatch.py.

◆ iterateSingleKernel

lsst.ip.diffim.psfMatch.PsfMatchConfig.iterateSingleKernel
staticinherited
Initial value:
= pexConfig.Field(
dtype=bool,
doc=,
default=False,
)

Definition at line 344 of file psfMatch.py.

◆ kernelBasisSet

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.kernelBasisSet

Definition at line 436 of file psfMatch.py.

◆ kernelSize

lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSize
staticinherited
Initial value:
= pexConfig.Field(
dtype=int,
doc=,
default=21,
)

Definition at line 160 of file psfMatch.py.

◆ kernelSizeFwhmScaling

lsst.ip.diffim.psfMatch.PsfMatchConfig.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 171 of file psfMatch.py.

◆ kernelSizeMax

lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSizeMax
staticinherited
Initial value:
= pexConfig.Field(
dtype=int,
doc="Maximum kernel bbox (pixel) size.",
default=35,
)

Definition at line 182 of file psfMatch.py.

◆ kernelSizeMin

lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSizeMin
staticinherited
Initial value:
= pexConfig.Field(
dtype=int,
doc="Minimum kernel bbox (pixel) size.",
default=21,
)

Definition at line 177 of file psfMatch.py.

◆ kernelSumClipping

lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSumClipping
staticinherited
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Do sigma clipping on the ensemble of kernel sums",
default=True,
)

Definition at line 260 of file psfMatch.py.

◆ lambdaMax

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.lambdaMax
static
Initial value:
= pexConfig.Field(
dtype=float,
doc=,
default=2.0,
)

Definition at line 514 of file psfMatch.py.

◆ lambdaMin

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.lambdaMin
static
Initial value:
= pexConfig.Field(
dtype=float,
doc=,
default=-1.0,
)

Definition at line 508 of file psfMatch.py.

◆ lambdaScaling

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.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 493 of file psfMatch.py.

◆ lambdaStep

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.lambdaStep
static
Initial value:
= pexConfig.Field(
dtype=float,
doc=,
default=0.1,
)

Definition at line 520 of file psfMatch.py.

◆ lambdaStepType

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.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 498 of file psfMatch.py.

◆ lambdaType

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.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 477 of file psfMatch.py.

◆ lambdaValue

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.lambdaValue
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Value used for absolute determinations of regularization strength",
default=0.2,
)

Definition at line 488 of file psfMatch.py.

◆ maxConditionNumber

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.maxConditionNumber

Definition at line 437 of file psfMatch.py.

◆ maxKsumSigma

lsst.ip.diffim.psfMatch.PsfMatchConfig.maxKsumSigma
staticinherited
Initial value:
= pexConfig.Field(
dtype=float,
doc=,
default=3.0,
check=lambda x: x >= 0.0
)

Definition at line 316 of file psfMatch.py.

◆ maxSpatialConditionNumber

lsst.ip.diffim.psfMatch.PsfMatchConfig.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 338 of file psfMatch.py.

◆ maxSpatialIterations

lsst.ip.diffim.psfMatch.PsfMatchConfig.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 226 of file psfMatch.py.

◆ nStarPerCell

lsst.ip.diffim.psfMatch.PsfMatchConfig.nStarPerCell
staticinherited
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of KernelCandidates in each SpatialCell to use in the spatial fitting",
default=3,
check=lambda x: x >= 1
)

Definition at line 220 of file psfMatch.py.

◆ numPrincipalComponents

lsst.ip.diffim.psfMatch.PsfMatchConfig.numPrincipalComponents
staticinherited
Initial value:
= pexConfig.Field(
dtype=int,
doc=,
default=5,
check=lambda x: x >= 3
)

Definition at line 248 of file psfMatch.py.

◆ regularizationBorderPenalty

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.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 471 of file psfMatch.py.

◆ regularizationType

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.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 447 of file psfMatch.py.

◆ scaleByFwhm

lsst.ip.diffim.psfMatch.PsfMatchConfig.scaleByFwhm
staticinherited
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Scale kernelSize, alardGaussians by input Fwhm",
default=True,
)

Definition at line 166 of file psfMatch.py.

◆ singleKernelClipping

lsst.ip.diffim.psfMatch.PsfMatchConfig.singleKernelClipping
staticinherited
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Do sigma clipping on each raw kernel candidate",
default=True,
)

Definition at line 255 of file psfMatch.py.

◆ sizeCellX

lsst.ip.diffim.psfMatch.PsfMatchConfig.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 208 of file psfMatch.py.

◆ sizeCellY

lsst.ip.diffim.psfMatch.PsfMatchConfig.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 214 of file psfMatch.py.

◆ spatialBgOrder

lsst.ip.diffim.psfMatch.PsfMatchConfig.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 202 of file psfMatch.py.

◆ spatialKernelClipping

lsst.ip.diffim.psfMatch.PsfMatchConfig.spatialKernelClipping
staticinherited
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Do sigma clipping after building the spatial model",
default=True,
)

Definition at line 265 of file psfMatch.py.

◆ spatialKernelOrder

lsst.ip.diffim.psfMatch.PsfMatchConfig.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 196 of file psfMatch.py.

◆ spatialModelType

lsst.ip.diffim.psfMatch.PsfMatchConfig.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 187 of file psfMatch.py.

◆ subtractMeanForPca

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.subtractMeanForPca

Definition at line 439 of file psfMatch.py.

◆ useAfwBackground

lsst.ip.diffim.psfMatch.PsfMatchConfig.useAfwBackground
staticinherited
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Use afw background subtraction instead of ip_diffim",
default=False,
)

Definition at line 135 of file psfMatch.py.

◆ useBicForKernelBasis

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.useBicForKernelBasis

Definition at line 440 of file psfMatch.py.

◆ useCoreStats

lsst.ip.diffim.psfMatch.PsfMatchConfig.useCoreStats
staticinherited
Initial value:
= pexConfig.Field(
dtype=bool,
doc=,
default=False,
)

Definition at line 301 of file psfMatch.py.

◆ usePcaForSpatialKernel

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.usePcaForSpatialKernel

Definition at line 438 of file psfMatch.py.

◆ useRegularization

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.useRegularization
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Use regularization to smooth the delta function kernels",
default=True,
)

Definition at line 442 of file psfMatch.py.

◆ warpingConfig

lsst.ip.diffim.psfMatch.PsfMatchConfig.warpingConfig
staticinherited
Initial value:
= pexConfig.ConfigField("Config for warping exposures to a common alignment",

Definition at line 128 of file psfMatch.py.


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