fixed docs

This commit is contained in:
Vladislav Vinogradov
2013-08-20 15:05:49 +04:00
parent f936c1283b
commit cbe437571e
37 changed files with 1013 additions and 998 deletions

View File

@@ -5,17 +5,17 @@ Matrix Reductions
gpu::norm
---------
cuda::norm
----------
Returns the norm of a matrix (or difference of two matrices).
.. ocv:function:: double gpu::norm(InputArray src1, int normType)
.. ocv:function:: double cuda::norm(InputArray src1, int normType)
.. ocv:function:: double gpu::norm(InputArray src1, int normType, GpuMat& buf)
.. ocv:function:: double cuda::norm(InputArray src1, int normType, GpuMat& buf)
.. ocv:function:: double gpu::norm(InputArray src1, int normType, InputArray mask, GpuMat& buf)
.. ocv:function:: double cuda::norm(InputArray src1, int normType, InputArray mask, GpuMat& buf)
.. ocv:function:: double gpu::norm(InputArray src1, InputArray src2, int normType=NORM_L2)
.. ocv:function:: double cuda::norm(InputArray src1, InputArray src2, int normType=NORM_L2)
:param src1: Source matrix. Any matrices except 64F are supported.
@@ -31,15 +31,15 @@ Returns the norm of a matrix (or difference of two matrices).
gpu::sum
--------
cuda::sum
---------
Returns the sum of matrix elements.
.. ocv:function:: Scalar gpu::sum(InputArray src)
.. ocv:function:: Scalar cuda::sum(InputArray src)
.. ocv:function:: Scalar gpu::sum(InputArray src, GpuMat& buf)
.. ocv:function:: Scalar cuda::sum(InputArray src, GpuMat& buf)
.. ocv:function:: Scalar gpu::sum(InputArray src, InputArray mask, GpuMat& buf)
.. ocv:function:: Scalar cuda::sum(InputArray src, InputArray mask, GpuMat& buf)
:param src: Source image of any depth except for ``CV_64F`` .
@@ -51,15 +51,15 @@ Returns the sum of matrix elements.
gpu::absSum
-----------
cuda::absSum
------------
Returns the sum of absolute values for matrix elements.
.. ocv:function:: Scalar gpu::absSum(InputArray src)
.. ocv:function:: Scalar cuda::absSum(InputArray src)
.. ocv:function:: Scalar gpu::absSum(InputArray src, GpuMat& buf)
.. ocv:function:: Scalar cuda::absSum(InputArray src, GpuMat& buf)
.. ocv:function:: Scalar gpu::absSum(InputArray src, InputArray mask, GpuMat& buf)
.. ocv:function:: Scalar cuda::absSum(InputArray src, InputArray mask, GpuMat& buf)
:param src: Source image of any depth except for ``CV_64F`` .
@@ -69,15 +69,15 @@ Returns the sum of absolute values for matrix elements.
gpu::sqrSum
-----------
cuda::sqrSum
------------
Returns the squared sum of matrix elements.
.. ocv:function:: Scalar gpu::sqrSum(InputArray src)
.. ocv:function:: Scalar cuda::sqrSum(InputArray src)
.. ocv:function:: Scalar gpu::sqrSum(InputArray src, GpuMat& buf)
.. ocv:function:: Scalar cuda::sqrSum(InputArray src, GpuMat& buf)
.. ocv:function:: Scalar gpu::sqrSum(InputArray src, InputArray mask, GpuMat& buf)
.. ocv:function:: Scalar cuda::sqrSum(InputArray src, InputArray mask, GpuMat& buf)
:param src: Source image of any depth except for ``CV_64F`` .
@@ -87,13 +87,13 @@ Returns the squared sum of matrix elements.
gpu::minMax
-----------
cuda::minMax
------------
Finds global minimum and maximum matrix elements and returns their values.
.. ocv:function:: void gpu::minMax(InputArray src, double* minVal, double* maxVal=0, InputArray mask=noArray())
.. ocv:function:: void cuda::minMax(InputArray src, double* minVal, double* maxVal=0, InputArray mask=noArray())
.. ocv:function:: void gpu::minMax(InputArray src, double* minVal, double* maxVal, InputArray mask, GpuMat& buf)
.. ocv:function:: void cuda::minMax(InputArray src, double* minVal, double* maxVal, InputArray mask, GpuMat& buf)
:param src: Single-channel source image.
@@ -111,13 +111,13 @@ The function does not work with ``CV_64F`` images on GPUs with the compute capab
gpu::minMaxLoc
--------------
cuda::minMaxLoc
---------------
Finds global minimum and maximum matrix elements and returns their values with locations.
.. ocv:function:: void gpu::minMaxLoc(InputArray src, double* minVal, double* maxVal=0, Point* minLoc=0, Point* maxLoc=0, InputArray mask=noArray())
.. ocv:function:: void cuda::minMaxLoc(InputArray src, double* minVal, double* maxVal=0, Point* minLoc=0, Point* maxLoc=0, InputArray mask=noArray())
.. ocv:function:: void gpu::minMaxLoc(InputArray src, double* minVal, double* maxVal, Point* minLoc, Point* maxLoc, InputArray mask, GpuMat& valbuf, GpuMat& locbuf)
.. ocv:function:: void cuda::minMaxLoc(InputArray src, double* minVal, double* maxVal, Point* minLoc, Point* maxLoc, InputArray mask, GpuMat& valbuf, GpuMat& locbuf)
:param src: Single-channel source image.
@@ -141,13 +141,13 @@ Finds global minimum and maximum matrix elements and returns their values with l
gpu::countNonZero
-----------------
cuda::countNonZero
------------------
Counts non-zero matrix elements.
.. ocv:function:: int gpu::countNonZero(InputArray src)
.. ocv:function:: int cuda::countNonZero(InputArray src)
.. ocv:function:: int gpu::countNonZero(InputArray src, GpuMat& buf)
.. ocv:function:: int cuda::countNonZero(InputArray src, GpuMat& buf)
:param src: Single-channel source image.
@@ -159,11 +159,11 @@ The function does not work with ``CV_64F`` images on GPUs with the compute capab
gpu::reduce
-----------
cuda::reduce
------------
Reduces a matrix to a vector.
.. ocv:function:: void gpu::reduce(InputArray mtx, OutputArray vec, int dim, int reduceOp, int dtype = -1, Stream& stream = Stream::Null())
.. ocv:function:: void cuda::reduce(InputArray mtx, OutputArray vec, int dim, int reduceOp, int dtype = -1, Stream& stream = Stream::Null())
:param mtx: Source 2D matrix.
@@ -191,12 +191,12 @@ The function ``reduce`` reduces the matrix to a vector by treating the matrix ro
gpu::meanStdDev
---------------
cuda::meanStdDev
----------------
Computes a mean value and a standard deviation of matrix elements.
.. ocv:function:: void gpu::meanStdDev(InputArray mtx, Scalar& mean, Scalar& stddev)
.. ocv:function:: void gpu::meanStdDev(InputArray mtx, Scalar& mean, Scalar& stddev, GpuMat& buf)
.. ocv:function:: void cuda::meanStdDev(InputArray mtx, Scalar& mean, Scalar& stddev)
.. ocv:function:: void cuda::meanStdDev(InputArray mtx, Scalar& mean, Scalar& stddev, GpuMat& buf)
:param mtx: Source matrix. ``CV_8UC1`` matrices are supported for now.
@@ -210,11 +210,11 @@ Computes a mean value and a standard deviation of matrix elements.
gpu::rectStdDev
---------------
cuda::rectStdDev
----------------
Computes a standard deviation of integral images.
.. ocv:function:: void gpu::rectStdDev(InputArray src, InputArray sqr, OutputArray dst, Rect rect, Stream& stream = Stream::Null())
.. ocv:function:: void cuda::rectStdDev(InputArray src, InputArray sqr, OutputArray dst, Rect rect, Stream& stream = Stream::Null())
:param src: Source image. Only the ``CV_32SC1`` type is supported.
@@ -228,13 +228,13 @@ Computes a standard deviation of integral images.
gpu::normalize
--------------
cuda::normalize
---------------
Normalizes the norm or value range of an array.
.. ocv:function:: void gpu::normalize(InputArray src, OutputArray dst, double alpha = 1, double beta = 0, int norm_type = NORM_L2, int dtype = -1, InputArray mask = noArray())
.. ocv:function:: void cuda::normalize(InputArray src, OutputArray dst, double alpha = 1, double beta = 0, int norm_type = NORM_L2, int dtype = -1, InputArray mask = noArray())
.. ocv:function:: void gpu::normalize(InputArray src, OutputArray dst, double alpha, double beta, int norm_type, int dtype, InputArray mask, GpuMat& norm_buf, GpuMat& cvt_buf)
.. ocv:function:: void cuda::normalize(InputArray src, OutputArray dst, double alpha, double beta, int norm_type, int dtype, InputArray mask, GpuMat& norm_buf, GpuMat& cvt_buf)
:param src: Input array.
@@ -258,13 +258,13 @@ Normalizes the norm or value range of an array.
gpu::integral
-------------
cuda::integral
--------------
Computes an integral image.
.. ocv:function:: void gpu::integral(InputArray src, OutputArray sum, Stream& stream = Stream::Null())
.. ocv:function:: void cuda::integral(InputArray src, OutputArray sum, Stream& stream = Stream::Null())
.. ocv:function:: void gpu::integral(InputArray src, OutputArray sum, GpuMat& buffer, Stream& stream = Stream::Null())
.. ocv:function:: void cuda::integral(InputArray src, OutputArray sum, GpuMat& buffer, Stream& stream = Stream::Null())
:param src: Source image. Only ``CV_8UC1`` images are supported for now.
@@ -278,13 +278,13 @@ Computes an integral image.
gpu::sqrIntegral
----------------
cuda::sqrIntegral
-----------------
Computes a squared integral image.
.. ocv:function:: void gpu::sqrIntegral(InputArray src, OutputArray sqsum, Stream& stream = Stream::Null())
.. ocv:function:: void cuda::sqrIntegral(InputArray src, OutputArray sqsum, Stream& stream = Stream::Null())
.. ocv:function:: void gpu::sqrIntegral(InputArray src, OutputArray sqsum, GpuMat& buf, Stream& stream = Stream::Null())
.. ocv:function:: void cuda::sqrIntegral(InputArray src, OutputArray sqsum, GpuMat& buf, Stream& stream = Stream::Null())
:param src: Source image. Only ``CV_8UC1`` images are supported for now.