summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2016-11-18 10:00:06 +0100
committerMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2016-11-18 10:00:06 +0100
commitfa858889686a48dda5c86989488dd070eecc763b (patch)
treead763b0a5a649e0cbb27eca760532f64679f002f /docs
parent13bf4ff9ec4e1536a4e57d9a6020c3f226f1a08d (diff)
downloadufo-filters-fa858889686a48dda5c86989488dd070eecc763b.tar.gz
ufo-filters-fa858889686a48dda5c86989488dd070eecc763b.tar.bz2
ufo-filters-fa858889686a48dda5c86989488dd070eecc763b.tar.xz
ufo-filters-fa858889686a48dda5c86989488dd070eecc763b.zip
Add binarization filter
Diffstat (limited to 'docs')
-rw-r--r--docs/filters.rst14
1 files changed, 13 insertions, 1 deletions
diff --git a/docs/filters.rst b/docs/filters.rst
index 7c46c16..447d4f9 100644
--- a/docs/filters.rst
+++ b/docs/filters.rst
@@ -8,6 +8,18 @@ Point-based filters
===================
+Binarization
+------------
+
+.. gobj:class:: binarize
+
+ Binarizes an image.
+
+ .. gobj:prop:: threshold:float
+
+ Any values above the threshold are set to one all others to zero.
+
+
Transposition
-------------
@@ -40,7 +52,7 @@ Clipping
Minimum value, all values lower than `min` are set to `min`.
- .. gobj:prop:: max:flaot
+ .. gobj:prop:: max:float
Maximum value, all values higher than `max` are set to `max`.