lsst.pipe.tasks  13.0-66-gfbf2f2ce+5
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.imageDifference.ImageDifferenceTask Class Reference
Inheritance diagram for lsst.pipe.tasks.imageDifference.ImageDifferenceTask:
lsst.pipe.tasks.imageDifference.Winter2013ImageDifferenceTask

Public Member Functions

def __init__ (self, butler=None, kwargs)
 Construct an ImageDifference Task. More...
 
def run (self, sensorRef, templateIdList=None)
 
def fitAstrometry (self, templateSources, templateExposure, selectSources)
 
def runDebug (self, exposure, subtractRes, selectSources, kernelSources, diaSources)
 
def getSchemaCatalogs (self)
 

Public Attributes

 schema
 
 algMetadata
 

Static Public Attributes

 ConfigClass = ImageDifferenceConfig
 
 RunnerClass = ImageDifferenceTaskRunner
 

Detailed Description

Subtract an image from a template and measure the result

Definition at line 216 of file imageDifference.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.imageDifference.ImageDifferenceTask.__init__ (   self,
  butler = None,
  kwargs 
)

Construct an ImageDifference Task.

Parameters
[in]butlerButler object to use in constructing reference object loaders

Definition at line 223 of file imageDifference.py.

Member Function Documentation

◆ fitAstrometry()

def lsst.pipe.tasks.imageDifference.ImageDifferenceTask.fitAstrometry (   self,
  templateSources,
  templateExposure,
  selectSources 
)
Fit the relative astrometry between templateSources and selectSources

@todo remove this method. It originally fit a new WCS to the template before calling register.run
because our TAN-SIP fitter behaved badly for points far from CRPIX, but that's been fixed.
It remains because a subtask overrides it.

Definition at line 682 of file imageDifference.py.

◆ getSchemaCatalogs()

def lsst.pipe.tasks.imageDifference.ImageDifferenceTask.getSchemaCatalogs (   self)
Return a dict of empty catalogs for each catalog dataset produced by this task.

Definition at line 775 of file imageDifference.py.

◆ run()

def lsst.pipe.tasks.imageDifference.ImageDifferenceTask.run (   self,
  sensorRef,
  templateIdList = None 
)
Subtract an image from a template coadd and measure the result

Steps include:
- warp template coadd to match WCS of image
- PSF match image to warped template
- subtract image from PSF-matched, warped template
- persist difference image
- detect sources
- measure sources

@param sensorRef: sensor-level butler data reference, used for the following data products:
Input only:
- calexp
- psf
- ccdExposureId
- ccdExposureId_bits
- self.config.coaddName + "Coadd_skyMap"
- self.config.coaddName + "Coadd"
Input or output, depending on config:
- self.config.coaddName + "Diff_subtractedExp"
Output, depending on config:
- self.config.coaddName + "Diff_matchedExp"
- self.config.coaddName + "Diff_src"

@return pipe_base Struct containing these fields:
- subtractedExposure: exposure after subtracting template;
    the unpersisted version if subtraction not run but detection run
    None if neither subtraction nor detection run (i.e. nothing useful done)
- subtractRes: results of subtraction task; None if subtraction not run
- sources: detected and possibly measured sources; None if detection not run

Definition at line 256 of file imageDifference.py.

◆ runDebug()

def lsst.pipe.tasks.imageDifference.ImageDifferenceTask.runDebug (   self,
  exposure,
  subtractRes,
  selectSources,
  kernelSources,
  diaSources 
)
@todo Test and update for current debug display and slot names

Definition at line 693 of file imageDifference.py.

Member Data Documentation

◆ algMetadata

lsst.pipe.tasks.imageDifference.ImageDifferenceTask.algMetadata

Definition at line 245 of file imageDifference.py.

◆ ConfigClass

lsst.pipe.tasks.imageDifference.ImageDifferenceTask.ConfigClass = ImageDifferenceConfig
static

Definition at line 219 of file imageDifference.py.

◆ RunnerClass

lsst.pipe.tasks.imageDifference.ImageDifferenceTask.RunnerClass = ImageDifferenceTaskRunner
static

Definition at line 220 of file imageDifference.py.

◆ schema

lsst.pipe.tasks.imageDifference.ImageDifferenceTask.schema

Definition at line 238 of file imageDifference.py.


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