ScarletDeblendConfig#

class lsst.meas.extensions.scarlet.ScarletDeblendConfig(*args, **kw)#

Bases: Config

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

Attributes Summary

`backgroundThresh`	Fraction of background to use for a sparsity threshold.
`badMask`	Whether or not to process isolated sources in the deblender (`List`, default `['BAD', 'NO_DATA', 'SAT', 'SUSPECT', 'EDGE']`)
`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.
`ciNumParentsToDeblend`	Only use the first `ciNumParentsToDeblend` parent footprints with a total peak count within `ciDebledChildRange`.
`columnInheritance`	Columns to pass from the parent to the child.
`convolutionType`	Type of convolution to render the model to the observations.
`fallback`	Whether or not to fallback to a smaller number of components if a source does not initialize (`bool`, default `True`)
`footprintSNRThresh`	Minimum SNR for a pixel to be detected in a footprint.
`growSize`	Number of pixels to grow the deconvolved footprints before final detection.
`initialBackgroundThresh`	Same as `backgroundThresh` but used only for source initialization.
`maskLimits`	Mask planes with the corresponding limit on the fraction of masked pixels.
`maxAreaTimesPeaks`	Maximum rectangular footprint area * nPeaks in the footprint.
`maxFootprintArea`	Maximum area for footprints before they are ignored as large; non-positive means no threshold applied (`int`, default `2000000`)
`maxFootprintSize`	Maximum linear dimension for footprints before they are ignored as large; non-positive means no threshold applied (`int`, default `0`)
`maxIter`	Maximum number of iterations to deblend a single parent (`int`, default `300`)
`maxNumberOfPeaks`	Only deblend the brightest maxNumberOfPeaks peaks in the parent (<= 0: unlimited) (`int`, default `600`)
`maxProxIter`	Maximum number of proximal operator iterations inside of each iteration of the optimizer.
`maxSpectrumCutoff`	Maximum number of pixels * number of sources in a blend.
`measureParents`	Whether to add parents to the object catalog for measurement in downstream tasks.
`minDeconvolvedArea`	Minimum area for a single footprint in the deconvolved image.
`minFootprintAxisRatio`	Minimum axis ratio for footprints before they are ignored as large; non-positive means no threshold applied (`float`, default `0.0`)
`minIter`	Minimum number of iterations before the optimizer is allowed to stop.
`minSNR`	Minimum Signal to noise to accept the source.Sources with lower flux will be initialized with the PSF but updated like an ordinary ExtendedSource (known in scarlet as a `CompactSource`).
`modelPsfSigma`	Define sigma for the model frame PSF (`float`, default `0.8`)
`modelPsfSize`	Model PSF side length in pixels (`int`, default `11`)
`morphImage`	The type of image to use for initializing the morphology.
`morphThresh`	Fraction of background RMS a pixel must haveto be included in the initial morphology (`float`, default `1`)
`notDeblendedMask`	Mask name for footprints not deblended, or None (`str`, default `'NOT_DEBLENDED'`)
`optimizer`	The optimizer to use for fitting parameters.
`persistIsolated`	Whether or not to persist isolated sources in the scarlet models (`bool`, default `True`)
`processSingles`	Whether or not to process isolated sources in the deblender (`bool`, default `False`)
`pseudoColumns`	Names of flags which should never be deblended.
`relativeError`	Change in the loss function between iterations to exit fitter.
`resizeFrequency`	Number of iterations between resizing sources.
`saveTemplates`	Whether or not to save the SEDs and templates (`bool`, default `True`)
`setSpectra`	Whether or not to solve for the best-fit spectra during initialization.
`sourceModel`	How to determine which model to use for sources, from - 'single': use a single component for all sources - 'double': use a bulge disk model for all sources - 'compact': use a single component model, initialzed with a point source morphology, for all sources - 'point': use a point-source model for all sources - 'fit: use a PSF fitting model to determine the number of components (not yet implemented) Deprecated: This field will be deprecated when the default for `version` is changed to `lite`.
`statsMask`	Mask planes to ignore when performing statistics (`List`, default `['SAT', 'INTRP', 'NO_DATA']`)
`useCiLimits`	Limit the number of sources deblended for CI to prevent long build times (`bool`, default `False`)
`useWeights`	Whether or not use use inverse variance weighting.If `useWeights` is `False` then flat weights are used (`bool`, default `True`)
`version`	The version of scarlet to use.
`waveletScales`	Number of wavelet scales to use for wavelet initialization.

Attributes Documentation

backgroundThresh#: Fraction of background to use for a sparsity threshold. This prevents sources from growing unrealistically outside the parent footprint while still modeling flux correctly for bright sources. (float, default 1.0)

badMask#: Whether or not to process isolated sources in the deblender (List, default ['BAD', 'NO_DATA', 'SAT', 'SUSPECT', 'EDGE'])

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 [5, 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)

columnInheritance#: Columns to pass from the parent to the child. This is no longer used since the object and parent catalogs contain different columns. Deprecated: This field is deprecated along with morphImage and will be removed after v30.0. (Dict, default {'deblend_nChild': 'deblend_parentNChild', 'deblend_nPeaks': 'deblend_parentNPeaks'})

convolutionType#: Type of convolution to render the model to the observations. - ‘fft’: perform convolutions in Fourier space - ‘real’: peform convolutions in real space. (str, default 'fft')

fallback#: Whether or not to fallback to a smaller number of components if a source does not initialize (bool, default True)

footprintSNRThresh#: Minimum SNR for a pixel to be detected in a footprint. (float, default 5.0)

growSize#: Number of pixels to grow the deconvolved footprints before final detection. (int, default 2)

initialBackgroundThresh#: Same as backgroundThresh but used only for source initialization. (float, default 1.0)

maskLimits#: Mask planes with the corresponding limit on the fraction of masked pixels. Sources violating this limit will not be deblended. If the fraction is 0 then the limit is a single pixel. (Dict, default {})

maxAreaTimesPeaks#: Maximum rectangular footprint area * nPeaks in the footprint. This was introduced in DM-33690 to prevent fields that are crowded or have a LSB galaxy that causes memory intensive initialization in scarlet from dominating the overall runtime and/or causing the task to run out of memory. (<= 0: unlimited) (int, default 1000000000)

maxFootprintArea#: Maximum area for footprints before they are ignored as large; non-positive means no threshold applied (int, default 2000000)

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

maxIter#: Maximum number of iterations to deblend a single parent (int, default 300)

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

maxProxIter#: Maximum number of proximal operator iterations inside of each iteration of the optimizer. This config field is only used if version=’lite’ and optimizer=’adaprox’. (int, default 1)

maxSpectrumCutoff#: Maximum number of pixels * number of sources in a blend. This is different than maxFootprintArea because this isn’t the footprint area but the area of the bounding box that contains the footprint, and is also multiplied by the number ofsources in the footprint. This prevents large skinny blends with a high density of sources from running out of memory. If maxSpectrumCutoff == -1 then there is no cutoff. (int, default 1000000)

measureParents#: Whether to add parents to the object catalog for measurement in downstream tasks. (bool, default False)

minDeconvolvedArea#: Minimum area for a single footprint in the deconvolved image. Detected footprints smaller than this will not be created. (int, default 9)

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

minIter#: Minimum number of iterations before the optimizer is allowed to stop. (int, default 5)

minSNR#: Minimum Signal to noise to accept the source.Sources with lower flux will be initialized with the PSF but updated like an ordinary ExtendedSource (known in scarlet as a CompactSource). (float, default 50)

modelPsfSigma#: Define sigma for the model frame PSF (float, default 0.8)

modelPsfSize#: Model PSF side length in pixels (int, default 11)

morphImage#

The type of image to use for initializing the morphology. Must be either ‘chi2’ or ‘wavelet’. Deprecated: This field is deprecated since testing has shown that only ‘chi2’ should be used and ‘wavelet’ has been broken since v27.0. This field will be removed in v29.0 (str, default 'chi2')

Allowed values:

'chi2': Initialize sources on a chi^2 image made from all available bands
'None': Field is optional

morphThresh#: Fraction of background RMS a pixel must haveto be included in the initial morphology (float, default 1)

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

optimizer#

The optimizer to use for fitting parameters. (str, default 'adaprox')

Allowed values:

'adaprox': Proximal ADAM optimization
'fista': Accelerated proximal gradient method
'None': Field is optional

persistIsolated#: Whether or not to persist isolated sources in the scarlet models (bool, default True)

processSingles#: Whether or not to process isolated sources in the deblender (bool, default False)

pseudoColumns#: Names of flags which should never be deblended. (List, default ['merge_peak_sky', 'sky_source'])

relativeError#: Change in the loss function between iterations to exit fitter. Typically this is 1e-3 if measurements will be made on the flux re-distributed models and 1e-4 when making measurements on the models themselves. (float, default 0.001)

resizeFrequency#: Number of iterations between resizing sources. (int, default 3)

saveTemplates#: Whether or not to save the SEDs and templates (bool, default True)

setSpectra#: Whether or not to solve for the best-fit spectra during initialization. This makes initialization slightly longer, as it requires a convolution to set the optimal spectra, but results in a much better initial log-likelihood and reduced total runtime, with convergence in fewer iterations.This option is only used when peaks*area < maxSpectrumCutoff will use the improved initialization. (bool, default True)

sourceModel#: How to determine which model to use for sources, from - ‘single’: use a single component for all sources - ‘double’: use a bulge disk model for all sources - ‘compact’: use a single component model, initialzed with a point source morphology, for all sources - ‘point’: use a point-source model for all sources - ‘fit: use a PSF fitting model to determine the number of components (not yet implemented) Deprecated: This field will be deprecated when the default for version is changed to lite. (str, default 'double')

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

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

useWeights#: Whether or not use use inverse variance weighting.If useWeights is False then flat weights are used (bool, default True)

version#

The version of scarlet to use. Deprecated: This field is deprecated since the ony available version is lite and will be removed after v29.0 (str, default 'lite')

Allowed values:

'lite': LSST optimized version of scarlet for survey data from a single instrument
'None': Field is optional

waveletScales#: Number of wavelet scales to use for wavelet initialization. This field is only used when version`='lite' and `morphImage`='wavelet'. Deprecated: This field is deprecated along with `morphImage and will be removed in v29.0. (int, default 5)