lsst.ip.diffim  13.0-19-g373a351+1
 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.imageDecorrelation.DecorrelateALKernelMapperSubtask Class Reference
Inheritance diagram for lsst.ip.diffim.imageDecorrelation.DecorrelateALKernelMapperSubtask:
lsst.ip.diffim.imageDecorrelation.DecorrelateALKernelTask

Public Member Functions

def __init__
 
def run
 
- Public Member Functions inherited from lsst.ip.diffim.imageDecorrelation.DecorrelateALKernelTask
def __init__
 Create the image decorrelation Task. More...
 
def computeVarianceMean
 
def run
 Perform decorrelation of an image difference exposure. More...
 

Static Public Attributes

 ConfigClass = DecorrelateALKernelConfig
 
- Static Public Attributes inherited from lsst.ip.diffim.imageDecorrelation.DecorrelateALKernelTask
 ConfigClass = DecorrelateALKernelConfig
 

Static Private Attributes

string _DefaultName = 'ip_diffim_decorrelateALKernelMapper'
 

Additional Inherited Members

- Static Public Member Functions inherited from lsst.ip.diffim.imageDecorrelation.DecorrelateALKernelTask
def computeCorrectedDiffimPsf
 Compute the (decorrelated) difference image's new PSF. More...
 
- Public Attributes inherited from lsst.ip.diffim.imageDecorrelation.DecorrelateALKernelTask
 statsControl
 

Detailed Description

Task to be used as an ImageMapperSubtask for performing
A&L decorrelation on subimages on a grid across a A&L difference image.

This task subclasses DecorrelateALKernelTask in order to implement
all of that task's configuration parameters, as well as its `run` method.

Definition at line 351 of file imageDecorrelation.py.

Constructor & Destructor Documentation

def lsst.ip.diffim.imageDecorrelation.DecorrelateALKernelMapperSubtask.__init__ (   self,
  args,
  kwargs 
)

Definition at line 361 of file imageDecorrelation.py.

Member Function Documentation

def lsst.ip.diffim.imageDecorrelation.DecorrelateALKernelMapperSubtask.run (   self,
  subExposure,
  expandedSubExposure,
  fullBBox,
  template,
  science,
  alTaskResult = None,
  psfMatchingKernel = None,
  preConvKernel = None,
  kwargs 
)
Perform decorrelation operation on `subExposure`, using
`expandedSubExposure` to allow for invalid edge pixels arising from
convolutions.

This method performs A&L decorrelation on `subExposure` using
local measures for image variances and PSF. `subExposure` is a
sub-exposure of the non-decorrelated A&L diffim. It also
requires the corresponding sub-exposures of the template
(`template`) and science (`science`) exposures.

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 : afwGeom.BoundingBox
    the bounding box of the original exposure
template : afw.Exposure
    the corresponding sub-exposure of the template exposure
science : afw.Exposure
    the corresponding sub-exposure of the science exposure
alTaskResult : pipeBase.Struct
    the result of A&L image differencing on `science` and
    `template`, importantly containing the resulting
    `psfMatchingKernel`. Can be `None`, only if
    `psfMatchingKernel` is not `None`.
psfMatchingKernel : Alternative parameter for passing the
    A&L `psfMatchingKernel` directly.
preConvKernel : If not None, then pre-filtering was applied
    to science exposure, and this is the pre-convolution
    kernel.
kwargs :
    additional keyword arguments propagated from
    `ImageMapReduceTask.run`.

Returns
-------
A `pipeBase.Struct` containing:
* `subExposure` : the result of the `subExposure` processing.
* `decorrelationKernel` : the decorrelation kernel, currently
  not used.

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 366 of file imageDecorrelation.py.

Member Data Documentation

string lsst.ip.diffim.imageDecorrelation.DecorrelateALKernelMapperSubtask._DefaultName = 'ip_diffim_decorrelateALKernelMapper'
staticprivate

Definition at line 359 of file imageDecorrelation.py.

lsst.ip.diffim.imageDecorrelation.DecorrelateALKernelMapperSubtask.ConfigClass = DecorrelateALKernelConfig
static

Definition at line 358 of file imageDecorrelation.py.


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