SourceDeblendConfig#

class lsst.meas.deblender.SourceDeblendConfig(*args, **kw)#

Bases: Config

Attributes Summary

`assignStrayFlux`	Assign stray flux (not claimed by any child in the deblender) to deblend children.
`catchFailures`	If True, catch exceptions thrown by the deblender, log them, and set a flag on the parent, instead of letting them propagate up.
`ciDeblendChildRange`	Only deblend parent Footprints with a number of peaks in the (inclusive) range indicated.If `useCiLimits==False` then this parameter is ignored.
`ciNumParentsToDeblend`	Only use the first `ciNumParentsToDeblend` parent footprints with a total peak count within `ciDebledChildRange`.
`clipStrayFluxFraction`	When splitting stray flux, clip fractions below this value to zero.
`edgeHandling`	What to do when a peak to be deblended is close to the edge of the image (`str`, default `'ramp'`)
`maskLimits`	Mask planes with the corresponding limit on the fraction of masked pixels.
`maskPlanes`	Mask planes to ignore when performing statistics (`List`, default `['SAT', 'INTRP', 'NO_DATA']`)
`maxFootprintArea`	Maximum area for footprints before they are ignored as large; non-positive means no threshold applied.
`maxFootprintSize`	Maximum linear dimension for footprints before they are ignored as large; non-positive means no threshold applied (`int`, default `0`)
`maxNumberOfPeaks`	Only deblend the brightest maxNumberOfPeaks peaks in the parent (<= 0: unlimited) (`int`, default `0`)
`maxTempDotProd`	If the dot product between two templates is larger than this value, we consider them to be describing the same object (i.e. they are degenerate).
`medianSmoothTemplate`	Apply a smoothing filter to all of the template images (`bool`, default `True`)
`minFootprintAxisRatio`	Minimum axis ratio for footprints before they are ignored as large; non-positive means no threshold applied (`float`, default `0.0`)
`notDeblendedMask`	Mask name for footprints not deblended, or None (`str`, default `'NOT_DEBLENDED'`)
`propagateAllPeaks`	Guarantee that all peaks produce a child source.
`psfChisq1`	Chi-squared per DOF cut for deciding a source is a PSF during deblending (un-shifted PSF model) (`float`, default `1.5`)
`psfChisq2`	Chi-squared per DOF cut for deciding a source is PSF during deblending (shifted PSF model) (`float`, default `1.5`)
`psfChisq2b`	Chi-squared per DOF cut for deciding a source is a PSF during deblending (shifted PSF model #2) (`float`, default `1.5`)
`removeDegenerateTemplates`	Try to remove similar templates? (`bool`, default `False`)
`strayFluxRule`	How to split flux among peaks (`str`, default `'trim'`)
`strayFluxToPointSources`	When the deblender should attribute stray flux to point sources (`str`, default `'necessary'`)
`tinyFootprintSize`	Footprints smaller in width or height than this value will be ignored; minimum of 2 due to PSF gradient calculation.
`useCiLimits`	Limit the number of sources deblended for CI to prevent long build times (`bool`, default `False`)
`weightTemplates`	If true, a least-squares fit of the templates will be done to the full image.

Attributes Documentation

assignStrayFlux#: Assign stray flux (not claimed by any child in the deblender) to deblend children. (bool, default True)

catchFailures#: If True, catch exceptions thrown by the deblender, log them, and set a flag on the parent, instead of letting them propagate up. (bool, default True)

ciDeblendChildRange#: Only deblend parent Footprints with a number of peaks in the (inclusive) range indicated.If useCiLimits==False then this parameter is ignored. (List, default [2, 10])

ciNumParentsToDeblend#: Only use the first ciNumParentsToDeblend parent footprints with a total peak count within ciDebledChildRange. If useCiLimits==False then this parameter is ignored. (int, default 10)

clipStrayFluxFraction#: When splitting stray flux, clip fractions below this value to zero. (float, default 0.001)

edgeHandling#

What to do when a peak to be deblended is close to the edge of the image (str, default 'ramp')

Allowed values:

'clip': Clip the template at the edge AND the mirror of the edge.
'ramp': Ramp down flux at the image edge by the PSF
'noclip': Ignore the edge when building the symmetric template.
'None': Field is optional

maskLimits#: Mask planes with the corresponding limit on the fraction of masked pixels. Sources violating this limit will not be deblended. Default rejects sources in vignetted regions. (Dict, default {'NO_DATA': 0.25})

maskPlanes#: Mask planes to ignore when performing statistics (List, default ['SAT', 'INTRP', 'NO_DATA'])

maxFootprintArea#: Maximum area for footprints before they are ignored as large; non-positive means no threshold applied. Default value is to prevent excessive memory usage. (int, default 10000)

maxFootprintSize#: Maximum linear dimension for footprints before they are ignored as large; non-positive means no threshold applied (int, default 0)

maxNumberOfPeaks#: Only deblend the brightest maxNumberOfPeaks peaks in the parent (<= 0: unlimited) (int, default 0)

maxTempDotProd#: If the dot product between two templates is larger than this value, we consider them to be describing the same object (i.e. they are degenerate). If one of the objects has been labeled as a PSF it will be removed, otherwise the template with the lowest value will be removed. (float, default 0.5)

medianSmoothTemplate#: Apply a smoothing filter to all of the template images (bool, default True)

minFootprintAxisRatio#: Minimum axis ratio for footprints before they are ignored as large; non-positive means no threshold applied (float, default 0.0)

notDeblendedMask#: Mask name for footprints not deblended, or None (str, default 'NOT_DEBLENDED')

propagateAllPeaks#: Guarantee that all peaks produce a child source. (bool, default False)

psfChisq1#: Chi-squared per DOF cut for deciding a source is a PSF during deblending (un-shifted PSF model) (float, default 1.5)

psfChisq2#: Chi-squared per DOF cut for deciding a source is PSF during deblending (shifted PSF model) (float, default 1.5)

psfChisq2b#: Chi-squared per DOF cut for deciding a source is a PSF during deblending (shifted PSF model #2) (float, default 1.5)

removeDegenerateTemplates#: Try to remove similar templates? (bool, default False)

strayFluxRule#

How to split flux among peaks (str, default 'trim')

Allowed values:

'r-to-peak': ~ 1/(1+R^2) to the peak
'r-to-footprint': ~ 1/(1+R^2) to the closest pixel in the footprint. CAUTION: this can be computationally expensive on large footprints!
'nearest-footprint': Assign 100% to the nearest footprint (using L-1 norm aka Manhattan distance)
'trim': Shrink the parent footprint to pixels that are not assigned to children
'None': Field is optional

strayFluxToPointSources#

When the deblender should attribute stray flux to point sources (str, default 'necessary')

Allowed values:

'necessary': When there is not an extended object in the footprint
'always': Always
'never': Never; stray flux will not be attributed to any deblended child if the deblender thinks all peaks look like point sources
'None': Field is optional

tinyFootprintSize#

Footprints smaller in width or height than this value will be ignored; minimum of 2 due to PSF gradient calculation. (int, default 2)

Valid Range = [2,inf)

useCiLimits#: Limit the number of sources deblended for CI to prevent long build times (bool, default False)

weightTemplates#: If true, a least-squares fit of the templates will be done to the full image. The templates will be re-weighted based on this fit. (bool, default False)