lsst.ip.diffim.getTemplate.GetCalexpAsTemplateTask Class Reference

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

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

Static Public Attributes
	ConfigClass = GetCalexpAsTemplateConfig

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 203 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
----------
exposure :  `lsst.afw.image.Exposure`
    exposure (unused)
sensorRef : `list` of `lsst.daf.persistence.ButlerDataRef`
    Data reference of the calexp(s) to subtract from.
templateIdList : `list` of `lsst.daf.persistence.ButlerDataRef`
    Data reference of the template calexp to be subtraced.
    Can be incomplete, fields are initialized from `sensorRef`.
    If there are multiple items, only the first one is used.

Returns
-------
result : `struct`

    return a pipeBase.Struct:

- ``exposure`` : a template calexp
- ``sources`` : source catalog measured on the template

Definition at line 215 of file getTemplate.py.

Member Data Documentation

ConfigClass

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

static

Definition at line 212 of file getTemplate.py.

---

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

• python/lsst/ip/diffim/getTemplate.py