GetTemplateTask¶

class lsst.ip.diffim.GetTemplateTask(*args, **kwargs)¶

Bases: PipelineTask

Attributes Summary

canMultiprocess

Methods Summary

`checkHighVariance`(template)	Set a mask plane for regions with unusually high variance.
`emptyMetadata`()	Empty (clear) the metadata for this Task and all sub-Tasks.
`getExposures`(coaddExposureHandles, bbox, ...)	Return a data structure containing the coadds that overlap the specified bbox projected onto the sky, and a corresponding data structure of their dataIds.
`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`(*, coaddExposureHandles, bbox, wcs, ...)	Warp coadds from multiple tracts and patches to form a template to subtract from a science image.
`runQuantum`(butlerQC, inputRefs, outputRefs)	Do butler IO and transform to provide in memory objects for tasks `run` method.
`timer`(name[, logLevel])	Context manager to log performance data for an arbitrary block of code.

Attributes Documentation

canMultiprocess: ClassVar[bool] = True¶

Methods Documentation

checkHighVariance(template)¶

Set a mask plane for regions with unusually high variance.

Parameters:

templatelsst.afw.image.Exposure: The warped template exposure, which will be modified in place.

emptyMetadata() → None¶: Empty (clear) the metadata for this Task and all sub-Tasks.

getExposures(coaddExposureHandles, bbox, skymap, wcs)¶

Return a data structure containing the coadds that overlap the specified bbox projected onto the sky, and a corresponding data structure of their dataIds. These are the appropriate inputs to this task’s run method.

The spatial index in the butler registry has generous padding and often supplies patches near, but not directly overlapping the desired region. This method filters the inputs so that run does not have to read in all possibly-matching coadd exposures.

Parameters:

coaddExposureHandlesiterable [lsst.daf.butler.DeferredDatasetHandle of lsst.afw.image.Exposure]: Dataset handles to exposures that might overlap the desired region.
bboxlsst.geom.Box2I: Template bounding box of the pixel geometry onto which the coaddExposures will be resampled.
skymaplsst.skymap.SkyMap: Geometry of the tracts and patches the coadds are defined on.
wcslsst.afw.geom.SkyWcs: Template WCS onto which the coadds will be resampled.

Returns:

resultlsst.pipe.base.Struct

A struct with attributes:

coaddExposures: Dict of coadd exposures that overlap the projected bbox, indexed on tract id (dict [int, list [lsst.daf.butler.DeferredDatasetHandle of

lsst.afw.image.Exposure] ]).
dataIds: Dict of data IDs of the coadd exposures that overlap the projected bbox, indexed on tract id (dict [int, list [`lsst.daf.butler.DataCoordinate] ]).

Raises:

NoWorkFound: Raised if no patches overlap the input detector bbox, or the input WCS is None.

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.

run(*, coaddExposureHandles, bbox, wcs, dataIds, physical_filter)¶

Warp coadds from multiple tracts and patches to form a template to subtract from a science image.

Tract and patch overlap regions are combined by a variance-weighted average, and the variance planes are combined with the same weights, not added in quadrature; the overlap regions are not statistically independent, because they’re derived from the same original data. The PSF on the template is created by combining the CoaddPsf on each template image into a meta-CoaddPsf.

Parameters:

coaddExposureHandlesdict [int, list of [lsst.daf.butler.DeferredDatasetHandle of lsst.afw.image.Exposure]]: Coadds to be mosaicked, indexed on tract id.
bboxlsst.geom.Box2I: Template Bounding box of the detector geometry onto which to resample the coaddExposureHandles. Modified in-place to include the template border.
wcslsst.afw.geom.SkyWcs: Template WCS onto which to resample the coaddExposureHandles.
dataIdsdict [int, list [lsst.daf.butler.DataCoordinate]]: Record of the tract and patch of each coaddExposure, indexed on tract id.
physical_filterstr: Physical filter of the science image.

Returns:

resultlsst.pipe.base.Struct

A struct with attributes:

template: A template coadd exposure assembled out of patches (lsst.afw.image.ExposureF).

Raises:

NoWorkFound: If no coadds are found with sufficient un-masked pixels.

runQuantum(butlerQC, inputRefs, outputRefs)¶

Do butler IO and transform to provide in memory objects for tasks run method.

Parameters:

butlerQCQuantumContext: A butler which is specialized to operate in the context of a lsst.daf.butler.Quantum.
inputRefsInputQuantizedConnection: Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined input/prerequisite connections.
outputRefsOutputQuantizedConnection: Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined output connections.

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.

Navigation

GetTemplateTask¶