From 1c899757b7dd3b51c7b00832211e56a87b257508 Mon Sep 17 00:00:00 2001 From: Tomas Farago Date: Thu, 9 Apr 2020 11:30:03 +0200 Subject: sliding-stack: document ordered parameter --- docs/filters.rst | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/filters.rst b/docs/filters.rst index 76b16e7..ff901bb 100644 --- a/docs/filters.rst +++ b/docs/filters.rst @@ -765,15 +765,20 @@ Stacking with sliding window Stacks input images up to the specified :gobj:prop:`number` and then replaces old images with incoming new ones as they come. The first image is - copied to all positions in the beginning. Images in the window are not - ordered, i.e. if e.g. :gobj:prop:`number` = 3, then the window will contain - the following input images: (0, 0, 0), (0, 1, 0), (0, 1, 2), (3, 1, 2), (3, - 4, 2), (3, 4, 5) and so on. + copied to all positions in the beginning. By default, images in the window + are not ordered, i.e. if e.g. :gobj:prop:`number` = 3, then the window will + contain the following input images: (0, 0, 0), (0, 1, 0), (0, 1, 2), (3, 1, + 2), (3, 4, 2), (3, 4, 5) and so on. If you want them to appear ordered with + respect to their arrival time, use :gobj:prop:`ordered`. .. gobj:prop:: number:uint Number of items, i.e. the length of the third dimension. + .. gobj:prop:: ordered:boolean + + Order items in the sliding window. + Merging ------- -- cgit v1.2.1