summaryrefslogtreecommitdiffstats
path: root/docs/kernels.rst
blob: ce485c902293e4ce68a698cefa64e347736dbfb9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
.. _opencl-default-kernels:

OpenCL default kernels
======================

This section lists all kernel functions that are available to the
:gobj:class:`opencl` filter if no filename is specified.

.. c:function:: void fix_nan_and_inf ()

    Sets element to 0.0 if it is NaN or Inf.

.. c:function:: void absorptivity ()

    Computes :math:`f(x) = -log(x)`.

.. c:function:: void nlm_noise_reduction ()

    Smooths data within a local neighbourhood.

.. c:function:: void diff ()

    Computes :math:`f(x, y) = x - y`.


.. _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 ! ..