summaryrefslogtreecommitdiff
path: root/doc/filters.texi
diff options
context:
space:
mode:
authorLou Logan <lou@lrcd.com>2018-04-12 12:44:49 -0800
committerLou Logan <lou@lrcd.com>2018-04-12 12:44:49 -0800
commit4d544f608608f69e68136b8333d3649866e2a7ed (patch)
treed0644ca0394ea1093b604ef38bfa7ffa998b0dbc /doc/filters.texi
parent52623bc26fc49a1335a7ba4aab6ddb2b6588c105 (diff)
doc/filters: fix lenscorrection k1 & k2 typo
0 means no correction, not 0.5. Also document ranges and defaults for options. Signed-off-by: Lou Logan <lou@lrcd.com>
Diffstat (limited to 'doc/filters.texi')
-rw-r--r--doc/filters.texi10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index b78e05a329..09b07d2a4a 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -10373,15 +10373,17 @@ The filter accepts the following options:
@item cx
Relative x-coordinate of the focal point of the image, and thereby the center of the
distortion. This value has a range [0,1] and is expressed as fractions of the image
-width.
+width. Default is 0.5.
@item cy
Relative y-coordinate of the focal point of the image, and thereby the center of the
distortion. This value has a range [0,1] and is expressed as fractions of the image
-height.
+height. Default is 0.5.
@item k1
-Coefficient of the quadratic correction term. 0.5 means no correction.
+Coefficient of the quadratic correction term. This value has a range [-1,1]. 0 means
+no correction. Default is 0.
@item k2
-Coefficient of the double quadratic correction term. 0.5 means no correction.
+Coefficient of the double quadratic correction term. This value has a range [-1,1].
+0 means no correction. Default is 0.
@end table
The formula that generates the correction is: