Inheritance diagram for lsst.ip.diffim.getTemplate.GetCoaddAsTemplateTask:

Public Member Functions
def	run (self, exposure, sensorRef, templateIdList=None)

def	getCoaddDatasetName (self)

Static Public Attributes
	ConfigClass = GetCoaddAsTemplateConfig

Detailed Description

Subtask to retrieve coadd for use as an image difference template.

This is the default getTemplate Task to be run as a subtask by
``pipe.tasks.ImageDifferenceTask``. The main method is ``run()``.
It assumes that coadds reside in the repository given by sensorRef.

Definition at line 58 of file getTemplate.py.

Member Function Documentation

◆ getCoaddDatasetName()

def lsst.ip.diffim.getTemplate.GetCoaddAsTemplateTask.getCoaddDatasetName ( self )

Return coadd name for given task config

Returns
-------
CoaddDatasetName : `string`

TODO: This nearly duplicates a method in CoaddBaseTask (DM-11985)

Definition at line 185 of file getTemplate.py.

◆ run()

def lsst.ip.diffim.getTemplate.GetCoaddAsTemplateTask.run	(	self,
		exposure,
		sensorRef,
		templateIdList = `None`
	)

Retrieve and mosaic a template coadd exposure that overlaps the exposure

Parameters
----------
exposure: `lsst.afw.image.Exposure`
    an exposure for which to generate an overlapping template
sensorRef : TYPE
    a Butler data reference that can be used to obtain coadd data
templateIdList : TYPE, optional
    list of data ids (unused)

Returns
-------
result : `struct`
    return a pipeBase.Struct:

    - ``exposure`` : a template coadd exposure assembled out of patches
    - ``sources`` :  None for this subtask

Definition at line 69 of file getTemplate.py.

Member Data Documentation

◆ ConfigClass

lsst.ip.diffim.getTemplate.GetCoaddAsTemplateTask.ConfigClass = GetCoaddAsTemplateConfig

static

Definition at line 66 of file getTemplate.py.

The documentation for this class was generated from the following file:

python/lsst/ip/diffim/getTemplate.py