lsst.ip.diffim  13.0-22-g3839dbb+23
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.ip.diffim.psfMatch.PsfMatchConfigDF Class Reference

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

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
 
- Static Public Attributes inherited from lsst.ip.diffim.psfMatch.PsfMatchConfig
 warpingConfig
 
 detectionConfig
 
 afwBackgroundConfig
 
 useAfwBackground
 
 fitForBackground
 
 kernelBasisSet
 
 kernelSize
 
 scaleByFwhm
 
 kernelSizeFwhmScaling
 
 kernelSizeMin
 
 kernelSizeMax
 
 spatialModelType
 
 spatialKernelOrder
 
 spatialBgOrder
 
 sizeCellX
 
 sizeCellY
 
 nStarPerCell
 
 maxSpatialIterations
 
 usePcaForSpatialKernel
 
 subtractMeanForPca
 
 numPrincipalComponents
 
 singleKernelClipping
 
 kernelSumClipping
 
 spatialKernelClipping
 
 checkConditionNumber
 
 badMaskPlanes
 
 candidateResidualMeanMax
 
 candidateResidualStdMax
 
 useCoreStats
 
 candidateCoreRadius
 
 maxKsumSigma
 
 maxConditionNumber
 
 conditionNumberType
 
 maxSpatialConditionNumber
 
 iterateSingleKernel
 
 constantVarianceWeighting
 
 calculateKernelUncertainty
 
 useBicForKernelBasis
 

Detailed Description

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

Definition at line 424 of file psfMatch.py.

Member Function Documentation

◆ setDefaults()

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

Definition at line 427 of file psfMatch.py.

Member Data Documentation

◆ 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 449 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 458 of file psfMatch.py.

◆ kernelBasisSet

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.kernelBasisSet

Definition at line 429 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 507 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 501 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 486 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 513 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 491 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 470 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 481 of file psfMatch.py.

◆ maxConditionNumber

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.maxConditionNumber

Definition at line 430 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 464 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 440 of file psfMatch.py.

◆ subtractMeanForPca

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.subtractMeanForPca

Definition at line 432 of file psfMatch.py.

◆ useBicForKernelBasis

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.useBicForKernelBasis

Definition at line 433 of file psfMatch.py.

◆ usePcaForSpatialKernel

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.usePcaForSpatialKernel

Definition at line 431 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 435 of file psfMatch.py.


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