finished gpu module docs for matrix reductions
authorAlexey Spizhevoy <no@email>
Mon, 17 Jan 2011 08:39:08 +0000 (08:39 +0000)
committerAlexey Spizhevoy <no@email>
Mon, 17 Jan 2011 08:39:08 +0000 (08:39 +0000)
doc/gpu_matrix_reductions.tex

index ed2299b..e0eb552 100644 (file)
@@ -1,8 +1,40 @@
 \section{Matrix Reductions}\r
 \r
 \r
+\cvCppFunc{gpu::meanStdDev}\r
+Computes mean value and standard deviation of matrix elements.\r
+\r
+\cvdefCpp{void meanStdDev(const GpuMat\& mtx, Scalar\& mean, Scalar\& stddev);}\r
+\begin{description}\r
+\cvarg{mtx}{Source matrix. 8UC1 matrices are supported for now.}\r
+\cvarg{mean}{Mean value.}\r
+\cvarg{stddev}{Standard deviation value.}\r
+\end{description}\r
+\r
+See also: \cvCppCross{meanStdDev}.\r
+\r
+\r
+\cvCppFunc{gpu::norm}\r
+Returns norm of matrix (or of two matrices difference).\r
+\r
+\cvdefCpp{double norm(const GpuMat\& src1, int normType=NORM\_L2);}\r
+\begin{description}\r
+\cvarg{src1}{Source matrix. 8UC1 matrices are supported for now.}\r
+\cvarg{normType}{Norm type. \texttt{NORM\_L1}, \texttt{NORM\_L2} and \texttt{NORM\_INF} are supported for now.}\r
+\end{description}\r
+\r
+\cvdefCpp{double norm(const GpuMat\& src1, const GpuMat\& src2, int normType=NORM\_L2);}\r
+\begin{description}\r
+\cvarg{src1}{First source matrix. 8UC1 matrices are supported for now.}\r
+\cvarg{src2}{Second source matrix. Must have the same size and type as \texttt{src1}}.\r
+\cvarg{normType}{Norm type. \texttt{NORM\_L1}, \texttt{NORM\_L2} and \texttt{NORM\_INF} are supported for now.}\r
+\end{description}\r
+\r
+See also: \cvCppCross{norm}.\r
+\r
+\r
 \cvCppFunc{gpu::sum}\r
-Returns sum of array elements.\r
+Returns sum of matrix elements.\r
 \r
 \cvdefCpp{Scalar sum(const GpuMat\& src);\newline\r
 Scalar sum(const GpuMat\& src, GpuMat\& buf);}\r
@@ -16,7 +48,7 @@ See also: \cvCppCross{sum}.
 \r
 \r
 \cvCppFunc{gpu::sqrSum}\r
-Returns squared sum of array elements.\r
+Returns squared sum of matrix elements.\r
 \r
 \cvdefCpp{Scalar sqrSum(const GpuMat\& src);\newline\r
 Scalar sqrSum(const GpuMat\& src, GpuMat\& buf);}\r
@@ -27,7 +59,7 @@ Scalar sqrSum(const GpuMat\& src, GpuMat\& buf);}
 \r
 \r
 \cvCppFunc{gpu::minMax}\r
-Finds global minimum and maximum array elements and returns their values.\r
+Finds global minimum and maximum matrix elements and returns their values.\r
 \r
 \cvdefCpp{void minMax(const GpuMat\& src, double* minVal,\par\r
   double* maxVal=0, const GpuMat\& mask=GpuMat());\newline\r
@@ -37,7 +69,7 @@ void minMax(const GpuMat\& src, double* minVal, double* maxVal,\par
 \cvarg{src}{Single-channel source image.}\r
 \cvarg{minVal}{Pointer to returned minimum value. \texttt{NULL} if not required.}\r
 \cvarg{maxVal}{Pointer to returned maximum value. \texttt{NULL} if not required.}\r
-\cvarg{mask}{Optional mask to select a sub-array.}\r
+\cvarg{mask}{Optional mask to select a sub-matrix.}\r
 \cvarg{buf}{Optional buffer. It's resized automatically.}\r
 \end{description}\r
 \r
@@ -46,7 +78,7 @@ See also: \cvCppCross{minMaxLoc}.
 \r
 \r
 \cvCppFunc{gpu::minMaxLoc}\r
-Finds global minimum and maximum array elements and returns their values with locations.\r
+Finds global minimum and maximum matrix elements and returns their values with locations.\r
 \r
 \cvdefCpp{void minMaxLoc(const GpuMat\& src, double\* minVal, double* maxVal=0,\par\r
   Point* minLoc=0, Point* maxLoc=0,\par\r
@@ -60,7 +92,7 @@ void minMaxLoc(const GpuMat\& src, double* minVal, double* maxVal,\par
 \cvarg{maxVal}{Pointer to returned maximum value. \texttt{NULL} if not required.}\r
 \cvarg{minValLoc}{Pointer to returned minimum location. \texttt{NULL} if not required.}\r
 \cvarg{maxValLoc}{Pointer to returned maximum location. \texttt{NULL} if not required.}\r
-\cvarg{mask}{Optional mask to select a sub-array.}\r
+\cvarg{mask}{Optional mask to select a sub-matrix.}\r
 \cvarg{valbuf}{Optional values buffer. It's resized automatically.}\r
 \cvarg{locbuf}{Optional location buffer. It's resized automatically.}\r
 \end{description}\r
@@ -70,7 +102,7 @@ See also: \cvCppCross{minMaxLoc}.
 \r
 \r
 \cvCppFunc{gpu::countNonZero}\r
-Counts non-zero array elements.\r
+Counts non-zero matrix elements.\r
 \r
 \cvdefCpp{int countNonZero(const GpuMat\& src);\newline\r
 int countNonZero(const GpuMat\& src, GpuMat\& buf);}\r