lsst.meas.deblender  13.0-12-g0251d74+8
 All Classes Namespaces Files Functions Variables Typedefs Groups
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

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

Detailed Description

Definition at line 37 of file deblend.py.

Member Data Documentation

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

Definition at line 60 of file deblend.py.

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

Definition at line 110 of file deblend.py.

tuple lsst.meas.deblender.deblend.SourceDeblendConfig.clipStrayFluxFraction
static
Initial value:
1 = pexConf.Field(dtype=float, default=0.001,
2  doc=('When splitting stray flux, clip fractions below '
3  'this value to zero.'))

Definition at line 77 of file deblend.py.

tuple lsst.meas.deblender.deblend.SourceDeblendConfig.edgeHandling
static
Initial value:
1 = pexConf.ChoiceField(
2  doc='What to do when a peak to be deblended is close to the edge of the image',
3  dtype=str, default='ramp',
4  allowed={
5  'clip': 'Clip the template at the edge AND the mirror of the edge.',
6  'ramp': 'Ramp down flux at the image edge by the PSF',
7  'noclip': 'Ignore the edge when building the symmetric template.',
8  }
9  )

Definition at line 39 of file deblend.py.

tuple lsst.meas.deblender.deblend.SourceDeblendConfig.maskLimits
static
Initial value:
1 = pexConf.DictField(
2  keytype=str,
3  itemtype=float,
4  default={},
5  doc=("Mask planes with the corresponding limit on the fraction of masked pixels. "
6  "Sources violating this limit will not be deblended."),
7  )

Definition at line 115 of file deblend.py.

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

Definition at line 113 of file deblend.py.

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

Definition at line 92 of file deblend.py.

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

Definition at line 95 of file deblend.py.

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

Definition at line 89 of file deblend.py.

tuple lsst.meas.deblender.deblend.SourceDeblendConfig.maxTempDotProd
static
Initial value:
1 = pexConf.Field(dtype=float, default=0.5,
2  doc=("If the dot product between two templates is larger than this value"
3  ", we consider them to be describing the same object (i.e. they are "
4  "degenerate). If one of the objects has been labeled as a PSF it "
5  "will be removed, otherwise the template with the lowest value will "
6  "be removed."))

Definition at line 127 of file deblend.py.

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

Definition at line 133 of file deblend.py.

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

Definition at line 98 of file deblend.py.

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

Definition at line 101 of file deblend.py.

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

Definition at line 108 of file deblend.py.

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

Definition at line 80 of file deblend.py.

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

Definition at line 83 of file deblend.py.

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

Definition at line 86 of file deblend.py.

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

Definition at line 125 of file deblend.py.

tuple lsst.meas.deblender.deblend.SourceDeblendConfig.strayFluxRule
static
Initial value:
1 = pexConf.ChoiceField(
2  doc='How to split flux among peaks',
3  dtype=str, default='trim',
4  allowed={
5  'r-to-peak': '~ 1/(1+R^2) to the peak',
6  'r-to-footprint': ('~ 1/(1+R^2) to the closest pixel in the footprint. '
7  'CAUTION: this can be computationally expensive on large footprints!'),
8  'nearest-footprint': ('Assign 100% to the nearest footprint (using L-1 norm aka '
9  'Manhattan distance)'),
10  'trim': ('Shrink the parent footprint to pixels that are not assigned to children')
11  }
12  )

Definition at line 64 of file deblend.py.

tuple lsst.meas.deblender.deblend.SourceDeblendConfig.strayFluxToPointSources
static
Initial value:
1 = pexConf.ChoiceField(
2  doc='When the deblender should attribute stray flux to point sources',
3  dtype=str, default='necessary',
4  allowed={
5  'necessary': 'When there is not an extended object in the footprint',
6  'always': 'Always',
7  'never': ('Never; stray flux will not be attributed to any deblended child '
8  'if the deblender thinks all peaks look like point sources'),
9  }
10  )

Definition at line 49 of file deblend.py.

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

Definition at line 104 of file deblend.py.

tuple lsst.meas.deblender.deblend.SourceDeblendConfig.weightTemplates
static
Initial value:
1 = pexConf.Field(dtype=bool, default=False,
2  doc=("If true, a least-squares fit of the templates will be done to the "
3  "full image. The templates will be re-weighted based on this fit."))

Definition at line 122 of file deblend.py.


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