updateCatalogFootprints

lsst.meas.extensions.scarlet.updateCatalogFootprints(modelData: ScarletModelData, catalog: SourceCatalog, band: str, imageForResdistibution: MaskedImage | Exposure | None = None, removeScarletData: bool = True, updateFluxColumns: bool = True)

Use the scarlet models to set HeavyFootprints for modeled sources

Parameters:

catalog:

The catalog missing heavy footprints for deblended sources.

band:

The name of the band that the catalog data describes.

imageForResdistibution:

The image that is the source for flux re-distribution. If imageForResdistibution is None then flux re-distribution is not performed.

removeScarletData:

Whether or not to remove ScarletBlendData for each blend in order to save memory.

updateFluxColumns:

Whether or not to update the deblend_* columns in the catalog. This should only be true when the input catalog schema already contains those columns.