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.
Empty (clear) the metadata for this Task and all sub-Tasks.
Get metadata for all tasks.
Get the task name as a hierarchical name including parent task names.
getName
()Get the name of the task.
Get a dictionary of all tasks as a shallow copy.
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:
- coaddInputs
lsst.afw.Image.CoaddInputs
A record of the observations that are included in the coadd.
- coaddTempExp
lsst.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.
- weight
Unknown
- coaddInputs
- Returns:
- inputVisitRecord
Unknown
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.
- inputVisitRecord
Notes
Note that the passed coaddTempExp may be a subimage, but that this method will only be called for the first subimage.
- getFullMetadata() TaskMetadata ¶
Get metadata for all tasks.
- Returns:
- metadata
TaskMetadata
The keys are the full task name. Values are metadata for the top-level task and all subtasks, sub-subtasks, etc.
- metadata
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:
- fullName
str
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”.
- fullName
- getName() str ¶
Get the name of the task.
- Returns:
- taskName
str
Name of the task.
- taskName
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:
- taskDict
dict
Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.
- taskDict
- 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:
- visitId
Unknown
- num
int
, optional Number of CCDs for this visit that overlap this patch (for reserving memory).
- visitId
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:
- doc
str
Help text for the field.
- doc
- Returns:
- configurableField
lsst.pex.config.ConfigurableField
A
ConfigurableField
for this task.
- configurableField
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:
- name
str
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
.
- name
Notes
The subtask must be defined by
Task.config.name
, an instance ofConfigurableField
orRegistryField
.