lsst.ip.diffim  13.0-22-g3839dbb+8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions | Static Public Attributes | Static Private 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
 Retrieve and mosaic a template coadd exposure that overlaps the exposure. More...
 

Static Public Attributes

 ConfigClass = GetCoaddAsTemplateConfig
 

Static Private Attributes

string _DefaultName = "GetCoaddAsTemplateTask"
 

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 48 of file getTemplate.py.

Member Function Documentation

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 58 of file getTemplate.py.

Member Data Documentation

string lsst.ip.diffim.getTemplate.GetCoaddAsTemplateTask._DefaultName = "GetCoaddAsTemplateTask"
staticprivate

Definition at line 56 of file getTemplate.py.

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

Definition at line 55 of file getTemplate.py.


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