lsst.ip.diffim  13.0-22-g3839dbb+8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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

Public Member Functions

def setDefaults
 

Public Attributes

 kernelBasisSet
 
 maxConditionNumber
 
 usePcaForSpatialKernel
 
 subtractMeanForPca
 
 useBicForKernelBasis
 

Static Public Attributes

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

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

Definition at line 427 of file psfMatch.py.

Member Data Documentation

tuple lsst.ip.diffim.psfMatch.PsfMatchConfigDF.centralRegularizationStencil
static
Initial value:
1 = pexConfig.ChoiceField(
2  dtype=int,
3  doc="Type of stencil to approximate central derivative (for centralDifference only)",
4  default=9,
5  allowed={
6  5: "5-point stencil including only adjacent-in-x,y elements",
7  9: "9-point stencil including diagonal elements"
8  }
9  )

Definition at line 449 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfigDF.forwardRegularizationOrders
static
Initial value:
1 = pexConfig.ListField(
2  dtype=int,
3  doc="Array showing which order derivatives to penalize (for forwardDifference only)",
4  default=(1, 2),
5  itemCheck=lambda x: (x > 0) and (x < 4)
6  )

Definition at line 458 of file psfMatch.py.

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.kernelBasisSet

Definition at line 429 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfigDF.lambdaMax
static
Initial value:
1 = pexConfig.Field(
2  dtype=float,
3  doc="""If scan through lambda needed (minimizeBiasedRisk, minimizeUnbiasedRisk), stop at this value. If lambdaStepType = log:linear, suggest 2:100""",
4  default=2.0,
5  )

Definition at line 507 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfigDF.lambdaMin
static
Initial value:
1 = pexConfig.Field(
2  dtype=float,
3  doc="""If scan through lambda needed (minimizeBiasedRisk, minimizeUnbiasedRisk), start at this value. If lambdaStepType = log:linear, suggest -1:0.1""",
4  default=-1.0,
5  )

Definition at line 501 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfigDF.lambdaScaling
static
Initial value:
1 = pexConfig.Field(
2  dtype=float,
3  doc="Fraction of the default lambda strength (N.R. 18.5.8) to use. 1e-4 or 1e-5",
4  default=1e-4,
5  )

Definition at line 486 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfigDF.lambdaStep
static
Initial value:
1 = pexConfig.Field(
2  dtype=float,
3  doc="""If scan through lambda needed (minimizeBiasedRisk, minimizeUnbiasedRisk), step in these increments. If lambdaStepType = log:linear, suggest 0.1:0.1""",
4  default=0.1,
5  )

Definition at line 513 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfigDF.lambdaStepType
static
Initial value:
1 = pexConfig.ChoiceField(
2  dtype=str,
3  doc="""If a scan through lambda is needed (minimizeBiasedRisk, minimizeUnbiasedRisk), use log or linear steps""",
4  default="log",
5  allowed={
6  "log": "Step in log intervals; e.g. lambdaMin, lambdaMax, lambdaStep = -1.0, 2.0, 0.1",
7  "linear": "Step in linear intervals; e.g. lambdaMin, lambdaMax, lambdaStep = 0.1, 100, 0.1",
8  }
9  )

Definition at line 491 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfigDF.lambdaType
static
Initial value:
1 = pexConfig.ChoiceField(
2  dtype=str,
3  doc="How to choose the value of the regularization strength",
4  default="absolute",
5  allowed={
6  "absolute": "Use lambdaValue as the value of regularization strength",
7  "relative": "Use lambdaValue as fraction of the default regularization strength (N.R. 18.5.8)",
8  "minimizeBiasedRisk": "Minimize biased risk estimate",
9  "minimizeUnbiasedRisk": "Minimize unbiased risk estimate",
10  }
11  )

Definition at line 470 of file psfMatch.py.

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

Definition at line 481 of file psfMatch.py.

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.maxConditionNumber

Definition at line 430 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfigDF.regularizationBorderPenalty
static
Initial value:
1 = pexConfig.Field(
2  dtype=float,
3  doc="Value of the penalty for kernel border pixels",
4  default=3.0,
5  check=lambda x: x >= 0.0
6  )

Definition at line 464 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfigDF.regularizationType
static
Initial value:
1 = pexConfig.ChoiceField(
2  dtype=str,
3  doc="Type of regularization.",
4  default="centralDifference",
5  allowed={
6  "centralDifference": "Penalize second derivative using 2-D stencil of central finite difference",
7  "forwardDifference": "Penalize first, second, third derivatives using forward finite differeces"
8  }
9  )

Definition at line 440 of file psfMatch.py.

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.subtractMeanForPca

Definition at line 432 of file psfMatch.py.

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.useBicForKernelBasis

Definition at line 433 of file psfMatch.py.

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.usePcaForSpatialKernel

Definition at line 431 of file psfMatch.py.

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

Definition at line 435 of file psfMatch.py.


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