summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorXuewei Meng <928826483@qq.com>2021-05-08 18:06:39 +0800
committerSteven Liu <liuqi05@kuaishou.com>2021-05-10 13:34:29 +0800
commitf8d910e90f599f338438833dfc92e2f1915ce414 (patch)
treec039e4dca06d9abb7fec9481da92a4fdd7c44be7 /doc
parent8649f5dca6688feb66f787dcf232d42ed20fdb28 (diff)
GSoC: Add guided filter
Add examples on how to use this filter, and improve the code style. Implement the slice-level parallelism for guided filter. Add the basic version of guided filter. Signed-off-by: Xuewei Meng <xwmeng96@gmail.com> Reviewed-by: Steven Liu <liuqi05@kuaishou.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/filters.texi38
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index b405cc5dfb..03ca9ae7f0 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -12957,6 +12957,44 @@ greyedge=difford=1:minknorm=0:sigma=2
@end itemize
+@section guided filter
+Apply guided filter for edge-preserving smoothing, dehazing and so on.
+
+The filter accepts the following options:
+@table @option
+@item radius
+Set the radius in pixels.
+Allowed range is 1 to 20. Default is 3.
+
+@item eps
+Set regularization parameter.
+Allowed range is 0 to 1. Default is 0.1.
+
+@item planes
+Set planes to filter. Default is first only.
+@end table
+
+@subsection Commands
+This filter supports the all above options as @ref{commands}.
+
+@subsection Examples
+@itemize
+@item
+Edge-preserving smoothing with guided filter:
+@example
+ffmpeg -i in.png -i in.png -filter_complex guided out.png
+@end example
+
+@item
+Dehazing, structure-transferring filtering, detail enhancement with guided filter.
+For the generation of guidance image,
+see @url{http://kaiminghe.com/publications/pami12guidedfilter.pdf}.
+@example
+ffmpeg -i in.png -i guidance.png -filter_complex guided out.png
+@end example
+
+@end itemize
+
@anchor{haldclut}
@section haldclut