introduced new RST/Sphinx domain ocv.

This commit is contained in:
Vadim Pisarevsky
2011-06-16 12:48:23 +00:00
parent 4f3fb040a4
commit 8d8ef596c8
48 changed files with 2823 additions and 1691 deletions

View File

@@ -9,9 +9,9 @@ Per-element Operations.
gpu::add
------------
.. cpp:function:: void gpu::add(const GpuMat& src1, const GpuMat& src2, GpuMat& dst)
.. ocv:function:: void gpu::add(const GpuMat& src1, const GpuMat& src2, GpuMat& dst)
.. cpp:function:: void gpu::add(const GpuMat& src1, const Scalar& src2, GpuMat& dst)
.. ocv:function:: void gpu::add(const GpuMat& src1, const Scalar& src2, GpuMat& dst)
Computes a matrix-matrix or matrix-scalar sum.
@@ -21,15 +21,15 @@ gpu::add
:param dst: Destination matrix with the same size and type as ``src1``.
See Also: :cpp:func:`add`
See Also: :ocv:func:`add`
.. index:: gpu::subtract
gpu::subtract
-----------------
.. cpp:function:: void gpu::subtract(const GpuMat& src1, const GpuMat& src2, GpuMat& dst)
.. ocv:function:: void gpu::subtract(const GpuMat& src1, const GpuMat& src2, GpuMat& dst)
.. cpp:function:: void gpu::subtract(const GpuMat& src1, const Scalar& src2, GpuMat& dst)
.. ocv:function:: void gpu::subtract(const GpuMat& src1, const Scalar& src2, GpuMat& dst)
Computes a matrix-matrix or matrix-scalar difference.
@@ -39,7 +39,7 @@ gpu::subtract
:param dst: Destination matrix with the same size and type as ``src1``.
See Also: :cpp:func:`subtract`
See Also: :ocv:func:`subtract`
@@ -47,9 +47,9 @@ See Also: :cpp:func:`subtract`
gpu::multiply
-----------------
.. cpp:function:: void gpu::multiply(const GpuMat& src1, const GpuMat& src2, GpuMat& dst)
.. ocv:function:: void gpu::multiply(const GpuMat& src1, const GpuMat& src2, GpuMat& dst)
.. cpp:function:: void gpu::multiply(const GpuMat& src1, const Scalar& src2, GpuMat& dst)
.. ocv:function:: void gpu::multiply(const GpuMat& src1, const Scalar& src2, GpuMat& dst)
Computes a matrix-matrix or matrix-scalar per-element product.
@@ -59,16 +59,16 @@ gpu::multiply
:param dst: Destination matrix with the same size and type as ``src1``.
See Also: :cpp:func:`multiply`
See Also: :ocv:func:`multiply`
.. index:: gpu::divide
gpu::divide
---------------
.. cpp:function:: void gpu::divide(const GpuMat& src1, const GpuMat& src2, GpuMat& dst)
.. ocv:function:: void gpu::divide(const GpuMat& src1, const GpuMat& src2, GpuMat& dst)
.. cpp:function:: void gpu::divide(const GpuMat& src1, const Scalar& src2, GpuMat& dst)
.. ocv:function:: void gpu::divide(const GpuMat& src1, const Scalar& src2, GpuMat& dst)
Computes a matrix-matrix or matrix-scalar sum.
@@ -78,9 +78,9 @@ gpu::divide
:param dst: Destination matrix with the same size and type as ``src1``.
This function, in contrast to :cpp:func:`divide`, uses a round-down rounding mode.
This function, in contrast to :ocv:func:`divide`, uses a round-down rounding mode.
See Also: :cpp:func:`divide`
See Also: :ocv:func:`divide`
@@ -88,7 +88,7 @@ See Also: :cpp:func:`divide`
gpu::exp
------------
.. cpp:function:: void gpu::exp(const GpuMat& src, GpuMat& dst)
.. ocv:function:: void gpu::exp(const GpuMat& src, GpuMat& dst)
Computes an exponent of each matrix element.
@@ -96,7 +96,7 @@ gpu::exp
:param dst: Destination matrix with the same size and type as ``src``.
See Also: :cpp:func:`exp`
See Also: :ocv:func:`exp`
@@ -104,7 +104,7 @@ See Also: :cpp:func:`exp`
gpu::log
------------
.. cpp:function:: void gpu::log(const GpuMat& src, GpuMat& dst)
.. ocv:function:: void gpu::log(const GpuMat& src, GpuMat& dst)
Computes a natural logarithm of absolute value of each matrix element.
@@ -112,7 +112,7 @@ gpu::log
:param dst: Destination matrix with the same size and type as ``src``.
See Also: :cpp:func:`log`
See Also: :ocv:func:`log`
@@ -120,9 +120,9 @@ See Also: :cpp:func:`log`
gpu::absdiff
----------------
.. cpp:function:: void gpu::absdiff(const GpuMat& src1, const GpuMat& src2, GpuMat& dst)
.. ocv:function:: void gpu::absdiff(const GpuMat& src1, const GpuMat& src2, GpuMat& dst)
.. cpp:function:: void gpu::absdiff(const GpuMat& src1, const Scalar& src2, GpuMat& dst)
.. ocv:function:: void gpu::absdiff(const GpuMat& src1, const Scalar& src2, GpuMat& dst)
Computes per-element absolute difference of two matrices (or of matrix and scalar).
@@ -132,13 +132,13 @@ gpu::absdiff
:param dst: Destination matrix with the same size and type as ``src1``.
See Also: :cpp:func:`absdiff`
See Also: :ocv:func:`absdiff`
.. index:: gpu::compare
gpu::compare
----------------
.. cpp:function:: void gpu::compare(const GpuMat& src1, const GpuMat& src2, GpuMat& dst, int cmpop)
.. ocv:function:: void gpu::compare(const GpuMat& src1, const GpuMat& src2, GpuMat& dst, int cmpop)
Compares elements of two matrices.
@@ -157,16 +157,16 @@ gpu::compare
* **CMP_LE:** ``src1(.) <= src2(.)``
* **CMP_NE:** ``src1(.) != src2(.)``
See Also: :cpp:func:`compare`
See Also: :ocv:func:`compare`
.. index:: gpu::bitwise_not
gpu::bitwise_not
--------------------
.. cpp:function:: void gpu::bitwise_not(const GpuMat& src, GpuMat& dst, const GpuMat& mask=GpuMat())
.. ocv:function:: void gpu::bitwise_not(const GpuMat& src, GpuMat& dst, const GpuMat& mask=GpuMat())
.. cpp:function:: void gpu::bitwise_not(const GpuMat& src, GpuMat& dst, const GpuMat& mask, const Stream& stream)
.. ocv:function:: void gpu::bitwise_not(const GpuMat& src, GpuMat& dst, const GpuMat& mask, const Stream& stream)
Performs a per-element bitwise inversion.
@@ -184,9 +184,9 @@ gpu::bitwise_not
gpu::bitwise_or
-------------------
.. cpp:function:: void gpu::bitwise_or(const GpuMat& src1, const GpuMat& src2, GpuMat& dst, const GpuMat& mask=GpuMat())
.. ocv:function:: void gpu::bitwise_or(const GpuMat& src1, const GpuMat& src2, GpuMat& dst, const GpuMat& mask=GpuMat())
.. cpp:function:: void gpu::bitwise_or(const GpuMat& src1, const GpuMat& src2, GpuMat& dst, const GpuMat& mask, const Stream& stream)
.. ocv:function:: void gpu::bitwise_or(const GpuMat& src1, const GpuMat& src2, GpuMat& dst, const GpuMat& mask, const Stream& stream)
Performs a per-element bitwise disjunction of two matrices.
@@ -206,9 +206,9 @@ gpu::bitwise_or
gpu::bitwise_and
--------------------
.. cpp:function:: void gpu::bitwise_and(const GpuMat& src1, const GpuMat& src2, GpuMat& dst, const GpuMat& mask=GpuMat())
.. ocv:function:: void gpu::bitwise_and(const GpuMat& src1, const GpuMat& src2, GpuMat& dst, const GpuMat& mask=GpuMat())
.. cpp:function:: void gpu::bitwise_and(const GpuMat& src1, const GpuMat& src2, GpuMat& dst, const GpuMat& mask, const Stream& stream)
.. ocv:function:: void gpu::bitwise_and(const GpuMat& src1, const GpuMat& src2, GpuMat& dst, const GpuMat& mask, const Stream& stream)
Performs a per-element bitwise conjunction of two matrices.
@@ -228,9 +228,9 @@ gpu::bitwise_and
gpu::bitwise_xor
--------------------
.. cpp:function:: void gpu::bitwise_xor(const GpuMat& src1, const GpuMat& src2, GpuMat& dst, const GpuMat& mask=GpuMat())
.. ocv:function:: void gpu::bitwise_xor(const GpuMat& src1, const GpuMat& src2, GpuMat& dst, const GpuMat& mask=GpuMat())
.. cpp:function:: void gpu::bitwise_xor(const GpuMat& src1, const GpuMat& src2, GpuMat& dst, const GpuMat& mask, const Stream& stream)
.. ocv:function:: void gpu::bitwise_xor(const GpuMat& src1, const GpuMat& src2, GpuMat& dst, const GpuMat& mask, const Stream& stream)
Performs a per-element bitwise "exclusive or" operation of two matrices.
@@ -250,13 +250,13 @@ gpu::bitwise_xor
gpu::min
------------
.. cpp:function:: void gpu::min(const GpuMat& src1, const GpuMat& src2, GpuMat& dst)
.. ocv:function:: void gpu::min(const GpuMat& src1, const GpuMat& src2, GpuMat& dst)
.. cpp:function:: void gpu::min(const GpuMat& src1, const GpuMat& src2, GpuMat& dst, const Stream& stream)
.. ocv:function:: void gpu::min(const GpuMat& src1, const GpuMat& src2, GpuMat& dst, const Stream& stream)
.. cpp:function:: void gpu::min(const GpuMat& src1, double src2, GpuMat& dst)
.. ocv:function:: void gpu::min(const GpuMat& src1, double src2, GpuMat& dst)
.. cpp:function:: void gpu::min(const GpuMat& src1, double src2, GpuMat& dst, const Stream& stream)
.. ocv:function:: void gpu::min(const GpuMat& src1, double src2, GpuMat& dst, const Stream& stream)
Computes the per-element minimum of two matrices (or a matrix and a scalar).
@@ -268,7 +268,7 @@ gpu::min
:param stream: Stream for the asynchronous version.
See Also: :cpp:func:`min`
See Also: :ocv:func:`min`
@@ -276,13 +276,13 @@ See Also: :cpp:func:`min`
gpu::max
------------
.. cpp:function:: void gpu::max(const GpuMat& src1, const GpuMat& src2, GpuMat& dst)
.. ocv:function:: void gpu::max(const GpuMat& src1, const GpuMat& src2, GpuMat& dst)
.. cpp:function:: void gpu::max(const GpuMat& src1, const GpuMat& src2, GpuMat& dst, const Stream& stream)
.. ocv:function:: void gpu::max(const GpuMat& src1, const GpuMat& src2, GpuMat& dst, const Stream& stream)
.. cpp:function:: void gpu::max(const GpuMat& src1, double src2, GpuMat& dst)
.. ocv:function:: void gpu::max(const GpuMat& src1, double src2, GpuMat& dst)
.. cpp:function:: void gpu::max(const GpuMat& src1, double src2, GpuMat& dst, const Stream& stream)
.. ocv:function:: void gpu::max(const GpuMat& src1, double src2, GpuMat& dst, const Stream& stream)
Computes the per-element maximum of two matrices (or a matrix and a scalar).
@@ -294,4 +294,4 @@ gpu::max
:param stream: Stream for the asynchronous version.
See Also: :cpp:func:`max`
See Also: :ocv:func:`max`