lsst.ip.diffim  13.0-26-g703d095+10
 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
 
tuple warpingConfig
 
tuple detectionConfig
 
tuple afwBackgroundConfig
 
tuple useAfwBackground
 
tuple fitForBackground
 
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 numPrincipalComponents
 
tuple singleKernelClipping
 
tuple kernelSumClipping
 
tuple spatialKernelClipping
 
tuple checkConditionNumber
 
tuple badMaskPlanes
 
tuple candidateResidualMeanMax
 
tuple candidateResidualStdMax
 
tuple useCoreStats
 
tuple candidateCoreRadius
 
tuple maxKsumSigma
 
tuple conditionNumberType
 
tuple maxSpatialConditionNumber
 
tuple iterateSingleKernel
 
tuple constantVarianceWeighting
 
tuple calculateKernelUncertainty
 

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.PsfMatchConfig.afwBackgroundConfig
staticinherited
Initial value:
1 = pexConfig.ConfigField("Controlling the Afw background fitting",
2  SubtractBackgroundConfig)

Definition at line 129 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.badMaskPlanes
staticinherited
Initial value:
1 = pexConfig.ListField(
2  dtype=str,
3  doc="""Mask planes to ignore when calculating diffim statistics Options: NO_DATA EDGE SAT BAD CR INTRP""",
4  default=("NO_DATA", "EDGE", "SAT")
5  )

Definition at line 276 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.calculateKernelUncertainty
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=bool,
3  doc="""Calculate kernel and background uncertainties for each kernel candidate? This comes from the inverse of the covariance matrix. Warning: regularization can cause problems for this step.""",
4  default=False,
5  )

Definition at line 353 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.candidateCoreRadius
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=int,
3  doc="""Radius for calculation of stats in 'core' of KernelCandidate diffim. Total number of pixels used will be (2*radius)**2. This is used both for 'core' diffim quality as well as ranking of KernelCandidates by their total flux in this core""",
4  default=3,
5  check=lambda x: x >= 1
6  )

Definition at line 304 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.candidateResidualMeanMax
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=float,
3  doc="""Rejects KernelCandidates yielding bad difference image quality. Used by BuildSingleKernelVisitor, AssessSpatialKernelVisitor. Represents average over pixels of (image/sqrt(variance)).""",
4  default=0.25,
5  check=lambda x: x >= 0.0
6  )

Definition at line 282 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.candidateResidualStdMax
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=float,
3  doc="""Rejects KernelCandidates yielding bad difference image quality. Used by BuildSingleKernelVisitor, AssessSpatialKernelVisitor. Represents stddev over pixels of (image/sqrt(variance)).""",
4  default=1.50,
5  check=lambda x: x >= 0.0
6  )

Definition at line 290 of file psfMatch.py.

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.PsfMatchConfig.checkConditionNumber
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=bool,
3  doc="""Test for maximum condition number when inverting a kernel matrix. Anything above maxConditionNumber is not used and the candidate is set as BAD. Also used to truncate inverse matrix in estimateBiasedRisk. However, if you are doing any deconvolution you will want to turn this off, or use a large maxConditionNumber""",
4  default=False,
5  )

Definition at line 267 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.conditionNumberType
staticinherited
Initial value:
1 = pexConfig.ChoiceField(
2  dtype=str,
3  doc="Use singular values (SVD) or eigen values (EIGENVALUE) to determine condition number",
4  default="EIGENVALUE",
5  allowed={
6  "SVD": "Use singular values",
7  "EIGENVALUE": "Use eigen values (faster)",
8  }
9  )

Definition at line 326 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.constantVarianceWeighting
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=bool,
3  doc="""Use constant variance weighting in single kernel fitting? In some cases this is better for bright star residuals.""",
4  default=True,
5  )

Definition at line 347 of file psfMatch.py.

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

Definition at line 127 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.fitForBackground
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=bool,
3  doc="Include terms (including kernel cross terms) for background in ip_diffim",
4  default=False,
5  )

Definition at line 137 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.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.iterateSingleKernel
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=bool,
3  doc="""Remake KernelCandidate using better variance estimate after first pass? Primarily useful when convolving a single-depth image, otherwise not necessary.""",
4  default=False,
5  )

Definition at line 341 of file psfMatch.py.

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.kernelBasisSet

Definition at line 429 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSize
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=int,
3  doc="""Number of rows/columns in the convolution kernel; should be odd-valued. Modified by kernelSizeFwhmScaling if scaleByFwhm = true""",
4  default=21,
5  )

Definition at line 157 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSizeFwhmScaling
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=float,
3  doc="""How much to scale the kernel size based on the largest AL Sigma""",
4  default=6.0,
5  check=lambda x: x >= 1.0
6  )

Definition at line 168 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSizeMax
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=int,
3  doc="""Maximum Kernel Size""",
4  default=35,
5  )

Definition at line 179 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSizeMin
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=int,
3  doc="""Minimum Kernel Size""",
4  default=21,
5  )

Definition at line 174 of file psfMatch.py.

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

Definition at line 257 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.PsfMatchConfig.maxKsumSigma
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=float,
3  doc="""Maximum allowed sigma for outliers from kernel sum distribution. Used to reject variable objects from the kernel model""",
4  default=3.0,
5  check=lambda x: x >= 0.0
6  )

Definition at line 313 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.maxSpatialConditionNumber
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=float,
3  doc="Maximum condition number for a well conditioned spatial matrix",
4  default=1.0e10,
5  check=lambda x: x >= 0.0
6  )

Definition at line 335 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.maxSpatialIterations
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=int,
3  doc="Maximum number of iterations for rejecting bad KernelCandidates in spatial fitting",
4  default=3,
5  check=lambda x: x >= 1 and x <= 5
6  )

Definition at line 223 of file psfMatch.py.

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

Definition at line 217 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.numPrincipalComponents
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=int,
3  doc="""Number of principal components to use for Pca basis, including the mean kernel if requested.""",
4  default=5,
5  check=lambda x: x >= 3
6  )

Definition at line 245 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.

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

Definition at line 163 of file psfMatch.py.

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

Definition at line 252 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.sizeCellX
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=int,
3  doc="Size (rows) in pixels of each SpatialCell for spatial modeling",
4  default=128,
5  check=lambda x: x >= 32
6  )

Definition at line 205 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.sizeCellY
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=int,
3  doc="Size (columns) in pixels of each SpatialCell for spatial modeling",
4  default=128,
5  check=lambda x: x >= 32
6  )

Definition at line 211 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.spatialBgOrder
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=int,
3  doc="Spatial order of differential background variation",
4  default=1,
5  check=lambda x: x >= 0
6  )

Definition at line 199 of file psfMatch.py.

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

Definition at line 262 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.spatialKernelOrder
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=int,
3  doc="Spatial order of convolution kernel variation",
4  default=2,
5  check=lambda x: x >= 0
6  )

Definition at line 193 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.spatialModelType
staticinherited
Initial value:
1 = pexConfig.ChoiceField(
2  dtype=str,
3  doc="Type of spatial functions for kernel and background",
4  default="chebyshev1",
5  allowed={
6  "chebyshev1": "Chebyshev polynomial of the first kind",
7  "polynomial": "Standard x,y polynomial",
8  }
9  )

Definition at line 184 of file psfMatch.py.

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.subtractMeanForPca

Definition at line 432 of file psfMatch.py.

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

Definition at line 132 of file psfMatch.py.

lsst.ip.diffim.psfMatch.PsfMatchConfigDF.useBicForKernelBasis

Definition at line 433 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.useCoreStats
staticinherited
Initial value:
1 = pexConfig.Field(
2  dtype=bool,
3  doc="""Use the core of the footprint for the quality statistics, instead of the entire footprint. WARNING: if there is deconvolution we probably will need to turn this off""",
4  default=False,
5  )

Definition at line 298 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.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.warpingConfig
staticinherited
Initial value:
1 = pexConfig.ConfigField("Config for warping exposures to a common alignment",
2  afwMath.warper.WarperConfig)

Definition at line 125 of file psfMatch.py.


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