lsst.meas.deblender g7212e027e3+0d06c7d750
Loading...
Searching...
No Matches
Static Public Attributes | List of all members
lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig Class Reference
Inheritance diagram for lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig:

Static Public Attributes

pexConfig edgeHandling
 
pexConfig strayFluxToPointSources
 
pexConfig assignStrayFlux
 
pexConfig strayFluxRule
 
pexConfig clipStrayFluxFraction
 
pexConfig psfChisq1
 
pexConfig psfChisq2
 
pexConfig psfChisq2b
 
pexConfig maxNumberOfPeaks
 
pexConfig maxFootprintArea
 
pexConfig maxFootprintSize
 
pexConfig minFootprintAxisRatio
 
pexConfig notDeblendedMask
 
pexConfig tinyFootprintSize
 
pexConfig propagateAllPeaks
 
pexConfig catchFailures
 
pexConfig maskPlanes
 
pexConfig maskLimits
 
pexConfig weightTemplates
 
pexConfig removeDegenerateTemplates
 
pexConfig maxTempDotProd
 
pexConfig medianSmoothTemplate
 
pexConfig useCiLimits
 
pexConfig ciDeblendChildRange
 
pexConfig ciNumParentsToDeblend
 

Detailed Description

Definition at line 38 of file sourceDeblendTask.py.

Member Data Documentation

◆ assignStrayFlux

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.assignStrayFlux
static
Initial value:
= pexConfig.Field(dtype=bool, default=True,
doc='Assign stray flux (not claimed by any child in the deblender) '
'to deblend children.')

Definition at line 61 of file sourceDeblendTask.py.

◆ catchFailures

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.catchFailures
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc=("If True, catch exceptions thrown by the deblender, log them, "
"and set a flag on the parent, instead of letting them propagate up."))

Definition at line 112 of file sourceDeblendTask.py.

◆ ciDeblendChildRange

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.ciDeblendChildRange
static
Initial value:
= pexConfig.ListField(
dtype=int, default=[2, 10],
doc="Only deblend parent Footprints with a number of peaks in the (inclusive) range indicated."
"If `useCiLimits==False` then this parameter is ignored.")

Definition at line 151 of file sourceDeblendTask.py.

◆ ciNumParentsToDeblend

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.ciNumParentsToDeblend
static
Initial value:
= pexConfig.Field(
dtype=int, default=10,
doc="Only use the first `ciNumParentsToDeblend` parent footprints with a total peak count "
"within `ciDebledChildRange`. "
"If `useCiLimits==False` then this parameter is ignored.")

Definition at line 155 of file sourceDeblendTask.py.

◆ clipStrayFluxFraction

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.clipStrayFluxFraction
static
Initial value:
= pexConfig.Field(dtype=float, default=0.001,
doc=('When splitting stray flux, clip fractions below '
'this value to zero.'))

Definition at line 78 of file sourceDeblendTask.py.

◆ edgeHandling

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.edgeHandling
static
Initial value:
= pexConfig.ChoiceField(
doc='What to do when a peak to be deblended is close to the edge of the image',
dtype=str, default='ramp',
allowed={
'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.',
}
)

Definition at line 40 of file sourceDeblendTask.py.

◆ maskLimits

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.maskLimits
static
Initial value:
= pexConfig.DictField(
keytype=str,
itemtype=float,
default={},
doc=("Mask planes with the corresponding limit on the fraction of masked pixels. "
"Sources violating this limit will not be deblended."),
)

Definition at line 119 of file sourceDeblendTask.py.

◆ maskPlanes

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.maskPlanes
static
Initial value:
= pexConfig.ListField(dtype=str, default=["SAT", "INTRP", "NO_DATA"],
doc="Mask planes to ignore when performing statistics")

Definition at line 117 of file sourceDeblendTask.py.

◆ maxFootprintArea

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.maxFootprintArea
static
Initial value:
= pexConfig.Field(dtype=int, default=1000000,
doc=("Maximum area for footprints before they are ignored as large; "
"non-positive means no threshold applied"))

Definition at line 93 of file sourceDeblendTask.py.

◆ maxFootprintSize

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.maxFootprintSize
static
Initial value:
= pexConfig.Field(dtype=int, default=0,
doc=("Maximum linear dimension for footprints before they are ignored "
"as large; non-positive means no threshold applied"))

Definition at line 96 of file sourceDeblendTask.py.

◆ maxNumberOfPeaks

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.maxNumberOfPeaks
static
Initial value:
= pexConfig.Field(dtype=int, default=0,
doc=("Only deblend the brightest maxNumberOfPeaks peaks in the parent"
" (<= 0: unlimited)"))

Definition at line 90 of file sourceDeblendTask.py.

◆ maxTempDotProd

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.maxTempDotProd
static
Initial value:
= pexConfig.Field(
dtype=float, default=0.5,
doc=("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."))

Definition at line 132 of file sourceDeblendTask.py.

◆ medianSmoothTemplate

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.medianSmoothTemplate
static
Initial value:
= pexConfig.Field(dtype=bool, default=True,
doc="Apply a smoothing filter to all of the template images")

Definition at line 138 of file sourceDeblendTask.py.

◆ minFootprintAxisRatio

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.minFootprintAxisRatio
static
Initial value:
= pexConfig.Field(dtype=float, default=0.0,
doc=("Minimum axis ratio for footprints before they are ignored "
"as large; non-positive means no threshold applied"))

Definition at line 99 of file sourceDeblendTask.py.

◆ notDeblendedMask

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.notDeblendedMask
static
Initial value:
= pexConfig.Field(dtype=str, default="NOT_DEBLENDED", optional=True,
doc="Mask name for footprints not deblended, or None")

Definition at line 102 of file sourceDeblendTask.py.

◆ propagateAllPeaks

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.propagateAllPeaks
static
Initial value:
= pexConfig.Field(dtype=bool, default=False,
doc=('Guarantee that all peaks produce a child source.'))

Definition at line 110 of file sourceDeblendTask.py.

◆ psfChisq1

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.psfChisq1
static
Initial value:
= pexConfig.Field(dtype=float, default=1.5, optional=False,
doc=('Chi-squared per DOF cut for deciding a source is '
'a PSF during deblending (un-shifted PSF model)'))

Definition at line 81 of file sourceDeblendTask.py.

◆ psfChisq2

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.psfChisq2
static
Initial value:
= pexConfig.Field(dtype=float, default=1.5, optional=False,
doc=('Chi-squared per DOF cut for deciding a source is '
'PSF during deblending (shifted PSF model)'))

Definition at line 84 of file sourceDeblendTask.py.

◆ psfChisq2b

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.psfChisq2b
static
Initial value:
= pexConfig.Field(dtype=float, default=1.5, optional=False,
doc=('Chi-squared per DOF cut for deciding a source is '
'a PSF during deblending (shifted PSF model #2)'))

Definition at line 87 of file sourceDeblendTask.py.

◆ removeDegenerateTemplates

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.removeDegenerateTemplates
static
Initial value:
= pexConfig.Field(dtype=bool, default=False,
doc=("Try to remove similar templates?"))

Definition at line 130 of file sourceDeblendTask.py.

◆ strayFluxRule

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.strayFluxRule
static
Initial value:
= pexConfig.ChoiceField(
doc='How to split flux among peaks',
dtype=str, default='trim',
allowed={
'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')
}
)

Definition at line 65 of file sourceDeblendTask.py.

◆ strayFluxToPointSources

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.strayFluxToPointSources
static
Initial value:
= pexConfig.ChoiceField(
doc='When the deblender should attribute stray flux to point sources',
dtype=str, default='necessary',
allowed={
'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'),
}
)

Definition at line 50 of file sourceDeblendTask.py.

◆ tinyFootprintSize

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.tinyFootprintSize
static
Initial value:
= pexConfig.RangeField(dtype=int, default=2, min=2, inclusiveMin=True,
doc=('Footprints smaller in width or height than this value '
'will be ignored; minimum of 2 due to PSF gradient '
'calculation.'))

Definition at line 105 of file sourceDeblendTask.py.

◆ useCiLimits

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.useCiLimits
static
Initial value:
= pexConfig.Field(
dtype=bool, default=False,
doc="Limit the number of sources deblended for CI to prevent long build times")

Definition at line 148 of file sourceDeblendTask.py.

◆ weightTemplates

pexConfig lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig.weightTemplates
static
Initial value:
= pexConfig.Field(
dtype=bool, default=False,
doc=("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."))

Definition at line 126 of file sourceDeblendTask.py.


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