lsst.ip.diffim  16.0-17-g31abd91+7
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 lsst.ip.diffim.snapPsfMatch.SnapPsfMatchConfigAL lsst.ip.diffim.snapPsfMatch.SnapPsfMatchConfigDF

Static Public Attributes

 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

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 120 of file psfMatch.py.

Member Data Documentation

◆ afwBackgroundConfig

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

Definition at line 130 of file psfMatch.py.

◆ badMaskPlanes

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

Definition at line 277 of file psfMatch.py.

◆ calculateKernelUncertainty

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

Definition at line 354 of file psfMatch.py.

◆ candidateCoreRadius

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

Definition at line 305 of file psfMatch.py.

◆ candidateResidualMeanMax

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 283 of file psfMatch.py.

◆ candidateResidualStdMax

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 291 of file psfMatch.py.

◆ checkConditionNumber

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

Definition at line 268 of file psfMatch.py.

◆ conditionNumberType

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 327 of file psfMatch.py.

◆ constantVarianceWeighting

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

Definition at line 348 of file psfMatch.py.

◆ detectionConfig

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

Definition at line 128 of file psfMatch.py.

◆ fitForBackground

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 138 of file psfMatch.py.

◆ iterateSingleKernel

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

Definition at line 342 of file psfMatch.py.

◆ kernelBasisSet

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 143 of file psfMatch.py.

◆ kernelSize

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

Definition at line 158 of file psfMatch.py.

◆ kernelSizeFwhmScaling

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

Definition at line 169 of file psfMatch.py.

◆ kernelSizeMax

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

Definition at line 180 of file psfMatch.py.

◆ kernelSizeMin

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

Definition at line 175 of file psfMatch.py.

◆ kernelSumClipping

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 258 of file psfMatch.py.

◆ maxConditionNumber

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 321 of file psfMatch.py.

◆ maxKsumSigma

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 314 of file psfMatch.py.

◆ maxSpatialConditionNumber

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 336 of file psfMatch.py.

◆ maxSpatialIterations

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 224 of file psfMatch.py.

◆ nStarPerCell

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 218 of file psfMatch.py.

◆ numPrincipalComponents

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

Definition at line 246 of file psfMatch.py.

◆ scaleByFwhm

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 164 of file psfMatch.py.

◆ singleKernelClipping

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 253 of file psfMatch.py.

◆ sizeCellX

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 206 of file psfMatch.py.

◆ sizeCellY

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 212 of file psfMatch.py.

◆ spatialBgOrder

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 200 of file psfMatch.py.

◆ spatialKernelClipping

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 263 of file psfMatch.py.

◆ spatialKernelOrder

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 194 of file psfMatch.py.

◆ spatialModelType

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 185 of file psfMatch.py.

◆ subtractMeanForPca

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 241 of file psfMatch.py.

◆ useAfwBackground

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 133 of file psfMatch.py.

◆ useBicForKernelBasis

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

Definition at line 361 of file psfMatch.py.

◆ useCoreStats

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

Definition at line 299 of file psfMatch.py.

◆ usePcaForSpatialKernel

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

Definition at line 230 of file psfMatch.py.

◆ warpingConfig

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

Definition at line 126 of file psfMatch.py.


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