lsst.ip.diffim  13.0-26-g703d095+1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions | Static Public Attributes | Private Member Functions | List of all members
lsst.ip.diffim.zogy.ZogyImagePsfMatchTask Class Reference
Inheritance diagram for lsst.ip.diffim.zogy.ZogyImagePsfMatchTask:

Public Member Functions

def __init__
 
def subtractExposures
 
def subtractMaskedImages
 

Static Public Attributes

 ConfigClass = ZogyImagePsfMatchConfig
 

Private Member Functions

def _computeImageMean
 

Detailed Description

Task to perform Zogy PSF matching and image subtraction.

This class inherits from ImagePsfMatchTask to contain the _warper
subtask and related methods.

Definition at line 998 of file zogy.py.

Constructor & Destructor Documentation

def lsst.ip.diffim.zogy.ZogyImagePsfMatchTask.__init__ (   self,
  args,
  kwargs 
)

Definition at line 1007 of file zogy.py.

Member Function Documentation

def lsst.ip.diffim.zogy.ZogyImagePsfMatchTask._computeImageMean (   self,
  exposure 
)
private
Compute the sigma-clipped mean of the pixels image of `exposure`.

Definition at line 1010 of file zogy.py.

def lsst.ip.diffim.zogy.ZogyImagePsfMatchTask.subtractExposures (   self,
  templateExposure,
  scienceExposure,
  doWarping = True,
  spatiallyVarying = True,
  inImageSpace = False,
  doPreConvolve = False 
)
Register, PSF-match, and subtract two Exposures using the ZOGY algorithm.

Do the following, in order:
- Warp templateExposure to match scienceExposure, if their WCSs do not already match
- Compute subtracted exposure ZOGY image subtraction algorithm on the two exposures

Parameters
----------
templateExposure : `lsst.afw.image.Exposure`
    exposure to PSF-match to scienceExposure. The exposure's mean value is subtracted
    in-place.
scienceExposure : `lsst.afw.image.Exposure`
    reference Exposure. The exposure's mean value is subtracted in-place.
doWarping : `bool`
    what to do if templateExposure's and scienceExposure's WCSs do not match:
    - if True then warp templateExposure to match scienceExposure
    - if False then raise an Exception
spatiallyVarying : bool
    If True, perform the operation over a grid of patches across the two exposures
inImageSpace : `bool`
    If True, perform the Zogy convolutions in image space rather than in frequency space.
doPreConvolve : `bool`
    ***Currently not implemented.*** If True assume we are to compute the match filter-convolved
    exposure which can be thresholded for detection. In the case of Zogy this would mean
    we compute the Scorr image.

Returns
-------
A `lsst.pipe.base.Struct` containing these fields:
- subtractedExposure: subtracted Exposure
- warpedExposure: templateExposure after warping to match scienceExposure (if doWarping true)

Definition at line 1027 of file zogy.py.

def lsst.ip.diffim.zogy.ZogyImagePsfMatchTask.subtractMaskedImages (   self,
  templateExposure,
  scienceExposure,
  doWarping = True,
  spatiallyVarying = True,
  inImageSpace = False,
  doPreConvolve = False 
)

Definition at line 1134 of file zogy.py.

Member Data Documentation

lsst.ip.diffim.zogy.ZogyImagePsfMatchTask.ConfigClass = ZogyImagePsfMatchConfig
static

Definition at line 1005 of file zogy.py.


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