lsst.ip.diffim  21.0.0-12-g5009899+33d7f927f3
Public Member Functions | Static Public 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)
 
def runDataRef (self, *args, **kwargs)
 
def runQuantum (self, **kwargs)
 

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. Only gen2 supported.

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

◆ runDataRef()

def lsst.ip.diffim.getTemplate.GetCalexpAsTemplateTask.runDataRef (   self,
args,
**  kwargs 
)

Definition at line 438 of file getTemplate.py.

◆ runQuantum()

def lsst.ip.diffim.getTemplate.GetCalexpAsTemplateTask.runQuantum (   self,
**  kwargs 
)

Definition at line 441 of file getTemplate.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 384 of file getTemplate.py.


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