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

Public Member Functions
def	setDefaults (self)

Public Attributes
	kernelBasisSet

	maxConditionNumber

Static Public Attributes
	alardNGauss

	alardDegGauss

	alardSigGauss

	alardGaussBeta

	alardMinSig

	alardDegGaussDeconv

	alardMinSigDeconv

	alardNGaussDeconv

	warpingConfig

	detectionConfig

	afwBackgroundConfig

	useAfwBackground

	fitForBackground

	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

	conditionNumberType

	maxSpatialConditionNumber

	iterateSingleKernel

	constantVarianceWeighting

	calculateKernelUncertainty

	useBicForKernelBasis

Detailed Description

The parameters specific to the "Alard-Lupton" (sum-of-Gaussian) Psf-matching basis

Definition at line 369 of file psfMatch.py.

Member Function Documentation

◆ setDefaults()

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

Reimplemented in lsst.ip.diffim.snapPsfMatch.SnapPsfMatchConfigAL.

Definition at line 372 of file psfMatch.py.

     def setDefaults(self):
         PsfMatchConfig.setDefaults(self)
         self.kernelBasisSet = "alard-lupton"
         self.maxConditionNumber = 5.0e7
  

Member Data Documentation

◆ afwBackgroundConfig

lsst.ip.diffim.psfMatch.PsfMatchConfig.afwBackgroundConfig

staticinherited

Initial value:

= pexConfig.ConfigField("Controlling the Afw background fitting",

SubtractBackgroundConfig)

Definition at line 131 of file psfMatch.py.

◆ alardDegGauss

lsst.ip.diffim.psfMatch.PsfMatchConfigAL.alardDegGauss

static

Initial value:

=  pexConfig.ListField(
        dtype=int,
        doc="Polynomial order of spatial modification of base Gaussians. "
            "List length must be `alardNGauss`.",
        default=(4, 2, 2),
    )

Definition at line 383 of file psfMatch.py.

◆ alardDegGaussDeconv

lsst.ip.diffim.psfMatch.PsfMatchConfigAL.alardDegGaussDeconv

static

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc="Used if `scaleByFwhm==True`, degree of spatial modification of ALL base Gaussians "
            "in AL basis during deconvolution",
        default=3,
        check=lambda x: x >= 1
    )

Definition at line 408 of file psfMatch.py.

◆ alardGaussBeta

lsst.ip.diffim.psfMatch.PsfMatchConfigAL.alardGaussBeta

static

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc="Used if `scaleByFwhm==True`, scaling multiplier of base "
            "Gaussian sigmas for automated sigma determination",
        default=2.0,
        check=lambda x: x >= 0.0,
    )

Definition at line 395 of file psfMatch.py.

◆ alardMinSig

lsst.ip.diffim.psfMatch.PsfMatchConfigAL.alardMinSig

static

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc="Used if `scaleByFwhm==True`, minimum sigma (pixels) for base Gaussians",
        default=0.7,
        check=lambda x: x >= 0.25
    )

Definition at line 402 of file psfMatch.py.

◆ alardMinSigDeconv

lsst.ip.diffim.psfMatch.PsfMatchConfigAL.alardMinSigDeconv

static

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc="Used if `scaleByFwhm==True`, minimum sigma (pixels) for base Gaussians during deconvolution; "
            "make smaller than `alardMinSig` as this is only indirectly used",
        default=0.4,
        check=lambda x: x >= 0.25
    )

Definition at line 415 of file psfMatch.py.

◆ alardNGauss

lsst.ip.diffim.psfMatch.PsfMatchConfigAL.alardNGauss

static

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc="Number of base Gaussians in alard-lupton kernel basis function generation.",
        default=3,
        check=lambda x: x >= 1
    )

Definition at line 377 of file psfMatch.py.

◆ alardNGaussDeconv

lsst.ip.diffim.psfMatch.PsfMatchConfigAL.alardNGaussDeconv

static

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc="Used if `scaleByFwhm==True`, number of base Gaussians in AL basis during deconvolution",
        default=3,
        check=lambda x: x >= 1
    )

Definition at line 422 of file psfMatch.py.

◆ alardSigGauss

lsst.ip.diffim.psfMatch.PsfMatchConfigAL.alardSigGauss

static

Initial value:

=  pexConfig.ListField(
        dtype=float,
        doc="Default sigma values in pixels of base Gaussians. "
            "List length must be `alardNGauss`.",
        default=(0.7, 1.5, 3.0),
    )

Definition at line 389 of file psfMatch.py.

◆ badMaskPlanes

lsst.ip.diffim.psfMatch.PsfMatchConfig.badMaskPlanes

staticinherited

Initial value:

=  pexConfig.ListField(
        dtype=str,
        doc=,
        default=("NO_DATA", "EDGE", "SAT")
    )

Definition at line 278 of file psfMatch.py.

◆ calculateKernelUncertainty

lsst.ip.diffim.psfMatch.PsfMatchConfig.calculateKernelUncertainty

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc=,
        default=False,
    )

Definition at line 355 of file psfMatch.py.

◆ candidateCoreRadius

lsst.ip.diffim.psfMatch.PsfMatchConfig.candidateCoreRadius

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc=,
        default=3,
        check=lambda x: x >= 1
    )

Definition at line 306 of file psfMatch.py.

◆ candidateResidualMeanMax

lsst.ip.diffim.psfMatch.PsfMatchConfig.candidateResidualMeanMax

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc=,
        default=0.25,
        check=lambda x: x >= 0.0
    )

Definition at line 284 of file psfMatch.py.

◆ candidateResidualStdMax

lsst.ip.diffim.psfMatch.PsfMatchConfig.candidateResidualStdMax

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc=,
        default=1.50,
        check=lambda x: x >= 0.0
    )

Definition at line 292 of file psfMatch.py.

◆ checkConditionNumber

lsst.ip.diffim.psfMatch.PsfMatchConfig.checkConditionNumber

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc=,
        default=False,
    )

Definition at line 269 of file psfMatch.py.

◆ conditionNumberType

lsst.ip.diffim.psfMatch.PsfMatchConfig.conditionNumberType

staticinherited

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

◆ constantVarianceWeighting

lsst.ip.diffim.psfMatch.PsfMatchConfig.constantVarianceWeighting

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc=,
        default=True,
    )

Definition at line 349 of file psfMatch.py.

◆ detectionConfig

lsst.ip.diffim.psfMatch.PsfMatchConfig.detectionConfig

staticinherited

Initial value:

= pexConfig.ConfigField("Controlling the detection of sources for kernel building",

DetectionConfig)

Definition at line 129 of file psfMatch.py.

◆ fitForBackground

lsst.ip.diffim.psfMatch.PsfMatchConfig.fitForBackground

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc="Include terms (including kernel cross terms) for background in ip_diffim",
        default=False,
    )

Definition at line 139 of file psfMatch.py.

◆ iterateSingleKernel

lsst.ip.diffim.psfMatch.PsfMatchConfig.iterateSingleKernel

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc=,
        default=False,
    )

Definition at line 343 of file psfMatch.py.

◆ kernelBasisSet

lsst.ip.diffim.psfMatch.PsfMatchConfigAL.kernelBasisSet

Definition at line 374 of file psfMatch.py.

◆ kernelSize

lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSize

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc=,
        default=21,
    )

Definition at line 159 of file psfMatch.py.

◆ kernelSizeFwhmScaling

lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSizeFwhmScaling

staticinherited

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

◆ kernelSizeMax

lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSizeMax

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc="Maximum kernel bbox (pixel) size.",
        default=35,
    )

Definition at line 181 of file psfMatch.py.

◆ kernelSizeMin

lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSizeMin

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc="Minimum kernel bbox (pixel) size.",
        default=21,
    )

Definition at line 176 of file psfMatch.py.

◆ kernelSumClipping

lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSumClipping

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc="Do sigma clipping on the ensemble of kernel sums",
        default=True,
    )

Definition at line 259 of file psfMatch.py.

◆ maxConditionNumber

lsst.ip.diffim.psfMatch.PsfMatchConfigAL.maxConditionNumber

Definition at line 375 of file psfMatch.py.

◆ maxKsumSigma

lsst.ip.diffim.psfMatch.PsfMatchConfig.maxKsumSigma

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc=,
        default=3.0,
        check=lambda x: x >= 0.0
    )

Definition at line 315 of file psfMatch.py.

◆ maxSpatialConditionNumber

lsst.ip.diffim.psfMatch.PsfMatchConfig.maxSpatialConditionNumber

staticinherited

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

◆ maxSpatialIterations

lsst.ip.diffim.psfMatch.PsfMatchConfig.maxSpatialIterations

staticinherited

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

◆ nStarPerCell

lsst.ip.diffim.psfMatch.PsfMatchConfig.nStarPerCell

staticinherited

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

◆ numPrincipalComponents

lsst.ip.diffim.psfMatch.PsfMatchConfig.numPrincipalComponents

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc=,
        default=5,
        check=lambda x: x >= 3
    )

Definition at line 247 of file psfMatch.py.

◆ scaleByFwhm

lsst.ip.diffim.psfMatch.PsfMatchConfig.scaleByFwhm

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc="Scale kernelSize, alardGaussians by input Fwhm",
        default=True,
    )

Definition at line 165 of file psfMatch.py.

◆ singleKernelClipping

lsst.ip.diffim.psfMatch.PsfMatchConfig.singleKernelClipping

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc="Do sigma clipping on each raw kernel candidate",
        default=True,
    )

Definition at line 254 of file psfMatch.py.

◆ sizeCellX

lsst.ip.diffim.psfMatch.PsfMatchConfig.sizeCellX

staticinherited

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

◆ sizeCellY

lsst.ip.diffim.psfMatch.PsfMatchConfig.sizeCellY

staticinherited

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

◆ spatialBgOrder

lsst.ip.diffim.psfMatch.PsfMatchConfig.spatialBgOrder

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc="Spatial order of differential background variation",
        default=1,
        check=lambda x: x >= 0
    )

Definition at line 201 of file psfMatch.py.

◆ spatialKernelClipping

lsst.ip.diffim.psfMatch.PsfMatchConfig.spatialKernelClipping

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc="Do sigma clipping after building the spatial model",
        default=True,
    )

Definition at line 264 of file psfMatch.py.

◆ spatialKernelOrder

lsst.ip.diffim.psfMatch.PsfMatchConfig.spatialKernelOrder

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc="Spatial order of convolution kernel variation",
        default=2,
        check=lambda x: x >= 0
    )

Definition at line 195 of file psfMatch.py.

◆ spatialModelType

lsst.ip.diffim.psfMatch.PsfMatchConfig.spatialModelType

staticinherited

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

◆ subtractMeanForPca

lsst.ip.diffim.psfMatch.PsfMatchConfig.subtractMeanForPca

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc="Subtract off the mean feature before doing the Pca",
        default=True,
    )

Definition at line 242 of file psfMatch.py.

◆ useAfwBackground

lsst.ip.diffim.psfMatch.PsfMatchConfig.useAfwBackground

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc="Use afw background subtraction instead of ip_diffim",
        default=False,
    )

Definition at line 134 of file psfMatch.py.

◆ useBicForKernelBasis

lsst.ip.diffim.psfMatch.PsfMatchConfig.useBicForKernelBasis

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc=,
        default=False,
    )

Definition at line 362 of file psfMatch.py.

◆ useCoreStats

lsst.ip.diffim.psfMatch.PsfMatchConfig.useCoreStats

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc=,
        default=False,
    )

Definition at line 300 of file psfMatch.py.

◆ usePcaForSpatialKernel

lsst.ip.diffim.psfMatch.PsfMatchConfig.usePcaForSpatialKernel

staticinherited

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc=,
        default=False,
    )

Definition at line 231 of file psfMatch.py.

◆ warpingConfig

lsst.ip.diffim.psfMatch.PsfMatchConfig.warpingConfig

staticinherited

Initial value:

= pexConfig.ConfigField("Config for warping exposures to a common alignment",

afwMath.WarperConfig)

lsst::afw::math._warper.WarperConfig

Definition: _warper.py:65

Definition at line 127 of file psfMatch.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/ip_diffim/22.0.1-19-gb93eaa13+aab3ef7709/python/lsst/ip/diffim/psfMatch.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ setDefaults()

Member Data Documentation

◆ afwBackgroundConfig

◆ alardDegGauss

◆ alardDegGaussDeconv

◆ alardGaussBeta

◆ alardMinSig

◆ alardMinSigDeconv

◆ alardNGauss

◆ alardNGaussDeconv

◆ alardSigGauss

◆ badMaskPlanes

◆ calculateKernelUncertainty

◆ candidateCoreRadius

◆ candidateResidualMeanMax

◆ candidateResidualStdMax

◆ checkConditionNumber

◆ conditionNumberType

◆ constantVarianceWeighting

◆ detectionConfig

◆ fitForBackground

◆ iterateSingleKernel

◆ kernelBasisSet

◆ kernelSize

◆ kernelSizeFwhmScaling

◆ kernelSizeMax

◆ kernelSizeMin

◆ kernelSumClipping

◆ maxConditionNumber

◆ maxKsumSigma

◆ maxSpatialConditionNumber

◆ maxSpatialIterations

◆ nStarPerCell

◆ numPrincipalComponents

◆ scaleByFwhm

◆ singleKernelClipping

◆ sizeCellX

◆ sizeCellY

◆ spatialBgOrder

◆ spatialKernelClipping

◆ spatialKernelOrder

◆ spatialModelType

◆ subtractMeanForPca

◆ useAfwBackground

◆ useBicForKernelBasis

◆ useCoreStats

◆ usePcaForSpatialKernel

◆ warpingConfig