LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | Static Public Attributes | List of all members
lsst.afw.math._warper.Warper Class Reference

Public Member Functions

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

Static Public Attributes

 ConfigClass = WarperConfig
 

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__()

def 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.

130  growFullMask=afwImage.Mask.getPlaneBitMask("EDGE"),):
131  self._warpingControl = WarpingControl(
132  warpingKernelName, maskWarpingKernelName, cacheSize, interpLength, growFullMask)
133 

Member Function Documentation

◆ fromConfig()

def 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.

135  def fromConfig(cls, config):
136  """Create a Warper from a config.
137 
138  Parameters
139  ----------
140  config : `WarperConfig`
141  The config to initialize the Warper with.
142  """
143  return cls(
144  warpingKernelName=config.warpingKernelName,
145  maskWarpingKernelName=config.maskWarpingKernelName,
146  interpLength=config.interpLength,
147  cacheSize=config.cacheSize,
148  growFullMask=config.growFullMask,
149  )
150 

◆ getMaskWarpingKernel()

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

Definition at line 156 of file _warper.py.

156  def getMaskWarpingKernel(self):
157  """Get the mask warping kernel.
158  """
159  return self._warpingControl.getMaskWarpingKernel()
160 

◆ getWarpingKernel()

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

Definition at line 151 of file _warper.py.

151  def getWarpingKernel(self):
152  """Get the warping kernel.
153  """
154  return self._warpingControl.getWarpingKernel()
155 

◆ warpExposure()

def 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.

161  def warpExposure(self, destWcs, srcExposure, border=0, maxBBox=None, destBBox=None):
162  """Warp an exposure.
163 
164  Parameters
165  -----------
166  destWcs : `lsst.afw.geom.SkyWcs`
167  WCS of warped exposure
168  srcExposure
169  exposure to warp
170  border : `int`, optional
171  grow bbox of warped exposure by this amount in all directions
172  (in pixels); if negative then the bbox is shrunk; border is applied
173  before ``maxBBox``; ignored if ``destBBox`` is not `None`
174  maxBBox : `lsst.geom.Box2I`, optional
175  maximum allowed parent bbox of warped exposure; if `None` then the
176  warped exposure will be just big enough to contain all warped pixels;
177  if provided then the warped exposure may be smaller, and so
178  missing some warped pixels; ignored if ``destBBox`` is not `None`
179  destBBox : `lsst.geom.Box2I`, optional
180  exact parent bbox of warped exposure; if `None` then ``border`` and
181  ``maxBBox`` are used to determine the bbox, otherwise ``border``
182  and ``maxBBox`` are ignored
183 
184  Returns
185  -------
186  destExposure : same type as ``srcExposure``
187  warped exposure
188 
189  Notes
190  -----
191  calls `lsst.afw.math.warpExposure` insted of `~Warper.warpImage` because the former
192  copies attributes such as ``Calib``, and that should be done in one place
193 
194  The PSF is not warped. To warp the PSF, use `lsst.meas.algorithms.WarpedPsf`
195  """
196  destBBox = self._computeDestBBox(
197  destWcs=destWcs,
198  srcImage=srcExposure.getMaskedImage(),
199  srcWcs=srcExposure.getWcs(),
200  border=border,
201  maxBBox=maxBBox,
202  destBBox=destBBox,
203  )
204  destExposure = srcExposure.Factory(destBBox, destWcs)
205  warpExposure(destExposure, srcExposure, self._warpingControl)
206  return destExposure
207 
lsst::afw::math::warpExposure
int warpExposure(DestExposureT &destExposure, SrcExposureT const &srcExposure, WarpingControl const &control, typename DestExposureT::MaskedImageT::SinglePixel padValue=lsst::afw::math::edgePixel< typename DestExposureT::MaskedImageT >(typename lsst::afw::image::detail::image_traits< typename DestExposureT::MaskedImageT >::image_category()))
Warp (remap) one exposure to another.
Definition: warpExposure.cc:393

◆ warpImage()

def 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.

208  def warpImage(self, destWcs, srcImage, srcWcs, border=0, maxBBox=None, destBBox=None):
209  """Warp an image or masked image.
210 
211  Parameters
212  ----------
213  destWcs : `lsst.afw.geom.SkyWcs`
214  WCS of warped image
215  srcImage
216  image or masked image to warp
217  srcWcs : `lsst.afw.geom.SkyWcs`
218  WCS of image
219  border : `int`, optional
220  grow bbox of warped image by this amount in all directions
221  (in pixels); if negative then the bbox is shrunk; border is applied
222  before ``maxBBox``; ignored if ``destBBox`` is not `None`
223  maxBBox : `lsst.geom.Box2I`, optional
224  maximum allowed parent bbox of warped image; if `None` then the
225  warped image will be just big enough to contain all warped pixels;
226  if provided then the warped image may be smaller, and so
227  missing some warped pixels; ignored if ``destBBox`` is not `None`
228  destBBox : `lsst.geom.Box2I`, optional
229  exact parent bbox of warped image; if `None` then ``border`` and
230  ``maxBBox`` are used to determine the bbox, otherwise ``border``
231  and ``maxBBox`` are ignored
232 
233  Returns
234  -------
235  destImage : same type as ``srcExposure``
236  warped image or masked image
237  """
238  destBBox = self._computeDestBBox(
239  destWcs=destWcs,
240  srcImage=srcImage,
241  srcWcs=srcWcs,
242  border=border,
243  maxBBox=maxBBox,
244  destBBox=destBBox,
245  )
246  destImage = srcImage.Factory(destBBox)
247  warpImage(destImage, destWcs, srcImage,
248  srcWcs, self._warpingControl)
249  return destImage
250 
lsst::afw::math::warpImage
int warpImage(DestImageT &destImage, geom::SkyWcs const &destWcs, SrcImageT const &srcImage, geom::SkyWcs const &srcWcs, WarpingControl const &control, typename DestImageT::SinglePixel padValue=lsst::afw::math::edgePixel< DestImageT >(typename lsst::afw::image::detail::image_traits< DestImageT >::image_category()))
Warp an Image or MaskedImage to a new Wcs.
Definition: warpExposure.cc:441

Member Data Documentation

◆ 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:
Generated on Fri Nov 26 2021 10:16:16 for LSST Applications by doxygen 1.9.1