lsst.pipe.tasks g97f4eaa8b5+55e38086b4
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.warpAndPsfMatch.WarpAndPsfMatchTask Class Reference
Inheritance diagram for lsst.pipe.tasks.warpAndPsfMatch.WarpAndPsfMatchTask:

Public Member Functions

def __init__ (self, *args, **kwargs)
 
def run (self, exposure, wcs, modelPsf=None, maxBBox=None, destBBox=None, makeDirect=True, makePsfMatched=False)
 

Public Attributes

 warper
 

Static Public Attributes

 ConfigClass = WarpAndPsfMatchConfig
 

Detailed Description

A task to warp and PSF-match an exposure

Definition at line 46 of file warpAndPsfMatch.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.warpAndPsfMatch.WarpAndPsfMatchTask.__init__ (   self,
args,
**  kwargs 
)

Definition at line 51 of file warpAndPsfMatch.py.

Member Function Documentation

◆ run()

def lsst.pipe.tasks.warpAndPsfMatch.WarpAndPsfMatchTask.run (   self,
  exposure,
  wcs,
  modelPsf = None,
  maxBBox = None,
  destBBox = None,
  makeDirect = True,
  makePsfMatched = False 
)
Warp and optionally PSF-match exposure

Parameters
----------
exposure : :cpp:class: `lsst::afw::image::Exposure`
    Exposure to preprocess.
wcs : :cpp:class:`lsst::afw::image::Wcs`
    Desired WCS of temporary images.
modelPsf : :cpp:class: `lsst::meas::algorithms::KernelPsf` or None
    Target PSF to which to match.
maxBBox : :cpp:class:`lsst::afw::geom::Box2I` or None
    Maximum allowed parent bbox of warped exposure.
    If None then the warped exposure will be just big enough to contain all warped pixels;
    if provided then the warped exposure may be smaller, and so missing some warped pixels;
    ignored if destBBox is not None.
destBBox: :cpp:class: `lsst::afw::geom::Box2I` or None
    Exact parent bbox of warped exposure.
    If None then maxBBox is used to determine the bbox, otherwise maxBBox is ignored.
makeDirect : bool
    Return an exposure that has been only warped?
makePsfMatched : bool
    Return an exposure that has been warped and PSF-matched?

Returns
-------
An lsst.pipe.base.Struct with the following fields:

direct : :cpp:class:`lsst::afw::image::Exposure`
    warped exposure
psfMatched : :cpp:class: `lsst::afw::image::Exposure`
    warped and psf-Matched temporary exposure

Definition at line 56 of file warpAndPsfMatch.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.warpAndPsfMatch.WarpAndPsfMatchTask.ConfigClass = WarpAndPsfMatchConfig
static

Definition at line 49 of file warpAndPsfMatch.py.

◆ warper

lsst.pipe.tasks.warpAndPsfMatch.WarpAndPsfMatchTask.warper

Definition at line 54 of file warpAndPsfMatch.py.


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