opencv/modules/gpu/doc/per_element_operations..rst

Per-element Operations.
=======================

.. highlight:: cpp

.. index:: gpu::add

cv::gpu::add
------------
.. c:function:: void add(const GpuMat\& a, const GpuMat\& b, GpuMat\& c)

    Computes matrix-matrix or matrix-scalar sum.

    :param a: First source matrix.  ``CV_8UC1`` ,  ``CV_8UC4`` ,  ``CV_32SC1``  and  ``CV_32FC1``  matrices are supported for now.

    :param b: Second source matrix. Must have the same size and type as  ``a`` .

    :param c: Destination matrix. Will have the same size and type as  ``a`` .

.. c:function:: void add(const GpuMat\& a, const Scalar\& sc, GpuMat\& c)

    * **a** Source matrix.  ``CV_32FC1``  and  ``CV_32FC2``  matrixes are supported for now.

    * **b** Source scalar to be added to the source matrix.

    * **c** Destination matrix. Will have the same size and type as  ``a`` .

See also:
:func:`add` .

.. index:: gpu::subtract

cv::gpu::subtract
-----------------
.. c:function:: void subtract(const GpuMat\& a, const GpuMat\& b, GpuMat\& c)

    Subtracts matrix from another matrix (or scalar from matrix).

    :param a: First source matrix.  ``CV_8UC1`` ,  ``CV_8UC4`` ,  ``CV_32SC1``  and  ``CV_32FC1``  matrices are supported for now.

    :param b: Second source matrix. Must have the same size and type as  ``a`` .

    :param c: Destination matrix. Will have the same size and type as  ``a`` .

.. c:function:: void subtract(const GpuMat\& a, const Scalar\& sc, GpuMat\& c)

    * **a** Source matrix.   ``CV_32FC1``  and  ``CV_32FC2``  matrixes are supported for now.

    * **b** Scalar to be subtracted from the source matrix elements.

    * **c** Destination matrix. Will have the same size and type as  ``a`` .

See also:
:func:`subtract` .

.. index:: gpu::multiply

cv::gpu::multiply
-----------------
.. c:function:: void multiply(const GpuMat\& a, const GpuMat\& b, GpuMat\& c)

    Computes per-element product of two matrices (or of matrix and scalar).

    :param a: First source matrix.  ``CV_8UC1`` ,  ``CV_8UC4`` ,  ``CV_32SC1``  and  ``CV_32FC1``  matrices are supported for now.

    :param b: Second source matrix. Must have the same size and type as  ``a`` .

    :param c: Destionation matrix. Will have the same size and type as  ``a`` .

.. c:function:: void multiply(const GpuMat\& a, const Scalar\& sc, GpuMat\& c)

    * **a** Source matrix.   ``CV_32FC1``  and  ``CV_32FC2``  matrixes are supported for now.

    * **b** Scalar to be multiplied by.

    * **c** Destination matrix. Will have the same size and type as  ``a`` .

See also:
:func:`multiply` .

.. index:: gpu::divide

cv::gpu::divide
---------------
.. c:function:: void divide(const GpuMat\& a, const GpuMat\& b, GpuMat\& c)

    Performs per-element division of two matrices (or division of matrix by scalar).

    :param a: First source matrix.  ``CV_8UC1`` ,  ``CV_8UC4`` ,  ``CV_32SC1``  and  ``CV_32FC1``  matrices are supported for now.

    :param b: Second source matrix. Must have the same size and type as  ``a`` .

    :param c: Destionation matrix. Will have the same size and type as  ``a`` .

.. c:function:: void divide(const GpuMat\& a, const Scalar\& sc, GpuMat\& c)

    * **a** Source matrix.   ``CV_32FC1``  and  ``CV_32FC2``  matrixes are supported for now.

    * **b** Scalar to be divided by.

    * **c** Destination matrix. Will have the same size and type as  ``a`` .

This function in contrast to
:func:`divide` uses round-down rounding mode.

See also:
:func:`divide` .

.. index:: gpu::exp

cv::gpu::exp
------------
.. c:function:: void exp(const GpuMat\& a, GpuMat\& b)

    Computes exponent of each matrix element.

    :param a: Source matrix.  ``CV_32FC1``  matrixes are supported for now.

    :param b: Destination matrix. Will have the same size and type as  ``a`` .

See also:
:func:`exp` .

.. index:: gpu::log

cv::gpu::log
------------
.. c:function:: void log(const GpuMat\& a, GpuMat\& b)

    Computes natural logarithm of absolute value of each matrix element.

    :param a: Source matrix.  ``CV_32FC1``  matrixes are supported for now.

    :param b: Destination matrix. Will have the same size and type as  ``a`` .

See also:
:func:`log` .

.. index:: gpu::absdiff

cv::gpu::absdiff
----------------
.. c:function:: void absdiff(const GpuMat\& a, const GpuMat\& b, GpuMat\& c)

    Computes per-element absolute difference of two matrices (or of matrix and scalar).

    :param a: First source matrix.  ``CV_8UC1`` ,  ``CV_8UC4`` ,  ``CV_32SC1``  and  ``CV_32FC1``  matrices are supported for now.

    :param b: Second source matrix. Must have the same size and type as  ``a`` .

    :param c: Destionation matrix. Will have the same size and type as  ``a`` .

.. c:function:: void absdiff(const GpuMat\& a, const Scalar\& s, GpuMat\& c)

    * **a** Source matrix.  ``CV_32FC1``  matrixes are supported for now.

    * **b** Scalar to be subtracted from the source matrix elements.

    * **c** Destination matrix. Will have the same size and type as  ``a`` .

See also:
:func:`absdiff` .

.. index:: gpu::compare

cv::gpu::compare
----------------
.. c:function:: void compare(const GpuMat\& a, const GpuMat\& b, GpuMat\& c, int cmpop)

    Compares elements of two matrices.

    :param a: First source matrix.  ``CV_8UC4``  and  ``CV_32FC1``  matrices are supported for now.

    :param b: Second source matrix. Must have the same size and type as  ``a`` .

    :param c: Destination matrix. Will have the same size as  ``a``  and be  ``CV_8UC1``  type.

    :param cmpop: Flag specifying the relation between the elements to be checked:
        
            * **CMP_EQ** :math:`=`             
            * **CMP_GT** :math:`>`             
            * **CMP_GE** :math:`\ge`             
            * **CMP_LT** :math:`<`             
            * **CMP_LE** :math:`\le`             
            * **CMP_NE** :math:`\ne`             
            

See also:
:func:`compare` .

.. index:: cv::gpu::bitwise_not

.. _cv::gpu::bitwise_not:

cv::gpu::bitwise_not
--------------------
.. c:function:: void bitwise_not(const GpuMat\& src, GpuMat\& dst,
   const GpuMat\& mask=GpuMat())

.. c:function:: void bitwise_not(const GpuMat\& src, GpuMat\& dst,
   const GpuMat\& mask, const Stream\& stream)

    Performs per-element bitwise inversion.

    :param src: Source matrix.

    :param dst: Destination matrix. Will have the same size and type as  ``src`` .

    :param mask: Optional operation mask. 8-bit single channel image.

    :param stream: Stream for the asynchronous version.

See also:
.

.. index:: cv::gpu::bitwise_or

.. _cv::gpu::bitwise_or:

cv::gpu::bitwise_or
-------------------
.. c:function:: void bitwise_or(const GpuMat\& src1, const GpuMat\& src2, GpuMat\& dst,
   const GpuMat\& mask=GpuMat())

.. c:function:: void bitwise_or(const GpuMat\& src1, const GpuMat\& src2, GpuMat\& dst,
   const GpuMat\& mask, const Stream\& stream)

    Performs per-element bitwise disjunction of two matrices.

    :param src1: First source matrix.

    :param src2: Second source matrix. It must have the same size and type as  ``src1`` .

    :param dst: Destination matrix. Will have the same size and type as  ``src1`` .

    :param mask: Optional operation mask. 8-bit single channel image.

    :param stream: Stream for the asynchronous version.

See also:
.

.. index:: cv::gpu::bitwise_and

.. _cv::gpu::bitwise_and:

cv::gpu::bitwise_and
--------------------
.. c:function:: void bitwise_and(const GpuMat\& src1, const GpuMat\& src2, GpuMat\& dst,
   const GpuMat\& mask=GpuMat())

.. c:function:: void bitwise_and(const GpuMat\& src1, const GpuMat\& src2, GpuMat\& dst,
   const GpuMat\& mask, const Stream\& stream)

    Performs per-element bitwise conjunction of two matrices.

    :param src1: First source matrix.

    :param src2: Second source matrix. It must have the same size and type as  ``src1`` .

    :param dst: Destination matrix. Will have the same size and type as  ``src1`` .

    :param mask: Optional operation mask. 8-bit single channel image.

    :param stream: Stream for the asynchronous version.

See also:
.

.. index:: cv::gpu::bitwise_xor

.. _cv::gpu::bitwise_xor:

cv::gpu::bitwise_xor
--------------------
.. c:function:: void bitwise_xor(const GpuMat\& src1, const GpuMat\& src2, GpuMat\& dst,
   const GpuMat\& mask=GpuMat())

.. c:function:: void bitwise_xor(const GpuMat\& src1, const GpuMat\& src2, GpuMat\& dst,
   const GpuMat\& mask, const Stream\& stream)

    Performs per-element bitwise "exclusive or" of two matrices.

    :param src1: First source matrix.

    :param src2: Second source matrix. It must have the same size and type as  ``src1`` .

    :param dst: Destination matrix. Will have the same size and type as  ``src1`` .

    :param mask: Optional operation mask. 8-bit single channel image.

    :param stream: Stream for the asynchronous version.

See also:
.

.. index:: gpu::min

cv::gpu::min
------------
.. c:function:: void min(const GpuMat\& src1, const GpuMat\& src2, GpuMat\& dst)

.. c:function:: void min(const GpuMat\& src1, const GpuMat\& src2, GpuMat\& dst,
   const Stream\& stream)

    Computes per-element minimum of two matrices (or of matrix and scalar).

    :param src1: First source matrix.

    :param src2: Second source matrix.

    :param dst: Destination matrix. Will have the same size and type as  ``src1`` .

    :param stream: Stream for the asynchronous version.

.. c:function:: void min(const GpuMat\& src1, double src2, GpuMat\& dst)

.. c:function:: void min(const GpuMat\& src1, double src2, GpuMat\& dst,
   const Stream\& stream)

    * **src1** Source matrix.

    * **src2** Scalar to be compared with.

    * **dst** Destination matrix. Will have the same size and type as  ``src1`` .

    * **stream** Stream for the asynchronous version.

See also:
:func:`min` .

.. index:: gpu::max

cv::gpu::max
------------
.. c:function:: void max(const GpuMat\& src1, const GpuMat\& src2, GpuMat\& dst)

.. c:function:: void max(const GpuMat\& src1, const GpuMat\& src2, GpuMat\& dst,
   const Stream\& stream)

    Computes per-element maximum of two matrices (or of matrix and scalar).

    :param src1: First source matrix.

    :param src2: Second source matrix.

    :param dst: Destination matrix. Will have the same size and type as  ``src1`` .

    :param stream: Stream for the asynchronous version.

.. c:function:: void max(const GpuMat\& src1, double src2, GpuMat\& dst)

.. c:function:: void max(const GpuMat\& src1, double src2, GpuMat\& dst,
   const Stream\& stream)

    * **src1** Source matrix.

    * **src2** Scalar to be compared with.

    * **dst** Destination matrix. Will have the same size and type as  ``src1`` .

    * **stream** Stream for the asynchronous version.

See also:
:func:`max` .