lsst.meas.extensions.scarlet

lsst.meas.extensions.scarlet contains the pipeline task used to execute the scarlet deblending algorithm (Melchior et. al 2018).

Using lsst.meas.extensions.scarlet

• Deblending in the Science Pipelines
• Deblending a Catalog
• Working with scarlet-lite Models

Contributing

lsst.meas.extensions.scarlet is developed at https://github.com/lsst/meas_extensions_scarlet. You can find Jira issues for this module under the meas_extensions_scarlet component.

Python API reference

lsst.meas.extensions.scarlet Package

Functions

calculateFootprintCoverage(footprint, maskImage)	Calculate the fraction of pixels with no data in a Footprint Parameters ---------- footprint : lsst.afw.detection.Footprint The footprint to check for missing data. maskImage : lsst.afw.image.MaskX The mask image with the NO_DATA bit set. Returns ------- coverage : float The fraction of pixels in footprint where the NO_DATA bit is set.
deblend(mExposure, modelPsf, footprint, ...)	Deblend a parent footprint
monochromaticDataToScarlet(blendData, ...)	Convert the storage data model into a scarlet lite blend
oldScarletToData(blend, psfCenter, xy0)	Convert a scarlet.lite blend into a persistable data object
scarletModelToHeavy(source, blend[, useFlux])	Convert a scarlet_lite model to a HeavyFootprintF or MultibandFootprint.
setDeblenderMetrics(blend)	Set metrics that can be used to evalute the deblender accuracy
updateBlendRecords(blendData, catalog, ...)	Create footprints and update band-dependent columns in the catalog
updateCatalogFootprints(modelData, catalog, band)	Use the scarlet models to set HeavyFootprints for modeled sources

Classes

Blend(sources, observation)	A single blend.
Box(shape[, origin])	Bounding Box for an object
Box2I
Component(bands, bbox)	A base component in scarlet lite.
DeblenderMetrics(maxOverlap, fluxOverlap, ...)	Metrics and measurements made on single sources.
DeconvolveExposureConfig(*args, **kw)	Configuration for DeconvolveExposureTask
DeconvolveExposureConnections(*[, config])	Connections for DeconvolveExposureTask
DeconvolveExposureTask([initInputs])	Deconvolve an Exposure using scarlet lite.
Exposure(*args, **kwds)
Extent2I
FactorizedComponent(bands, spectrum, morph, bbox)	A component that can be factorized into spectrum and morphology parameters.
FixedParameter(x)	A parameter that is not updated
HeavyFootprintF
Image(data[, bands, yx0])	A numpy array with an origin and (optional) bands
MaskedImage(*args, **kwds)
Point2I
ScarletDeblendConfig(*args, **kw)	MultibandDeblendConfig
ScarletDeblendTask(schema[, peakSchema])	Split blended sources into individual sources.
Source(components)	A container for components associated with the same astrophysical object
SourceCatalog
Span
SpanSet
afwFootprint	alias of Footprint