ScarletDeblendConfig

class lsst.meas.extensions.scarlet.ScarletDeblendConfig

Bases: lsst.pex.config.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

badMask

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

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 False)

exactLipschitz

Calculate exact Lipschitz constant in every step(True) or only calculate the approximateLipschitz constant with significant changes in A,S(False) (bool, default True)

history

maskLimits

Mask planes with the corresponding limit on the fraction of masked pixels.

maxFootprintArea

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

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 200)

maxNumberOfPeaks

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

minFootprintAxisRatio

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

monotonic

Make models monotonic (bool, default True)

notDeblendedMask

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

processSingles

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

propagateAllPeaks

Guarantee that all peaks produce a child source.

recenterPeriod

Number of iterations between recentering (int, default 5)

relativeError

Relative error to use when determining stopping criteria (float, default 0.01)

saveTemplates

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

sparse

Make models compact and sparse (bool, default True)

statsMask

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

storeHistory

Whether or not to store the history for each source (bool, default False)

symmetric

Make models symmetric (bool, default True)

symmetryThresh

Strictness of symmetry, from0 (no symmetry enforced) to1 (perfect symmetry required).If ‘S’ is not in constraints, this argument is ignored (float, default 1.0)

usePsfConvolution

Whether or not to convolve the morphology with thePSF in each band or use the same morphology in all bands (bool, default True)

useWeights

Use inverse variance as deblender weights (bool, default False)

Methods Summary

compare(other[, shortcut, rtol, atol, output])

Compare this configuration to another Config for equality.

formatHistory(name, **kwargs)

Format a configuration field’s history to a human-readable format.

freeze()

Make this config, and all subconfigs, read-only.

items()

Get configurations as (field name, field value) pairs.

iteritems()

Iterate over (field name, field value) pairs.

iterkeys()

Iterate over field names

itervalues()

Iterate over field values.

keys()

Get field names.

load(filename[, root])

Modify this config in place by executing the Python code in a configuration file.

loadFromStream(stream[, root, filename])

Modify this Config in place by executing the Python code in the provided stream.

names()

Get all the field names in the config, recursively.

save(filename[, root])

Save a Python script to the named file, which, when loaded, reproduces this config.

saveToStream(outfile[, root])

Save a configuration file to a stream, which, when loaded, reproduces this config.

setDefaults()

Subclass hook for computing defaults.

toDict()

Make a dictionary of field names and their values.

update(**kw)

Update values of fields specified by the keyword arguments.

validate()

Validate the Config, raising an exception if invalid.

values()

Get field values.

Attributes Documentation

badMask

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

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 False)

exactLipschitz

Calculate exact Lipschitz constant in every step(True) or only calculate the approximateLipschitz constant with significant changes in A,S(False) (bool, default True)

history
maskLimits

Mask planes with the corresponding limit on the fraction of masked pixels. Sources violating this limit will not be deblended. (Dict, default {})

maxFootprintArea

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

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 200)

maxNumberOfPeaks

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

minFootprintAxisRatio

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

monotonic

Make models monotonic (bool, default True)

notDeblendedMask

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

processSingles

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

propagateAllPeaks

Guarantee that all peaks produce a child source. (bool, default False)

recenterPeriod

Number of iterations between recentering (int, default 5)

relativeError

Relative error to use when determining stopping criteria (float, default 0.01)

saveTemplates

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

sparse

Make models compact and sparse (bool, default True)

statsMask

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

storeHistory

Whether or not to store the history for each source (bool, default False)

symmetric

Make models symmetric (bool, default True)

symmetryThresh

Strictness of symmetry, from0 (no symmetry enforced) to1 (perfect symmetry required).If ‘S’ is not in constraints, this argument is ignored (float, default 1.0)

usePsfConvolution

Whether or not to convolve the morphology with thePSF in each band or use the same morphology in all bands (bool, default True)

useWeights

Use inverse variance as deblender weights (bool, default False)

Methods Documentation

compare(other, shortcut=True, rtol=1e-08, atol=1e-08, output=None)

Compare this configuration to another Config for equality.

Parameters
otherlsst.pex.config.Config

Other Config object to compare against this config.

shortcutbool, optional

If True, return as soon as an inequality is found. Default is True.

rtolfloat, optional

Relative tolerance for floating point comparisons.

atolfloat, optional

Absolute tolerance for floating point comparisons.

outputcallable, optional

A callable that takes a string, used (possibly repeatedly) to report inequalities.

Returns
isEqualbool

True when the two lsst.pex.config.Config instances are equal. False if there is an inequality.

Notes

Unselected targets of RegistryField fields and unselected choices of ConfigChoiceField fields are not considered by this method.

Floating point comparisons are performed by numpy.allclose.

formatHistory(name, **kwargs)

Format a configuration field’s history to a human-readable format.

Parameters
namestr

Name of a Field in this config.

kwargs

Keyword arguments passed to lsst.pex.config.history.format.

Returns
historystr

A string containing the formatted history.

freeze()

Make this config, and all subconfigs, read-only.

items()

Get configurations as (field name, field value) pairs.

Returns
itemslist

List of tuples for each configuration. Tuple items are:

  1. Field name.

  2. Field value.

iteritems()

Iterate over (field name, field value) pairs.

Yields
itemtuple

Tuple items are:

  1. Field name.

  2. Field value.

iterkeys()

Iterate over field names

Yields
keystr

A field’s key (attribute name).

itervalues()

Iterate over field values.

Yields
valueobj

A field value.

keys()

Get field names.

Returns
nameslist

List of lsst.pex.config.Field names.

load(filename, root='config')

Modify this config in place by executing the Python code in a configuration file.

Parameters
filenamestr

Name of the configuration file. A configuration file is Python module.

rootstr, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

Deprecated: For backwards compatibility, older config files that use root="root" instead of root="config" will be loaded with a warning printed to sys.stderr. This feature will be removed at some point.

See also

lsst.pex.config.Config.loadFromStream, lsst.pex.config.Config.save, lsst.pex.config.Config.saveFromStream

loadFromStream(stream, root='config', filename=None)

Modify this Config in place by executing the Python code in the provided stream.

Parameters
streamfile-like object, str, or compiled string

Stream containing configuration override code.

rootstr, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

Deprecated: For backwards compatibility, older config files that use root="root" instead of root="config" will be loaded with a warning printed to sys.stderr. This feature will be removed at some point.

filenamestr, optional

Name of the configuration file, or None if unknown or contained in the stream. Used for error reporting.

See also

lsst.pex.config.Config.load, lsst.pex.config.Config.save, lsst.pex.config.Config.saveFromStream

names()

Get all the field names in the config, recursively.

Returns
nameslist of str

Field names.

save(filename, root='config')

Save a Python script to the named file, which, when loaded, reproduces this config.

Parameters
filenamestr

Desination filename of this configuration.

rootstr, optional

Name to use for the root config variable. The same value must be used when loading (see lsst.pex.config.Config.load).

saveToStream(outfile, root='config')

Save a configuration file to a stream, which, when loaded, reproduces this config.

Parameters
outfilefile-like object

Destination file object write the config into. Accepts strings not bytes.

root

Name to use for the root config variable. The same value must be used when loading (see lsst.pex.config.Config.load).

setDefaults()

Subclass hook for computing defaults.

Notes

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

toDict()

Make a dictionary of field names and their values.

Returns
dict_dict

Dictionary with keys that are Field names. Values are Field values.

Notes

This method uses the toDict method of individual fields. Subclasses of Field may need to implement a toDict method for this method to work.

update(**kw)

Update values of fields specified by the keyword arguments.

Parameters
kw

Keywords are configuration field names. Values are configuration field values.

Notes

The __at and __label keyword arguments are special internal keywords. They are used to strip out any internal steps from the history tracebacks of the config. Do not modify these keywords to subvert a Config instance’s history.

Examples

This is a config with three fields:

>>> from lsst.pex.config import Config, Field
>>> class DemoConfig(Config):
...     fieldA = Field(doc='Field A', dtype=int, default=42)
...     fieldB = Field(doc='Field B', dtype=bool, default=True)
...     fieldC = Field(doc='Field C', dtype=str, default='Hello world')
...
>>> config = DemoConfig()

These are the default values of each field:

>>> for name, value in config.iteritems():
...     print(f"{name}: {value}")
...
fieldA: 42
fieldB: True
fieldC: 'Hello world'

Using this method to update fieldA and fieldC:

>>> config.update(fieldA=13, fieldC='Updated!')

Now the values of each field are:

>>> for name, value in config.iteritems():
...     print(f"{name}: {value}")
...
fieldA: 13
fieldB: True
fieldC: 'Updated!'
validate()

Validate the Config, raising an exception if invalid.

Raises
lsst.pex.config.FieldValidationError

Raised if verification fails.

Notes

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.

values()

Get field values.

Returns
valueslist

List of field values.