summaryrefslogtreecommitdiffstats
path: root/docs/filters.rst
diff options
context:
space:
mode:
authorTomas Farago <tomas.farago@kit.edu>2017-08-25 18:28:15 +0200
committerTomas Farago <tomas.farago@kit.edu>2017-08-28 09:43:45 +0200
commitb53af12a99f78c964e5ff2d5a99589b90af74c07 (patch)
treeadcad88f433496a1d83d380db0c66ab75f4c5010 /docs/filters.rst
parente31fb835f0503365f6f65c598354f887888b9cc6 (diff)
downloadufo-filters-b53af12a99f78c964e5ff2d5a99589b90af74c07.tar.gz
ufo-filters-b53af12a99f78c964e5ff2d5a99589b90af74c07.tar.bz2
ufo-filters-b53af12a99f78c964e5ff2d5a99589b90af74c07.tar.xz
ufo-filters-b53af12a99f78c964e5ff2d5a99589b90af74c07.zip
Add rotate filter
Diffstat (limited to 'docs/filters.rst')
-rw-r--r--docs/filters.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/filters.rst b/docs/filters.rst
index d412ea7..b8023f2 100644
--- a/docs/filters.rst
+++ b/docs/filters.rst
@@ -127,6 +127,41 @@ Transposition
Transpose images from (x, y) to (y, x).
+Rotation
+--------
+
+Rotates images clockwise by an :gobj:prop:`angle` around a :gobj:prop:`center`
+(x, y). When :gobj:prop:`reshape` is ``True``, the rotated image is not
+cropped, i.e. the output image size can be larger that the input size.
+Moreover, this mode makes sure that the original coordinates of the input are
+all contained in the output so that it is easier to see the rotation in the
+output. Try e.g. rotation with :gobj:prop:`center` equal to :math:`(0, 0)` and
+angle :math:`\pi / 2`.
+
+ .. gobj:prop:: angle:float
+
+ Rotation angle in radians.
+
+ .. gobj:prop:: reshape:boolean
+
+ Reshape the result to encompass the complete input image and input
+ indices.
+
+ .. gobj:prop:: center:GValueArray
+
+ Center of rotation (x, y)
+
+ .. gobj:prop:: addressing-mode:enum
+
+ Addressing mode specifies the behavior for pixels falling outside the
+ original image. See OpenCL ``sampler_t`` documentation for more information.
+
+ .. gobj:prop:: interpolation:enum
+
+ Specifies interpolation when a computed pixel coordinate falls between
+ pixels, can be `nearest` or `linear`.
+
+
Flipping
--------