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.

    def __init__(self, *args, **kwargs):
        pipeBase.Task.__init__(self, *args, **kwargs)
        self.makeSubtask("psfMatch")
        self.warper = afwMath.Warper.fromConfig(self.config.warp)
 

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.

            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
        """
        if makePsfMatched and modelPsf is None:
            raise RuntimeError("makePsfMatched=True, but no model PSF was provided")
 
        if not makePsfMatched and not makeDirect:
            self.log.warning("Neither makeDirect nor makePsfMatched requested")
 
        # Warp PSF before overwriting exposure
        xyTransform = afwGeom.makeWcsPairTransform(exposure.getWcs(), wcs)
        psfWarped = WarpedPsf(exposure.getPsf(), xyTransform)
 
        if makePsfMatched and maxBBox is not None:
            # grow warped region to provide sufficient area for PSF-matching
            pixToGrow = 2 * max(self.psfMatch.kConfig.sizeCellX,
                                self.psfMatch.kConfig.sizeCellY)
            # replace with copy
            maxBBox = geom.Box2I(maxBBox)
            maxBBox.grow(pixToGrow)
 
        with self.timer("warp"):
            exposure = self.warper.warpExposure(wcs, exposure, maxBBox=maxBBox, destBBox=destBBox)
            exposure.setPsf(psfWarped)
 
        if makePsfMatched:
            try:
                exposurePsfMatched = self.psfMatch.run(exposure, modelPsf).psfMatchedExposure
            except Exception as e:
                exposurePsfMatched = None
                self.log.info("Cannot PSF-Match: %s", e)
 
        return pipeBase.Struct(
            direct=exposure if makeDirect else None,
            psfMatched=exposurePsfMatched if makePsfMatched else None
        )

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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-172-gfb10e10a+18fedfabac/python/lsst/pipe/tasks/warpAndPsfMatch.py