lsst.ip.diffim  14.0-9-g330837b
Public Member Functions | Static Public Attributes | Static Private Attributes | List of all members
lsst.ip.diffim.getTemplate.GetCalexpAsTemplateTask Class Reference
Inheritance diagram for lsst.ip.diffim.getTemplate.GetCalexpAsTemplateTask:

Public Member Functions

def run (self, exposure, sensorRef, templateIdList)
 Return a calexp exposure with based on input sensorRef. More...
 

Static Public Attributes

 ConfigClass = GetCalexpAsTemplateConfig
 

Static Private Attributes

string _DefaultName = "GetCalexpAsTemplateTask"
 

Detailed Description

Subtask to retrieve calexp of the same ccd number as the science image SensorRef
for use as an image difference template.

To be run as a subtask by pipe.tasks.ImageDifferenceTask.
Intended for use with simulations and surveys that repeatedly visit the same pointing.
This code was originally part of Winter2013ImageDifferenceTask.

Definition at line 165 of file getTemplate.py.

Member Function Documentation

◆ run()

def lsst.ip.diffim.getTemplate.GetCalexpAsTemplateTask.run (   self,
  exposure,
  sensorRef,
  templateIdList 
)

Return a calexp exposure with based on input sensorRef.

Construct a dataId based on the sensorRef.dataId combined with the specifications from the first dataId in templateIdList

Parameters
[in]exposure– exposure (unused)
[in]sensorRef– a Butler data reference
[in]templateIdList– list of data ids, which should contain a single item. If there are multiple items, only the first is used.
Returns
a pipeBase.Struct
  • exposure: a template calexp
  • sources: source catalog measured on the template

Definition at line 177 of file getTemplate.py.

Member Data Documentation

◆ _DefaultName

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

Definition at line 175 of file getTemplate.py.

◆ ConfigClass

lsst.ip.diffim.getTemplate.GetCalexpAsTemplateTask.ConfigClass = GetCalexpAsTemplateConfig
static

Definition at line 174 of file getTemplate.py.


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