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

emptyMetadata()	Empty (clear) the metadata for this Task and all sub-Tasks.
getFullMetadata()	Get metadata for all tasks.
getFullName()	Get the task name as a hierarchical name including parent task names.
getName()	Get the name of the task.
getTaskDict()	Get a dictionary of all tasks as a shallow copy.
makeField(doc)	Make a lsst.pex.config.ConfigurableField for this task.
makeSubtask(name, **keyArgs)	Create a subtask as a new instance as the name attribute of this task.
run(inputs, cellInfo, common)	Build a single-cell coadd.
timer(name[, logLevel])	Context manager to log performance data for an arbitrary block of code.

Attributes Documentation

registry = <abc.Registry object>

Methods Documentation

emptyMetadata() → None

Empty (clear) the metadata for this Task and all sub-Tasks.

getFullMetadata() → TaskMetadata

Get metadata for all tasks.

Returns:

metadataTaskMetadata

The keys are the full task name. Values are metadata for the top-level task and all subtasks, sub-subtasks, etc.

Notes

The returned metadata includes timing information (if @timer.timeMethod is used) and any metadata set by the task. The name of each item consists of the full task name with . replaced by :, followed by . and the name of the item, e.g.:

topLevelTaskName:subtaskName:subsubtaskName.itemName

using : in the full task name disambiguates the rare situation that a task has a subtask and a metadata item with the same name.

getFullName() → str

Get the task name as a hierarchical name including parent task names.

Returns:

fullNamestr

The full name consists of the name of the parent task and each subtask separated by periods. For example:

• The full name of top-level task “top” is simply “top”.

• The full name of subtask “sub” of top-level task “top” is “top.sub”.

• The full name of subtask “sub2” of subtask “sub” of top-level task “top” is “top.sub.sub2”.

getName() → str

Get the name of the task.

Returns:

taskNamestr

Name of the task.

See also

getFullName

Get the full name of the task.

getTaskDict() → dict[str, weakref.ReferenceType[lsst.pipe.base.task.Task]]

Get a dictionary of all tasks as a shallow copy.

Returns:

taskDictdict

Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.

classmethod makeField(doc: str) → ConfigurableField

Make a lsst.pex.config.ConfigurableField for this task.

Parameters:

docstr

Help text for the field.

Returns:

configurableFieldlsst.pex.config.ConfigurableField

A ConfigurableField for this task.

Examples

Provides a convenient way to specify this task is a subtask of another task.

Here is an example of use:

class OtherTaskConfig(lsst.pex.config.Config):
    aSubtask = ATaskClass.makeField("brief description of task")

makeSubtask(name: str, **keyArgs: Any) → None

Create a subtask as a new instance as the name attribute of this task.

Parameters:

namestr

Brief name of the subtask.

**keyArgs

Extra keyword arguments used to construct the task. The following arguments are automatically provided and cannot be overridden:

• config.

• parentTask.

Notes

The subtask must be defined by Task.config.name, an instance of ConfigurableField or RegistryField.

abstract run(inputs: Mapping[ObservationIdentifiers, tuple[lsst.daf.butler._deferredDatasetHandle.DeferredDatasetHandle, lsst.geom.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:

inputsMapping [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.

timer(name: str, logLevel: int = 10) → Iterator[None]

Context manager to log performance data for an arbitrary block of code.

Parameters:

namestr

Name of code being timed; data will be logged using item name: Start and End.

logLevelint

A logging level constant.

See also

lsst.utils.timer.logInfo

Implementation function.

Examples

Creating a timer context:

with self.timer("someCodeToTime"):
    pass  # code to time