LSST Applications  21.0.0+c4f5df5339,21.0.0+e70536a077,21.0.0-1-ga51b5d4+7c60f8a6ea,21.0.0-10-gcf60f90+74aa0801fd,21.0.0-12-g63909ac9+643a1044a5,21.0.0-15-gedb9d5423+1041c3824f,21.0.0-2-g103fe59+a356b2badb,21.0.0-2-g1367e85+6d3f3f41db,21.0.0-2-g45278ab+e70536a077,21.0.0-2-g5242d73+6d3f3f41db,21.0.0-2-g7f82c8f+8d7c04eab9,21.0.0-2-g8f08a60+9c9a9cfcc8,21.0.0-2-ga326454+8d7c04eab9,21.0.0-2-gde069b7+bedfc5e1fb,21.0.0-2-gecfae73+6cb6558258,21.0.0-2-gfc62afb+6d3f3f41db,21.0.0-3-g21c7a62+f6e98b25aa,21.0.0-3-g357aad2+bd62456bea,21.0.0-3-g4be5c26+6d3f3f41db,21.0.0-3-g65f322c+03a4076c01,21.0.0-3-g7d9da8d+c4f5df5339,21.0.0-3-gaa929c8+c6b98066dc,21.0.0-3-gc44e71e+a26d5c1aea,21.0.0-3-ge02ed75+04b527a9d5,21.0.0-35-g64f566ff+b27e5ef93e,21.0.0-4-g591bb35+04b527a9d5,21.0.0-4-g88306b8+8773047b2e,21.0.0-4-gc004bbf+80a0b7acb7,21.0.0-4-gccdca77+a5c54364a0,21.0.0-4-ge8fba5a+ccfc328107,21.0.0-5-gdf36809+87b8d260e6,21.0.0-6-g00874e7+7eeda2b6ba,21.0.0-6-g2d4f3f3+e70536a077,21.0.0-6-g4e60332+04b527a9d5,21.0.0-6-g5ef7dad+f53629abd8,21.0.0-7-gc8ca178+b63e69433b,21.0.0-8-gfbe0b4b+c6b98066dc,w.2021.06
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:238

◆ 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:283

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 Wed Feb 10 2021 09:12:42 for LSST Applications by doxygen 1.9.1