Inheritance diagram for lsst.meas.deblender.deblend.MultibandDeblendConfig:
Static Public Attributes | |
| maxIter | |
| relativeError | |
| minTranslation | |
| refinementSkip | |
| translationMethod | |
| edgeFluxThresh | |
| exactLipschitz | |
| stepSlack | |
| constraints | |
| symmetryThresh | |
| l0Thresh | |
| l1Thresh | |
| tvxThresh | |
| tvyThresh | |
| useWeights = pexConfig.Field(dtype=bool, default=False, doc="Use inverse variance as deblender weights") | |
| bgScale | |
| usePsfConvolution | |
| saveTemplates | |
| processSingles | |
| badMask | |
| maxNumberOfPeaks | |
| maxFootprintArea | |
| maxFootprintSize | |
| minFootprintAxisRatio | |
| notDeblendedMask | |
| tinyFootprintSize | |
| catchFailures | |
| propagateAllPeaks | |
| maskPlanes | |
| maskLimits | |
| edgeHandling | |
| medianSmoothTemplate | |
| medianFilterHalfsize | |
| clipFootprintToNonzero | |
| conserveFlux | |
| weightTemplates | |
| strayFluxToPointSources | |
| assignStrayFlux | |
| strayFluxRule | |
| clipStrayFluxFraction | |
| getTemplateSum | |
Detailed Description
MultibandDeblendConfig Configuration for the multiband deblender. The parameters are organized by the parameter types, which are - Stopping Criteria: Used to determine if the fit has converged - Position Fitting Criteria: Used to fit the positions of the peaks - Constraints: Used to apply constraints to the peaks and their components - Other: Parameters that don't fit into the above categories
Definition at line 470 of file deblend.py.
Member Data Documentation
◆ 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 635 of file deblend.py.
◆ badMask
|
static |
Initial value:
= pexConfig.Field(
dtype=str, default="BAD,CR,NO_DATA,SAT,SUSPECT",
doc="Whether or not to process isolated sources in the deblender")
Definition at line 556 of file deblend.py.
◆ bgScale
|
static |
Initial value:
= pexConfig.Field(
dtype=float, default=0.5,
doc=("Fraction of background RMS level to use as a"
"cutoff for defining the background of the image"
"This is used to initialize the model for each source"
"and to set the size of the bounding box for each source"
"every `refinementSkip` iteration."))
Definition at line 539 of file deblend.py.
◆ 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 585 of file deblend.py.
◆ clipFootprintToNonzero
|
static |
Initial value:
= pexConfig.Field(dtype=bool, default=False,
doc=("Clip non-zero spans in the footprints"))
Definition at line 615 of file deblend.py.
◆ 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 652 of file deblend.py.
◆ conserveFlux
|
static |
Initial value:
= pexConfig.Field(dtype=bool, default=True,
doc=("Reapportion flux to the footprints so that flux is conserved"))
Definition at line 618 of file deblend.py.
◆ constraints
|
static |
Initial value:
= pexConfig.Field(dtype=str, default="1,+,S,M",
doc=("List of constraints to use for each object"
"(order does not matter)"
"Current options are all used by default:\n"
"S: symmetry\n"
"M: monotonicity\n"
"1: normalized SED to unity"
"+: non-negative morphology"))
Definition at line 513 of file deblend.py.
◆ edgeFluxThresh
|
static |
Initial value:
= pexConfig.Field(dtype=float, default=1.0,
doc=("Boxes are resized when the flux at an edge is "
"> edgeFluxThresh * background RMS"))
Definition at line 499 of file deblend.py.
◆ 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='noclip',
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 601 of file deblend.py.
◆ exactLipschitz
|
static |
Initial value:
= pexConfig.Field(dtype=bool, default=False,
doc=("Calculate exact Lipschitz constant in every step"
"(True) or only calculate the approximate"
"Lipschitz constant with significant changes in A,S"
"(False)"))
Definition at line 502 of file deblend.py.
◆ getTemplateSum
|
static |
Initial value:
= pexConfig.Field(dtype=bool, default=False,
doc=("As part of the flux calculation, the sum of the templates is"
"calculated. If 'getTemplateSum==True' then the sum of the"
"templates is stored in the result (a 'PerFootprint')."))
Definition at line 655 of file deblend.py.
◆ l0Thresh
|
static |
Initial value:
= pexConfig.Field(dtype=float, default=np.nan,
doc=("L0 threshold. NaN results in no L0 penalty."))
Definition at line 526 of file deblend.py.
◆ l1Thresh
|
static |
Initial value:
= pexConfig.Field(dtype=float, default=np.nan,
doc=("L1 threshold. NaN results in no L1 penalty."))
Definition at line 528 of file deblend.py.
◆ 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 593 of file deblend.py.
◆ maskPlanes
|
static |
Initial value:
= pexConfig.ListField(dtype=str, default=["SAT", "INTRP", "NO_DATA"],
doc="Mask planes to ignore when performing statistics")
Definition at line 591 of file deblend.py.
◆ 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 565 of file deblend.py.
◆ 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 569 of file deblend.py.
◆ maxIter
|
static |
Initial value:
= pexConfig.Field(dtype=int, default=200,
doc=("Maximum number of iterations to deblend a single parent"))
Definition at line 481 of file deblend.py.
◆ 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 561 of file deblend.py.
◆ medianFilterHalfsize
|
static |
Initial value:
= pexConfig.Field(dtype=float, default=2,
doc=('Half size of the median smoothing filter'))
Definition at line 613 of file deblend.py.
◆ medianSmoothTemplate
|
static |
Initial value:
= pexConfig.Field(dtype=bool, default=False,
doc="Apply a smoothing filter to all of the template images")
Definition at line 611 of file deblend.py.
◆ 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 573 of file deblend.py.
◆ minTranslation
|
static |
Initial value:
= pexConfig.Field(dtype=float, default=1e-3,
doc=("A peak must be updated by at least 'minTranslation' (pixels)"
"or no update is performed."
"This field is ignored if fitPositions is False."))
Definition at line 487 of file deblend.py.
◆ 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 577 of file deblend.py.
◆ processSingles
|
static |
Initial value:
= pexConfig.Field(
dtype=bool, default=False,
doc="Whether or not to process isolated sources in the deblender")
Definition at line 553 of file deblend.py.
◆ propagateAllPeaks
|
static |
Initial value:
= pexConfig.Field(dtype=bool, default=False,
doc=('Guarantee that all peaks produce a child source.'))
Definition at line 589 of file deblend.py.
◆ refinementSkip
|
static |
Initial value:
= pexConfig.Field(dtype=int, default=10,
doc=("If fitPositions is True, the positions and box sizes are"
"updated on every 'refinementSkip' iterations."))
Definition at line 491 of file deblend.py.
◆ relativeError
|
static |
Initial value:
= pexConfig.Field(dtype=float, default=1e-3,
doc=("Relative error to use when determining stopping criteria"))
Definition at line 483 of file deblend.py.
◆ saveTemplates
|
static |
Initial value:
= pexConfig.Field(
dtype=bool, default=True,
doc="Whether or not to save the SEDs and templates")
Definition at line 550 of file deblend.py.
◆ stepSlack
|
static |
Initial value:
= pexConfig.Field(dtype=float, default=0.2,
doc=("A fractional measure of how much a value (like the exactLipschitz)"
"can change before it needs to be recalculated."
"This must be between 0 and 1."))
Definition at line 507 of file deblend.py.
◆ 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 639 of file deblend.py.
◆ 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 624 of file deblend.py.
◆ symmetryThresh
|
static |
Initial value:
= pexConfig.Field(dtype=float, default=1.0,
doc=("Strictness of symmetry, from"
"0 (no symmetry enforced) to"
"1 (perfect symmetry required)."
"If 'S' is not in `constraints`, this argument is ignored"))
Definition at line 521 of file deblend.py.
◆ 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 581 of file deblend.py.
◆ translationMethod
|
static |
Initial value:
= pexConfig.Field(dtype=str, default="default",
doc=("Method to use for fitting translations."
"Currently 'default' is the only available option,"
"which performs a linear fit, but it is possible that we"
"will use galsim or some other method as a future option"))
Definition at line 494 of file deblend.py.
◆ tvxThresh
|
static |
Initial value:
= pexConfig.Field(dtype=float, default=np.nan,
doc=("Threshold for TV (total variation) constraint in the x-direction."
"NaN results in no TVx penalty."))
Definition at line 530 of file deblend.py.
◆ tvyThresh
|
static |
Initial value:
= pexConfig.Field(dtype=float, default=np.nan,
doc=("Threshold for TV (total variation) constraint in the y-direction."
"NaN results in no TVy penalty."))
Definition at line 533 of file deblend.py.
◆ usePsfConvolution
|
static |
Initial value:
= pexConfig.Field(
dtype=bool, default=True,
doc=("Whether or not to convolve the morphology with the"
"PSF in each band or use the same morphology in all bands"))
Definition at line 546 of file deblend.py.
◆ useWeights
|
static |
Definition at line 538 of file deblend.py.
◆ 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 620 of file deblend.py.
The documentation for this class was generated from the following file:
- python/lsst/meas/deblender/deblend.py
