lsst.ip.diffim  13.0-26-g703d095+5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Static Public Attributes | List of all members
lsst.ip.diffim.psfMatch.PsfMatchConfig Class Reference

Base configuration for Psf-matching. More...

Inheritance diagram for lsst.ip.diffim.psfMatch.PsfMatchConfig:
lsst.ip.diffim.psfMatch.PsfMatchConfigAL lsst.ip.diffim.psfMatch.PsfMatchConfigDF

Static Public Attributes

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

Base configuration for Psf-matching.

The base configuration of the Psf-matching kernel, and of the warping, detection, and background modeling subTasks.

Definition at line 119 of file psfMatch.py.

Member Data Documentation

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.afwBackgroundConfig
static
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
static
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
static
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
static
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
static
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
static
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.PsfMatchConfig.checkConditionNumber
static
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
static
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
static
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
static
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
static
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.PsfMatchConfig.iterateSingleKernel
static
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.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelBasisSet
static
Initial value:
1 = pexConfig.ChoiceField(
2  dtype=str,
3  doc="Type of basis set for PSF matching kernel.",
4  default="alard-lupton",
5  allowed={
6  "alard-lupton": """Alard-Lupton sum-of-gaussians basis set, * The first term has no spatial variation * The kernel sum is conserved * You may want to turn off 'usePcaForSpatialKernel'""",
7  "delta-function": """Delta-function kernel basis set, * You may enable the option useRegularization * You should seriously consider usePcaForSpatialKernel, which will also enable kernel sum conservation for the delta function kernels"""
8  }
9  )

Definition at line 142 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSize
static
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
static
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
static
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
static
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
static
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.PsfMatchConfig.maxConditionNumber
static
Initial value:
1 = pexConfig.Field(
2  dtype=float,
3  doc="Maximum condition number for a well conditioned matrix",
4  default=5.0e7,
5  check=lambda x: x >= 0.0
6  )

Definition at line 320 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.maxKsumSigma
static
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
static
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
static
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
static
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
static
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.PsfMatchConfig.scaleByFwhm
static
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
static
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
static
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
static
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
static
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
static
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
static
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
static
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.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.subtractMeanForPca
static
Initial value:
1 = pexConfig.Field(
2  dtype=bool,
3  doc="Subtract off the mean feature before doing the Pca",
4  default=True,
5  )

Definition at line 240 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.useAfwBackground
static
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.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.useBicForKernelBasis
static
Initial value:
1 = pexConfig.Field(
2  dtype=bool,
3  doc="""Use Bayesian Information Criterion to select the number of bases going into the kernel""",
4  default=False,
5  )

Definition at line 360 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.useCoreStats
static
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.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.usePcaForSpatialKernel
static
Initial value:
1 = pexConfig.Field(
2  dtype=bool,
3  doc="""Use Pca to reduce the dimensionality of the kernel basis sets. This is particularly useful for delta-function kernels. Functionally, after all Cells have their raw kernels determined, we run a Pca on these Kernels, re-fit the Cells using the eigenKernels and then fit those for spatial variation using the same technique as for Alard-Lupton kernels. If this option is used, the first term will have no spatial variation and the kernel sum will be conserved.""",
4  default=False,
5  )

Definition at line 229 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.warpingConfig
static
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: