lsst.ip.diffim gaa63f70f4e+5e034ae04a
Loading...
Searching...
No Matches
Classes | Functions | Variables
lsst.ip.diffim.subtractImages Namespace Reference

Classes

class  AlardLuptonSubtractConfig
 
class  AlardLuptonSubtractConnections
 
class  AlardLuptonSubtractTask
 
class  SubtractImageOutputConnections
 
class  SubtractInputConnections
 

Functions

def checkTemplateIsSufficient (templateExposure, logger, requiredTemplateFraction=0.)
 
def _subtractImages (science, template, backgroundModel=None)
 

Variables

tuple _dimensions = ("instrument", "visit", "detector")
 
dict _defaultTemplates = {"coaddName": "deep", "fakesType": ""}
 

Function Documentation

◆ _subtractImages()

def lsst.ip.diffim.subtractImages._subtractImages (   science,
  template,
  backgroundModel = None 
)
protected
Subtract template from science, propagating relevant metadata.

Parameters
----------
science : `lsst.afw.Exposure`
    The input science image.
template : `lsst.afw.Exposure`
    The template to subtract from the science image.
backgroundModel : `lsst.afw.MaskedImage`, optional
    Differential background model

Returns
-------
difference : `lsst.afw.Exposure`
    The subtracted image.

Definition at line 527 of file subtractImages.py.

◆ checkTemplateIsSufficient()

def lsst.ip.diffim.subtractImages.checkTemplateIsSufficient (   templateExposure,
  logger,
  requiredTemplateFraction = 0. 
)
Raise NoWorkFound if template coverage < requiredTemplateFraction

Parameters
----------
templateExposure : `lsst.afw.image.ExposureF`
    The template exposure to check
logger : `lsst.log.Log`
    Logger for printing output.
requiredTemplateFraction : `float`, optional
    Fraction of pixels of the science image required to have coverage
    in the template.

Raises
------
lsst.pipe.base.NoWorkFound
    Raised if fraction of good pixels, defined as not having NO_DATA
    set, is less then the configured requiredTemplateFraction

Definition at line 492 of file subtractImages.py.

Variable Documentation

◆ _defaultTemplates

dict lsst.ip.diffim.subtractImages._defaultTemplates = {"coaddName": "deep", "fakesType": ""}
protected

Definition at line 37 of file subtractImages.py.

◆ _dimensions

tuple lsst.ip.diffim.subtractImages._dimensions = ("instrument", "visit", "detector")
protected

Definition at line 36 of file subtractImages.py.