diff options
| author | Sasank Chilamkurthy <sasankchilamkurthy@gmail.com> | 2016-08-23 17:03:52 +0300 |
|---|---|---|
| committer | Sasank Chilamkurthy <sasankchilamkurthy@gmail.com> | 2016-08-23 17:03:52 +0300 |
| commit | 49fa1e57bfb355ef9c23745eb7f010dbd8d3ff8a (patch) | |
| tree | 01d46100ca01c0e03b77ebb888e2d83f352f6254 | |
| parent | e3941d9b0a053e73bc70c10cd5c806b11d0ac6e5 (diff) | |
Added documentation for affinetransform
| -rw-r--r-- | doc/paramtransform.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/paramtransform.md b/doc/paramtransform.md index 839c754..a160a34 100644 --- a/doc/paramtransform.md +++ b/doc/paramtransform.md @@ -19,6 +19,22 @@ When `clamp_mode` equals `pad`, the user can specify the padding value with `pad If `dst` is specified, it is used to store the result of the warp. Otherwise, returns a new `res` Tensor. +<a name="image.affinetransform"></a> +### [res] image.affinetransform([dst,]src,matrix,[mode,translation,clamp_mode,pad_val]) ### +Warps image `src` (of size`KxHxW`) +according to `(y,x)` affine transformation defined by `matrix`. +The latter has size `2x2`. String `mode` can +take on values [lanczos](https://en.wikipedia.org/wiki/Lanczos_resampling), +[bicubic](https://en.wikipedia.org/wiki/Bicubic_interpolation), +[bilinear](https://en.wikipedia.org/wiki/Bilinear_interpolation) (the default), +or *simple*. +Additional translation can be added to the image before affine transformation with `translation`.( Default is `torch.Tensor{0, 0}`.) +The `clamp_mode` variable specifies how to handle the interpolation of samples off the input image. +Permitted values are strings *clamp* (the default) or *pad*. +When `clamp_mode` equals `pad`, the user can specify the padding value with `pad_val` (default = 0). Note: setting this value when `clamp_mode` equals `clamp` will result in an error. +If `dst` is specified, it is used to store the result of the warp. +Otherwise, returns a new `res` Tensor. + <a name="image.convolve"></a> ### [res] image.convolve([dst,] src, kernel, [mode]) ### Convolves Tensor `kernel` over image `src`. Valid string values for argument |