diff options
Diffstat (limited to 'docs/kernels.rst')
| -rw-r--r-- | docs/kernels.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/kernels.rst b/docs/kernels.rst index f2f77e1..cd0020c 100644 --- a/docs/kernels.rst +++ b/docs/kernels.rst @@ -17,3 +17,36 @@ This section lists all kernel functions that are available to the .. c:function:: void nlm_noise_reduction () Smooths data within a local neighbourhood. + + +.. _opencl-reduction-default-kernels: + + +OpenCL reduction default kernels +================================ + +This section lists all kernel functions that are available to the +:gobj:class:`opencl-reduce` filter if no filename is specified. These kernels +are supposed to be used for the ``kernel`` argument. + +.. c:function:: void minimum () + + Computes the minimum of each pixel in the stream. + +.. c:function:: void maximum () + + Computes the maximum of each pixel in the stream. + +.. c:function:: void sum () + + Computes the sum of each pixel in the stream. + + +These kernels are supposed to be used in the ``finish`` argument: + +.. c:function:: void divide () + + Divides each pixel by the stream count. Together with ``sum`` this can be + used to compute the average, i.e.:: + + ufo-launch .. ! opencl-reduce kernel=sum finish=divide ! .. |