LSSTApplications  19.0.0-13-g16625d3+11,20.0.0+1,20.0.0+22,20.0.0+23,20.0.0+25,20.0.0+28,20.0.0+3,20.0.0+4,20.0.0+5,20.0.0+7,20.0.0+8,20.0.0-1-g10df615+22,20.0.0-1-g253301a+6,20.0.0-1-g596936a+26,20.0.0-1-g8a53f90+2,20.0.0-1-gc96f8cb+27,20.0.0-1-gd1c87d7+2,20.0.0-1-gdb27ee5+6,20.0.0-11-gda4966f+10,20.0.0-13-g198ee8df,20.0.0-2-gec03fae+4,20.0.0-24-g0eb5a41+1,20.0.0-3-gd2e950e,20.0.0-4-g4a2362f,20.0.0-4-gde602ef96+5,20.0.0-4-ge48a6ca+21,20.0.0-5-gc4485221+1,20.0.0-6-g9bcb941+3,20.0.0-7-g3c4151b+3,20.0.0-7-gb92c176+1,w.2020.30
LSSTDataManagementBasePackage
Static Public Attributes | List of all members
lsst.meas.deblender.deblend.SourceDeblendConfig Class Reference
Inheritance diagram for lsst.meas.deblender.deblend.SourceDeblendConfig:

Static Public Attributes

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

Detailed Description

Definition at line 40 of file deblend.py.

Member Data Documentation

◆ assignStrayFlux

lsst.meas.deblender.deblend.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 63 of file deblend.py.

◆ catchFailures

lsst.meas.deblender.deblend.SourceDeblendConfig.catchFailures
static
Initial value:
= pexConfig.Field(
dtype=bool, default=False,
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 114 of file deblend.py.

◆ clipStrayFluxFraction

lsst.meas.deblender.deblend.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 80 of file deblend.py.

◆ edgeHandling

lsst.meas.deblender.deblend.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 42 of file deblend.py.

◆ maskLimits

lsst.meas.deblender.deblend.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 120 of file deblend.py.

◆ maskPlanes

lsst.meas.deblender.deblend.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 118 of file deblend.py.

◆ maxFootprintArea

lsst.meas.deblender.deblend.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 95 of file deblend.py.

◆ maxFootprintSize

lsst.meas.deblender.deblend.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 98 of file deblend.py.

◆ maxNumberOfPeaks

lsst.meas.deblender.deblend.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 92 of file deblend.py.

◆ maxTempDotProd

lsst.meas.deblender.deblend.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 133 of file deblend.py.

◆ medianSmoothTemplate

lsst.meas.deblender.deblend.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 139 of file deblend.py.

◆ minFootprintAxisRatio

lsst.meas.deblender.deblend.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 101 of file deblend.py.

◆ notDeblendedMask

lsst.meas.deblender.deblend.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 104 of file deblend.py.

◆ propagateAllPeaks

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

Definition at line 112 of file deblend.py.

◆ psfChisq1

lsst.meas.deblender.deblend.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 83 of file deblend.py.

◆ psfChisq2

lsst.meas.deblender.deblend.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 86 of file deblend.py.

◆ psfChisq2b

lsst.meas.deblender.deblend.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 89 of file deblend.py.

◆ removeDegenerateTemplates

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

Definition at line 131 of file deblend.py.

◆ strayFluxRule

lsst.meas.deblender.deblend.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 67 of file deblend.py.

◆ strayFluxToPointSources

lsst.meas.deblender.deblend.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 52 of file deblend.py.

◆ tinyFootprintSize

lsst.meas.deblender.deblend.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 107 of file deblend.py.

◆ weightTemplates

lsst.meas.deblender.deblend.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 127 of file deblend.py.


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