SingleCellCoaddBuilderTask

class lsst.cell_coadds.SingleCellCoaddBuilderTask(config: Config | None = None, *, name: str | None = None, parentTask: Task | None = None, log: logging.Logger | lsst.utils.logging.LsstLogAdapter | None = None)

Bases: Task

An abstract interface for tasks building coadds in cells.

SingleCellCoaddBuilderTask is intended to serve as an abstract interface for various concrete implementation of coaddition algorithms via its run method. MultipleCellCoaddBuilderTask is the corresponding pipeline task that needs to be called from the pipeline. MultipleCellCoaddBuilderTask must contain a concrete implementation inherited from SingleCellCoaddBuilderTask as its base class and registered with the singleCellCoaddBuilderTaskRegistry, say using @registerConfigurable decorator.

See Also

MultipleCellCoaddBuilderTask

Attributes Summary

registry

Methods Summary

run(inputs, cellInfo, common)

Build a single-cell coadd.

Attributes Documentation

registry = <abc.Registry object>

Methods Documentation

abstract run(inputs: Mapping[ObservationIdentifiers, tuple[DeferredDatasetHandle, Box2I]], cellInfo: CellInfo, common: CommonComponents) → SingleCellCoadd

Build a single-cell coadd.

The images passed in from MultipleCellCoaddBuilderTask are guaranteed to completely overlap the outer bounding box of the cells. Any further exclusion of images based on quality assessment or other criteria should be dome in this method.

Parameters

inputs : Mapping [ObservationIdentifiers, tuple [DeferredDatasetHandle, Box2I]]

A mapping from ObservationIdentifiers to a tuple containing a DeferredDatasetHandle pointing to the input image (calexp or warps) and a minimal bounding box that can be read without loading the entire image.

cellInfoCellInfo

An object with the following attributes: - wcs: lsst.afw.geom.SkyWcs - outer_bbox: lsst.geom.Box2I

commonCommonComponents

A dataclass object with properties that are common to the entire MultipleCellCoadd object that the cell produced is a part of.

Returns

single_cell_coaddSingleCellCoadd

A single cell coadd.