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

buildMonochromaticObservation(modelPsf, ...)	Create a single-band observation for the entire image
build_scarlet_model(zip_dict)	Build a ScarletModelData instance from a dictionary of files.
calculateFootprintCoverage(footprint, maskImage)	Calculate the fraction of pixels with no data in a Footprint
cast(typ, val)	Cast a value to a type.
deblend(context, footprint, config[, ...])	Deblend a parent footprint
from_json(data, *[, allow_inf_nan, ...])
loadBlend(blendData, model_psf, mCoadd)	Load a blend from the persisted data
monochromaticDataToScarlet(blendData, ...)	Convert the storage data model into a scarlet lite blend
read_scarlet_model(path_or_stream[, blend_ids])	Read a zip file and return a ScarletModelData instance.
scarletModelToHeavy(source, blend[, useFlux])	Convert a scarlet_lite model to a HeavyFootprintF or MultibandFootprint.
scarlet_model_to_zip_json(model_data)	Convert a ScarletModelData instance to a dictionary of files.
setDeblenderMetrics(blend)	Set metrics that can be used to evalute the deblender accuracy
updateBlendRecords(modelData, bandIndex, ...)	Create footprints and update band-dependent columns in the catalog
updateCatalogFootprints(modelData, catalog, band)	Use the scarlet models to set HeavyFootprints for modeled sources
write_scarlet_model(path_or_stream, model_data)	Write a ScarletModelData instance to a zip file.

Classes

Any(*args, **kwargs)	Special type indicating an unconstrained type.
BinaryIO()	Typed version of the return of open() in binary mode.
Box(shape[, origin])	Bounding Box for an object
Box2I
BytesIO([initial_bytes])	Buffered I/O implementation using an in-memory bytes buffer.
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
FormatterV2(file_descriptor, *, ref[, ...])	Interface for reading and writing datasets using URIs.
HeavyFootprintF
Mapping()	A Mapping is a generic container for associating key/value pairs.
MaskX
MaskedImage(*args, **kwds)
MultibandExposure(bands, image, mask, variance)	MultibandExposure class
Point2I
ResourceHandleProtocol(*args, **kwargs)	Defines the interface protocol that is compatible with children of BaseResourceHandle.
ScarletDeblendConfig(*args, **kw)	MultibandDeblendConfig
ScarletDeblendContext(*, monotonicity, ...)	Context with parameters and config options for deblending
ScarletDeblendTask(schema[, peakSchema])	Split blended sources into individual sources.
ScarletModelDelegate(storageClass)	Delegate to extract a blend from an in-memory ScarletModelData object.
ScarletModelFormatter(file_descriptor, *, ref)	Read and write scarlet models.
SourceCatalog
SourceRecord
Span
SpanSet
StorageClassDelegate(storageClass)	Delegate class for StorageClass components and parameters.
afwFootprint	alias of Footprint