lsst.ip.diffim g2959009a90+78a34153b8
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.ip.diffim.modelPsfMatch.ModelPsfMatchTask Class Reference
Inheritance diagram for lsst.ip.diffim.modelPsfMatch.ModelPsfMatchTask:
lsst.ip.diffim.psfMatch.PsfMatchTask

Public Member Functions

def __init__ (self, *args, **kwargs)
 
def run (self, exposure, referencePsfModel, kernelSum=1.0)
 

Public Attributes

 kConfig
 

Static Public Attributes

 ConfigClass = ModelPsfMatchConfig
 

Detailed Description

Matching of two model Psfs, and application of the Psf-matching kernel to an input Exposure

Definition at line 94 of file modelPsfMatch.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.ip.diffim.modelPsfMatch.ModelPsfMatchTask.__init__ (   self,
args,
**  kwargs 
)
Create a ModelPsfMatchTask

Parameters
----------
*args
    arguments to be passed to lsst.ip.diffim.PsfMatchTask.__init__
**kwargs
    keyword arguments to be passed to lsst.ip.diffim.PsfMatchTask.__init__

Notes
-----
Upon initialization, the kernel configuration is defined by self.config.kernel.active.  This Task
does have a run() method, which is the default way to call the Task.

Reimplemented from lsst.ip.diffim.psfMatch.PsfMatchTask.

Definition at line 100 of file modelPsfMatch.py.

Member Function Documentation

◆ run()

def lsst.ip.diffim.modelPsfMatch.ModelPsfMatchTask.run (   self,
  exposure,
  referencePsfModel,
  kernelSum = 1.0 
)
Psf-match an exposure to a model Psf

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure to Psf-match to the reference Psf model;
    it must return a valid PSF model via exposure.getPsf()
referencePsfModel : `lsst.afw.detection.Psf`
    The Psf model to match to
kernelSum : `float`, optional
    A multipicative factor to apply to the kernel sum (default=1.0)

Returns
-------
result : `struct`
    - ``psfMatchedExposure`` : the Psf-matched Exposure.
        This has the same parent bbox, Wcs, PhotoCalib and
        Filter as the input Exposure but no Psf.
        In theory the Psf should equal referencePsfModel but
        the match is likely not exact.
    - ``psfMatchingKernel`` : the spatially varying Psf-matching kernel
    - ``kernelCellSet`` : SpatialCellSet used to solve for the Psf-matching kernel
    - ``referencePsfModel`` : Validated and/or modified reference model used

Raises
------
RuntimeError
    if the Exposure does not contain a Psf model

Definition at line 119 of file modelPsfMatch.py.

Member Data Documentation

◆ ConfigClass

lsst.ip.diffim.modelPsfMatch.ModelPsfMatchTask.ConfigClass = ModelPsfMatchConfig
static

Definition at line 98 of file modelPsfMatch.py.

◆ kConfig

lsst.ip.diffim.modelPsfMatch.ModelPsfMatchTask.kConfig

Definition at line 116 of file modelPsfMatch.py.


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