lsst.ip.diffim  16.0-17-g31abd91+7
Public Member Functions | Static Public Attributes | List of all members
lsst.ip.diffim.getTemplate.GetCoaddAsTemplateTask Class Reference
Inheritance diagram for lsst.ip.diffim.getTemplate.GetCoaddAsTemplateTask:

Public Member Functions

def run (self, exposure, sensorRef, templateIdList=None)
 Retrieve and mosaic a template coadd exposure that overlaps the exposure. More...
 
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 160 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
[in]exposure– an exposure for which to generate an overlapping template
[in]sensorRef– a Butler data reference that can be used to obtain coadd data
[in]templateIdList– list of data ids (unused)
Returns
a pipeBase.Struct
  • exposure: a template coadd exposure assembled out of patches
  • sources: None for this subtask

Definition at line 68 of file getTemplate.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 65 of file getTemplate.py.


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