summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2017-02-28 18:00:57 +0100
committerMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2017-02-28 18:03:59 +0100
commit63566ccfda0b7220b396e552d7d8782d35ed69b6 (patch)
tree00f8ed7e961ae335563470a8e199e913a11111cb /docs
parent0e1d1f669fbaaffe3c4d21de97795c23d45a063c (diff)
downloadufo-filters-63566ccfda0b7220b396e552d7d8782d35ed69b6.tar.gz
ufo-filters-63566ccfda0b7220b396e552d7d8782d35ed69b6.tar.bz2
ufo-filters-63566ccfda0b7220b396e552d7d8782d35ed69b6.tar.xz
ufo-filters-63566ccfda0b7220b396e552d7d8782d35ed69b6.zip
Add correlate-stacks task
Diffstat (limited to 'docs')
-rw-r--r--docs/filters.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/filters.rst b/docs/filters.rst
index b0f92fe..f2cd3ff 100644
--- a/docs/filters.rst
+++ b/docs/filters.rst
@@ -312,6 +312,21 @@ Subtract
Subtract data items of the second from the first stream.
+Correlate
+---------
+
+.. gobj:class:: correlate-stacks
+
+ Reads two datastreams, the first must provide a 3D stack of images that is
+ used to correlate individal 2D images from the second datastream. The
+ ``number`` property must contain the expected number of items in the second
+ stream.
+
+ .. gobj:prop:: number:uint
+
+ Number of data items in the second data stream.
+
+
Filters
=======