CoaddInputRecorderTask

class lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask(*args, **kwargs)

Bases: Task

Subtask that handles filling a CoaddInputs object for a coadd exposure, tracking the CCDs and visits that went into a coadd.

The interface here is a little messy, but I think this is at least partly a product of a bit of messiness in the coadd code it’s plugged into. I hope #2590 might result in a better design.

Methods Summary

addVisitToCoadd(coaddInputs, coaddTempExp, ...)	Called by AssembleCoaddTask when adding (a subset of) a coaddTempExp to a coadd.
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.
makeCoaddInputs()	Create a CoaddInputs object with schemas defined by the task configuration.
makeCoaddTempExpRecorder(visitId[, num])	Return a CoaddTempExpInputRecorder instance to help with saving a CoaddTempExp's inputs.
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.
timer(name[, logLevel])	Context manager to log performance data for an arbitrary block of code.

Methods Documentation

addVisitToCoadd(coaddInputs, coaddTempExp, weight)

Called by AssembleCoaddTask when adding (a subset of) a coaddTempExp to a coadd. The base class impementation extracts the CoaddInputs from the coaddTempExp and appends them to the given coaddInputs, filling in the weight column(s).

Parameters:

coaddInputslsst.afw.Image.CoaddInputs

A record of the observations that are included in the coadd.

coaddTempExplsst.afw.image.Exposure

Exposure object from which to obtain the PSF, WCS, and bounding box for the entry in the ‘visits’ table. On return, the completed CoaddInputs object will be attached to it.

weightUnknown

Returns:

inputVisitRecordUnknown

The record for the visit to allow subclasses to fill in additional fields or None if the inputRecorder catalogs for the coaddTempExp are not usable.

Notes

Note that the passed coaddTempExp may be a subimage, but that this method will only be called for the first subimage.

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

getTaskDict() → Dict[str, ReferenceType[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.

makeCoaddInputs()

Create a CoaddInputs object with schemas defined by the task configuration.

makeCoaddTempExpRecorder(visitId, num=0)

Return a CoaddTempExpInputRecorder instance to help with saving a CoaddTempExp’s inputs.

Parameters:

visitIdUnknown

numint, optional

Number of CCDs for this visit that overlap this patch (for reserving memory).

Notes

The visitId may be any number that is unique for each :that goes into a coadd, but ideally should be something more meaningful that can be used to reconstruct a data ID.

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.

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.

logLevel

A logging level constant.

See also

timer.logInfo

Examples

Creating a timer context:

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