Base configuration for Psf-matching. More...

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

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 115 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 BackgroundConfig)

Definition at line 125 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.badMaskPlanes

static

Initial value:

 = pexConfig.ListField(
         dtype = str,
         doc = """Mask planes to ignore when calculating diffim statistics         Options: NO_DATA EDGE SAT BAD CR INTRP""",
         default = ("NO_DATA", "EDGE", "SAT")
     )

Definition at line 272 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.calculateKernelUncertainty

static

Initial value:

 = pexConfig.Field(
         dtype = bool,
         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.""",
         default = False,
     )

Definition at line 349 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.candidateCoreRadius

static

Initial value:

 = pexConfig.Field(
         dtype = int,
         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""",
         default = 3,
         check = lambda x : x >= 1
     )

Definition at line 300 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.candidateResidualMeanMax

static

Initial value:

 = pexConfig.Field(
         dtype = float,
         doc = """Rejects KernelCandidates yielding bad difference image quality.         Used by BuildSingleKernelVisitor, AssessSpatialKernelVisitor.         Represents average over pixels of (image/sqrt(variance)).""",
         default = 0.25,
         check = lambda x : x >= 0.0
     )

Definition at line 278 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.candidateResidualStdMax

static

Initial value:

 = pexConfig.Field(
         dtype = float,
         doc = """Rejects KernelCandidates yielding bad difference image quality.         Used by BuildSingleKernelVisitor, AssessSpatialKernelVisitor.         Represents stddev over pixels of (image/sqrt(variance)).""",
         default = 1.50,
         check = lambda x : x >= 0.0
     )

Definition at line 286 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.checkConditionNumber

static

Initial value:

 = pexConfig.Field(
         dtype = bool,
         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""",
         default = False,
     )

Definition at line 263 of file psfMatch.py.

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

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.constantVarianceWeighting

static

Initial value:

 = pexConfig.Field(
         dtype = bool,
         doc = """Use constant variance weighting in single kernel fitting?         In some cases this is better for bright star residuals.""",
         default = True,
     )

Definition at line 343 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 123 of file psfMatch.py.

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

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.iterateSingleKernel

static

Initial value:

 = pexConfig.Field(
         dtype = bool,
         doc = """Remake KernelCandidate using better variance estimate after first pass?         Primarily useful when convolving a single-depth image, otherwise not necessary.""",
         default = False,
     )

Definition at line 337 of file psfMatch.py.

tuple 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" : """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'""",
             "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"""
         }
     )

Definition at line 138 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSize

static

Initial value:

 = pexConfig.Field(
         dtype = int,
         doc = """Number of rows/columns in the convolution kernel; should be odd-valued.         Modified by kernelSizeFwhmScaling if scaleByFwhm = true""",
         default = 21,
     )

Definition at line 153 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSizeFwhmScaling

static

Initial value:

 = pexConfig.Field(
         dtype = float,
         doc = """How much to scale the kernel size based on the largest AL Sigma""",
         default = 6.0,
         check = lambda x : x >= 1.0
     )

Definition at line 164 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSizeMax

static

Initial value:

 = pexConfig.Field(
         dtype = int,
         doc = """Maximum Kernel Size""",
         default = 35,
     )

Definition at line 175 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.kernelSizeMin

static

Initial value:

 = pexConfig.Field(
         dtype = int,
         doc = """Minimum Kernel Size""",
         default = 21,
     )

Definition at line 170 of file psfMatch.py.

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

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

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.maxKsumSigma

static

Initial value:

 = pexConfig.Field(
         dtype = float,
         doc = """Maximum allowed sigma for outliers from kernel sum distribution.         Used to reject variable objects from the kernel model""",
         default = 3.0,
         check = lambda x : x >= 0.0
     )

Definition at line 309 of file psfMatch.py.

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

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

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

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.numPrincipalComponents

static

Initial value:

 = pexConfig.Field(
         dtype = int,
         doc = """Number of principal components to use for Pca basis, including the         mean kernel if requested.""",
         default = 5,
         check = lambda x : x >= 3
     )

Definition at line 241 of file psfMatch.py.

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

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

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

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

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

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

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

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

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

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

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.useBicForKernelBasis

static

Initial value:

 = pexConfig.Field(
         dtype = bool,
         doc = """Use Bayesian Information Criterion to select the number of bases going into the kernel""",
         default = False,
     )

Definition at line 356 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.useCoreStats

static

Initial value:

 = pexConfig.Field(
         dtype = bool,
         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""",
         default = False,
     )

Definition at line 294 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.PsfMatchConfig.usePcaForSpatialKernel

static

Initial value:

 = pexConfig.Field(
         dtype = bool,
         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.""",
         default = False,
     )

Definition at line 225 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 121 of file psfMatch.py.

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

/home/lsstsw/stack/Linux64/ip_diffim/11.0+1/python/lsst/ip/diffim/psfMatch.py

Static Public Attributes

Detailed Description

Member Data Documentation