lsst.ip.diffim gaa63f70f4e+5e034ae04a
Loading...
Searching...
No Matches
Static Public Attributes | List of all members
lsst.ip.diffim.psfMatch.PsfMatchConfig Class Reference
Inheritance diagram for lsst.ip.diffim.psfMatch.PsfMatchConfig:
lsst.ip.diffim.makeKernel.MakeKernelConfig lsst.ip.diffim.psfMatch.PsfMatchConfigAL lsst.ip.diffim.psfMatch.PsfMatchConfigDF lsst.ip.diffim.snapPsfMatch.SnapPsfMatchConfigAL lsst.ip.diffim.snapPsfMatch.SnapPsfMatchConfigDF

Static Public Attributes

pexConfig warpingConfig
 
pexConfig detectionConfig
 
pexConfig afwBackgroundConfig
 
pexConfig useAfwBackground
 
pexConfig fitForBackground
 
pexConfig kernelBasisSet
 
pexConfig kernelSize
 
pexConfig scaleByFwhm
 
pexConfig kernelSizeFwhmScaling
 
pexConfig kernelSizeMin
 
pexConfig kernelSizeMax
 
pexConfig spatialModelType
 
pexConfig spatialKernelOrder
 
pexConfig spatialBgOrder
 
pexConfig sizeCellX
 
pexConfig sizeCellY
 
pexConfig nStarPerCell
 
pexConfig maxSpatialIterations
 
pexConfig usePcaForSpatialKernel
 
pexConfig subtractMeanForPca
 
pexConfig numPrincipalComponents
 
pexConfig singleKernelClipping
 
pexConfig kernelSumClipping
 
pexConfig spatialKernelClipping
 
pexConfig checkConditionNumber
 
pexConfig badMaskPlanes
 
pexConfig candidateResidualMeanMax
 
pexConfig candidateResidualStdMax
 
pexConfig useCoreStats
 
pexConfig candidateCoreRadius
 
pexConfig maxKsumSigma
 
pexConfig maxConditionNumber
 
pexConfig conditionNumberType
 
pexConfig maxSpatialConditionNumber
 
pexConfig iterateSingleKernel
 
pexConfig constantVarianceWeighting
 
pexConfig calculateKernelUncertainty
 
pexConfig 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 123 of file psfMatch.py.

Member Data Documentation

◆ afwBackgroundConfig

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

Definition at line 133 of file psfMatch.py.

◆ badMaskPlanes

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

Definition at line 280 of file psfMatch.py.

◆ calculateKernelUncertainty

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

Definition at line 357 of file psfMatch.py.

◆ candidateCoreRadius

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

Definition at line 308 of file psfMatch.py.

◆ candidateResidualMeanMax

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

Definition at line 286 of file psfMatch.py.

◆ candidateResidualStdMax

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

Definition at line 294 of file psfMatch.py.

◆ checkConditionNumber

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

Definition at line 271 of file psfMatch.py.

◆ conditionNumberType

pexConfig lsst.ip.diffim.psfMatch.PsfMatchConfig.conditionNumberType
static
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 330 of file psfMatch.py.

◆ constantVarianceWeighting

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

Definition at line 351 of file psfMatch.py.

◆ detectionConfig

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

Definition at line 131 of file psfMatch.py.

◆ fitForBackground

pexConfig lsst.ip.diffim.psfMatch.PsfMatchConfig.fitForBackground
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Include terms (including kernel cross terms) for background in ip_diffim",
default=False,
)

Definition at line 141 of file psfMatch.py.

◆ iterateSingleKernel

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

Definition at line 345 of file psfMatch.py.

◆ kernelBasisSet

pexConfig lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelBasisSet
static
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="Type of basis set for PSF matching kernel.",
default="alard-lupton",
allowed={
"alard-lupton": ,
"delta-function":
}
)

Definition at line 146 of file psfMatch.py.

◆ kernelSize

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

Definition at line 161 of file psfMatch.py.

◆ kernelSizeFwhmScaling

pexConfig lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSizeFwhmScaling
static
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 172 of file psfMatch.py.

◆ kernelSizeMax

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

Definition at line 183 of file psfMatch.py.

◆ kernelSizeMin

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

Definition at line 178 of file psfMatch.py.

◆ kernelSumClipping

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

Definition at line 261 of file psfMatch.py.

◆ maxConditionNumber

pexConfig lsst.ip.diffim.psfMatch.PsfMatchConfig.maxConditionNumber
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Maximum condition number for a well conditioned matrix",
default=5.0e7,
check=lambda x: x >= 0.0
)

Definition at line 324 of file psfMatch.py.

◆ maxKsumSigma

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

Definition at line 317 of file psfMatch.py.

◆ maxSpatialConditionNumber

pexConfig lsst.ip.diffim.psfMatch.PsfMatchConfig.maxSpatialConditionNumber
static
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 339 of file psfMatch.py.

◆ maxSpatialIterations

pexConfig lsst.ip.diffim.psfMatch.PsfMatchConfig.maxSpatialIterations
static
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 227 of file psfMatch.py.

◆ nStarPerCell

pexConfig lsst.ip.diffim.psfMatch.PsfMatchConfig.nStarPerCell
static
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 221 of file psfMatch.py.

◆ numPrincipalComponents

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

Definition at line 249 of file psfMatch.py.

◆ scaleByFwhm

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

Definition at line 167 of file psfMatch.py.

◆ singleKernelClipping

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

Definition at line 256 of file psfMatch.py.

◆ sizeCellX

pexConfig lsst.ip.diffim.psfMatch.PsfMatchConfig.sizeCellX
static
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 209 of file psfMatch.py.

◆ sizeCellY

pexConfig lsst.ip.diffim.psfMatch.PsfMatchConfig.sizeCellY
static
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 215 of file psfMatch.py.

◆ spatialBgOrder

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

Definition at line 203 of file psfMatch.py.

◆ spatialKernelClipping

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

Definition at line 266 of file psfMatch.py.

◆ spatialKernelOrder

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

Definition at line 197 of file psfMatch.py.

◆ spatialModelType

pexConfig lsst.ip.diffim.psfMatch.PsfMatchConfig.spatialModelType
static
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 188 of file psfMatch.py.

◆ subtractMeanForPca

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

Definition at line 244 of file psfMatch.py.

◆ useAfwBackground

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

Definition at line 136 of file psfMatch.py.

◆ useBicForKernelBasis

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

Definition at line 364 of file psfMatch.py.

◆ useCoreStats

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

Definition at line 302 of file psfMatch.py.

◆ usePcaForSpatialKernel

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

Definition at line 233 of file psfMatch.py.

◆ warpingConfig

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

Definition at line 129 of file psfMatch.py.


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