lsst.afw g5a732f18d5+53520f316c
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
lsst.afw.math._warper.Warper Class Reference

Public Member Functions

 __init__ (self, warpingKernelName, interpLength=_DefaultInterpLength, cacheSize=_DefaultCacheSize, maskWarpingKernelName="", growFullMask=afwImage.Mask.getPlaneBitMask("EDGE"))
 
 fromConfig (cls, config)
 
 getWarpingKernel (self)
 
 getMaskWarpingKernel (self)
 
 warpExposure (self, destWcs, srcExposure, border=0, maxBBox=None, destBBox=None)
 
 warpImage (self, destWcs, srcImage, srcWcs, border=0, maxBBox=None, destBBox=None)
 

Static Public Attributes

 ConfigClass = WarperConfig
 

Protected Member Functions

 _computeDestBBox (self, destWcs, srcImage, srcWcs, border, maxBBox, destBBox)
 

Protected Attributes

 _warpingControl
 

Detailed Description

Warp images.

Parameters
----------
warpingKernelName : `str`
    see `WarperConfig.warpingKernelName`
interpLength : `int`, optional
    ``interpLength`` argument to `lsst.afw.math.warpExposure`
cacheSize : `int`, optional
    size of computeCache
maskWarpingKernelName : `str`, optional
    name of mask warping kernel (if ``""`` then use ``warpingKernelName``);
    see `WarperConfig.maskWarpingKernelName`
growFullMask : `int`, optional
    mask bits to grow to full width of image/variance kernel

Definition at line 106 of file _warper.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.afw.math._warper.Warper.__init__ ( self,
warpingKernelName,
interpLength = _DefaultInterpLength,
cacheSize = _DefaultCacheSize,
maskWarpingKernelName = "",
growFullMask = afwImage.Mask.getPlaneBitMask("EDGE") )

Definition at line 125 of file _warper.py.

Member Function Documentation

◆ _computeDestBBox()

lsst.afw.math._warper.Warper._computeDestBBox ( self,
destWcs,
srcImage,
srcWcs,
border,
maxBBox,
destBBox )
protected
Process destBBox argument for warpImage and warpExposure.

Parameters
----------
destWcs : `lsst.afw.geom.SkyWcs`
    WCS of warped image
srcImage
    image or masked image to warp
srcWcs : `lsst.afw.geom.SkyWcs`
    WCS of image
border : `int`, optional
    grow bbox of warped image by this amount in all directions
    (in pixels); if negative then the bbox is shrunk; border is applied
    before ``maxBBox``; ignored if ``destBBox`` is not `None`
maxBBox : `lsst.geom.Box2I`, optional
    maximum allowed parent bbox of warped image; if `None` then the
    warped image will be just big enough to contain all warped pixels;
    if provided then the warped image may be smaller, and so
    missing some warped pixels; ignored if ``destBBox`` is not `None`
destBBox : `lsst.geom.Box2I`, optional
    exact parent bbox of warped image; if `None` then ``border`` and
    ``maxBBox`` are used to determine the bbox, otherwise ``border``
    and ``maxBBox`` are ignored

Definition at line 251 of file _warper.py.

◆ fromConfig()

lsst.afw.math._warper.Warper.fromConfig ( cls,
config )
Create a Warper from a config.

Parameters
----------
config : `WarperConfig`
    The config to initialize the Warper with.

Definition at line 135 of file _warper.py.

◆ getMaskWarpingKernel()

lsst.afw.math._warper.Warper.getMaskWarpingKernel ( self)
Get the mask warping kernel.

Definition at line 156 of file _warper.py.

◆ getWarpingKernel()

lsst.afw.math._warper.Warper.getWarpingKernel ( self)
Get the warping kernel.

Definition at line 151 of file _warper.py.

◆ warpExposure()

lsst.afw.math._warper.Warper.warpExposure ( self,
destWcs,
srcExposure,
border = 0,
maxBBox = None,
destBBox = None )
Warp an exposure.

Parameters
-----------
destWcs : `lsst.afw.geom.SkyWcs`
    WCS of warped exposure
srcExposure
    exposure to warp
border : `int`, optional
    grow bbox of warped exposure by this amount in all directions
    (in pixels); if negative then the bbox is shrunk; border is applied
    before ``maxBBox``; ignored if ``destBBox`` is not `None`
maxBBox : `lsst.geom.Box2I`, optional
    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 : `lsst.geom.Box2I`, optional
    exact parent bbox of warped exposure; if `None` then ``border`` and
    ``maxBBox`` are used to determine the bbox, otherwise ``border``
    and ``maxBBox`` are ignored

Returns
-------
destExposure : same type as ``srcExposure``
    warped exposure

Notes
-----
calls `lsst.afw.math.warpExposure` insted of `~Warper.warpImage` because the former
copies attributes such as ``Calib``, and that should be done in one place

The PSF is not warped. To warp the PSF, use `lsst.meas.algorithms.WarpedPsf`

Definition at line 161 of file _warper.py.

◆ warpImage()

lsst.afw.math._warper.Warper.warpImage ( self,
destWcs,
srcImage,
srcWcs,
border = 0,
maxBBox = None,
destBBox = None )
Warp an image or masked image.

Parameters
----------
destWcs : `lsst.afw.geom.SkyWcs`
    WCS of warped image
srcImage
    image or masked image to warp
srcWcs : `lsst.afw.geom.SkyWcs`
    WCS of image
border : `int`, optional
    grow bbox of warped image by this amount in all directions
    (in pixels); if negative then the bbox is shrunk; border is applied
    before ``maxBBox``; ignored if ``destBBox`` is not `None`
maxBBox : `lsst.geom.Box2I`, optional
    maximum allowed parent bbox of warped image; if `None` then the
    warped image will be just big enough to contain all warped pixels;
    if provided then the warped image may be smaller, and so
    missing some warped pixels; ignored if ``destBBox`` is not `None`
destBBox : `lsst.geom.Box2I`, optional
    exact parent bbox of warped image; if `None` then ``border`` and
    ``maxBBox`` are used to determine the bbox, otherwise ``border``
    and ``maxBBox`` are ignored

Returns
-------
destImage : same type as ``srcExposure``
    warped image or masked image

Definition at line 208 of file _warper.py.

Member Data Documentation

◆ _warpingControl

lsst.afw.math._warper.Warper._warpingControl
protected

Definition at line 131 of file _warper.py.

◆ ConfigClass

lsst.afw.math._warper.Warper.ConfigClass = WarperConfig
static

Definition at line 123 of file _warper.py.


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