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

Public Member Functions

def __init__
 
def run
 
- Public Member Functions inherited from lsst.ip.diffim.zogy.ZogyTask
def __init__
 
def computePrereqs
 
def computeDiffimFourierSpace
 
def computeDiffimImageSpace
 
def computeDiffim
 
def computeDiffimPsf
 
def computeScorrFourierSpace
 
def computeScorrImageSpace
 
def computeScorr
 

Static Public Attributes

 ConfigClass = ZogyConfig
 
- Static Public Attributes inherited from lsst.ip.diffim.zogy.ZogyTask
 ConfigClass = ZogyConfig
 

Static Private Attributes

string _DefaultName = 'ip_diffim_ZogyMapper'
 

Additional Inherited Members

- Public Attributes inherited from lsst.ip.diffim.zogy.ZogyTask
 template
 
 science
 
 statsControl
 
 im1
 
 im2
 
 im1_var
 
 im2_var
 
 im1_psf
 
 im2_psf
 
 sig1
 
 sig2
 
 Fr
 
 Fn
 
 padSize
 

Detailed Description

Task to be used as an ImageMapperSubtask for performing
ZOGY image subtraction on a grid of subimages.

Definition at line 764 of file zogy.py.

Constructor & Destructor Documentation

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

Definition at line 771 of file zogy.py.

Member Function Documentation

def lsst.ip.diffim.zogy.ZogyMapperSubtask.run (   self,
  subExposure,
  expandedSubExposure,
  fullBBox,
  template,
  kwargs 
)
Perform ZOGY proper image subtraction on sub-images

This method performs ZOGY proper image subtraction on
`subExposure` using local measures for image variances and
PSF. `subExposure` is a sub-exposure of the science image. It
also requires the corresponding sub-exposures of the template
(`template`). The operations are actually performed on
`expandedSubExposure` to allow for invalid edge pixels arising
from convolutions, which are then removed.

Parameters
----------
subExposure : lsst.afw.image.Exposure
    the sub-exposure of the diffim
expandedSubExposure : lsst.afw.image.Exposure
    the expanded sub-exposure upon which to operate
fullBBox : lsst.afw.geom.BoundingBox
    the bounding box of the original exposure
template : lsst.afw.image.Exposure
    the template exposure, from which a corresponding sub-exposure
    is extracted
kwargs :
    additional keyword arguments propagated from
    `ImageMapReduceTask.run`. These include:
- doScorr : bool
      Compute and return the corrected likelihood image S_corr
      rather than the proper image difference
- inImageSpace : bool
      Perform all convolutions in real (image) space rather than
      in Fourier space. This option currently leads to artifacts
      when using real (measured and noisy) PSFs, thus it is set
      to `False` by default.
    These kwargs may also include arguments to be propagated to
    `ZogyTask.computeDiffim` and `ZogyTask.computeScorr`.

Returns
-------
A `lsst.pipe.base.Struct` containing the result of the
`subExposure` processing, labelled 'subExposure'. In this case
it is either the subExposure of the proper image difference D,
or (if `doScorr==True`) the corrected likelihood exposure `S`.

Notes
-----
This `run` method accepts parameters identical to those of
`ImageMapperSubtask.run`, since it is called from the
`ImageMapperTask`. See that class for more information.

Definition at line 775 of file zogy.py.

Member Data Documentation

string lsst.ip.diffim.zogy.ZogyMapperSubtask._DefaultName = 'ip_diffim_ZogyMapper'
staticprivate

Definition at line 769 of file zogy.py.

lsst.ip.diffim.zogy.ZogyMapperSubtask.ConfigClass = ZogyConfig
static

Definition at line 768 of file zogy.py.


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