gpu docs minor changes
authorAlexey Spizhevoy <no@email>
Mon, 17 Jan 2011 11:34:20 +0000 (11:34 +0000)
committerAlexey Spizhevoy <no@email>
Mon, 17 Jan 2011 11:34:20 +0000 (11:34 +0000)
doc/gpu_image_processing.tex
doc/gpu_initialization.tex
doc/gpu_matrix_operations.tex
doc/gpu_matrix_reductions.tex

index 8b9ff28..8436213 100644 (file)
@@ -19,7 +19,7 @@ Performs mean-shift filtering.
 \r
 \r
 \cvCppFunc{gpu::meanShiftProc}\r
-Performs mean-shift procedure and stores information about converged points in two images..\r
+Performs mean-shift procedure and stores information about converged points in two images.\r
 \r
 \cvdefCpp{void meanShiftProc(const GpuMat\& src, GpuMat\& dstr, GpuMat\& dstsp,\par\r
   int sp, int sr,\par\r
@@ -55,7 +55,7 @@ Performs mean-shift segmentation of the source image and eleminates small segmen
 \r
 \r
 \cvCppFunc{gpu::integral}\r
-Computes the integral image and squared integral image.\r
+Computes integral image and squared integral image.\r
 \r
 \cvdefCpp{void integral(const GpuMat\& src, GpuMat\& sum);\newline\r
 void integral(const GpuMat\& src, GpuMat\& sum, GpuMat\& sqsum);}\r
@@ -172,15 +172,15 @@ Performs a forward or inverse discrete Fourier transform (1D or 2D) of floating
 \cvdefCpp{void dft(const GpuMat\& src, GpuMat\& dst, Size dft\_size, int flags=0);}\r
 \r
 \begin{description}\r
-\cvarg{src}{Real of complex source matrix.}\r
-\cvarg{dst}{Real or complex destination matrix.}\r
+\cvarg{src}{Source matrix (real or complex).}\r
+\cvarg{dst}{Destination matrix (real or complex).}\r
 \cvarg{dft\_size}{Size of discrete Fourier transform.}\r
 \cvarg{flags}{Optional flags:\r
 \begin{description}\r
   \cvarg{DFT\_ROWS}{Transform each individual row of the source matrix.}\r
   \cvarg{DFT\_SCALE}{Scale the result: divide it by the number of elements in the transform (it's obtained from \texttt{dft\_size}).\r
-  \cvarg{DFT\_INVERSE}{Inverse DFT must be perfromed for complex-complex case (real-complex and  complex-real cases are respectively forward and inverse always).}}\r
-  \cvarg{DFT\_REAL\_OUTPUT}{The source matrix is the result of real-complex transform and the destination matrix must be real.}\r
+  \cvarg{DFT\_INVERSE}{Inverse DFT must be perfromed for complex-complex case (real-complex and complex-real cases are respectively forward and inverse always).}}\r
+  \cvarg{DFT\_REAL\_OUTPUT}{The source matrix is the result of real-complex transform, so the destination matrix must be real.}\r
 \end{description}}\r
 \end{description}\r
 \r
@@ -231,14 +231,14 @@ private:
 \cvCppFunc{gpu::ConvolveBuf::ConvolveBuf}\r
 \r
 \cvdefCpp{ConvolveBuf();}\r
-Construct empty buffer which will be properly resized after first call of the convolve function.\r
+Constructs an empty buffer which will be properly resized after first call of the convolve function.\r
 \r
 \cvdefCpp{ConvolveBuf(Size image\_size, Size templ\_size);}\r
-Construct buffer for the convolve function with respectively arguments.\r
+Constructs a buffer for the convolve function with respectively arguments.\r
 \r
 \r
 \cvCppFunc{gpu::matchTemplate}\r
-Computes the proximity map for the raster template and the image where the template is searched for.\r
+Computes a proximity map for a raster template and an image where the template is searched for.\r
 \r
 \cvdefCpp{void matchTemplate(const GpuMat\& image, const GpuMat\& templ,\par\r
   GpuMat\& result, int method);}\r
@@ -246,15 +246,15 @@ Computes the proximity map for the raster template and the image where the templ
 \begin{description}\r
 \cvarg{image}{Source image. 32F and 8U images (1..4 channels) are supported for now.}\r
 \cvarg{templ}{Template image. Must have the same size and type as \texttt{image}.}\r
-\cvarg{result}{A map of comparison results (32FC1). If \texttt{image} is $W \times H$ and\r
+\cvarg{result}{Map containing comparison results (32FC1). If \texttt{image} is $W \times H$ and\r
 \texttt{templ} is $w \times h$ then \texttt{result} must be $(W-w+1) \times (H-h+1)$.}\r
-\cvarg{method}{Specifies the way the template must be compared with the image.}\r
+\cvarg{method}{Specifies the way which the template must be compared with the image.}\r
 \end{description}\r
-Following methods are supported for 8U images for now:\r
+Following methods are supported for the 8U images for now:\r
 \begin{itemize}\r
 \item CV\_TM\_SQDIFF \item CV\_TM\_SQDIFF\_NORMED \item CV\_TM\_CCORR \item CV\_TM\_CCORR\_NORMED \item CV\_TM\_CCOEFF \item CV\_TM\_CCOEFF\_NORMED \r
 \end{itemize}\r
-Following methods are supported for 32F images for now:\r
+Following methods are supported for the 32F images for now:\r
 \begin{itemize}\r
 \item CV\_TM\_SQDIFF \item CV\_TM\_CCORR\r
 \end{itemize}\r
index 9c12163..92ff89b 100644 (file)
@@ -42,7 +42,7 @@ Returns number of Streaming Multiprocessors for given device.
 
 
 \cvCppFunc{gpu::getGpuMemInfo}
-Returns free and total memory for current device.
+Returns free and total memory for the current device.
 
 \cvdefCpp{void getGpuMemInfo(size\_t\& free, size\_t\& total);}
 \begin{description}
@@ -52,7 +52,7 @@ Returns free and total memory for current device.
 
 
 \cvCppFunc{gpu::hasNativeDoubleSupport}
-Returns true if current GPU has native double support, false otherwise.
+Returns true if the specified GPU has native double support, false otherwise.
 
 \cvdefCpp{bool hasNativeDoubleSupport(int device);}
 \begin{description}
@@ -61,7 +61,7 @@ Returns true if current GPU has native double support, false otherwise.
 
 
 \cvCppFunc{gpu::hasAtomicsSupport}
-Returns true if current GPU has atomics support, false otherwise.
+Returns true if the specified GPU has atomics support, false otherwise.
 
 \cvdefCpp{bool hasAtomicsSupport(int device);}
 \begin{description}
index e69c9e2..a00f26d 100644 (file)
@@ -2,7 +2,7 @@
 \r
 \r
 \cvCppFunc{gpu::transpose}\r
-Transposes the matrix.\r
+Transposes a matrix.\r
 \r
 \cvdefCpp{void transpose(const GpuMat\& src, GpuMat\& dst);}\r
 \begin{description}\r
@@ -32,7 +32,7 @@ See also: \cvCppCross{flip}.
 \r
 \r
 \cvCppFunc{gpu::LUT}\r
-Transforms source matrix into destination matrix using given look-up table: \texttt{dst(I) = lut(src(I))}.\r
+Transforms the source matrix into the destination matrix using given look-up table: \texttt{dst(I) = lut(src(I))}.\r
 \r
 \cvdefCpp{void LUT(const GpuMat\& src, const Mat\& lut, GpuMat\& dst);}\r
 \begin{description}\r
@@ -45,7 +45,7 @@ See also: \cvCppCross{LUT}.
 \r
 \r
 \cvCppFunc{gpu::merge}\r
-Makes multi-channel matrix out of several single-channel matrices.\r
+Makes multi-channel matrix out of several single-channel matrices.\r
 \r
 \cvdefCpp{void merge(const GpuMat* src, size\_t n, GpuMat\& dst);\newline\r
 void merge(const GpuMat* src, size\_t n, GpuMat\& dst,\par\r
@@ -93,7 +93,7 @@ See also: \cvCppCross{split}.
 \r
 \r
 \cvCppFunc{gpu::magnitude}\r
-Computes magnitude of complex vector.\r
+Computes magnitudes of complex matrix elements.\r
 \r
 \cvdefCpp{void magnitude(const GpuMat\& x, GpuMat\& magnitude);}\r
 \begin{description}\r
@@ -115,7 +115,7 @@ See also: \cvCppCross{magnitude}.
 \r
 \r
 \cvCppFunc{gpu::magnitudeSqr}\r
-Computes squared magnitude of complex vector.\r
+Computes squared magnitudes of complex matrix elements.\r
 \r
 \cvdefCpp{void magnitudeSqr(const GpuMat\& x, GpuMat\& magnitude);}\r
 \begin{description}\r
@@ -135,7 +135,7 @@ void magnitudeSqr(const GpuMat\& x, const GpuMat\& y, GpuMat\& magnitude,\par
 \r
 \r
 \cvCppFunc{gpu::phase}\r
-Computes polar angle of each complex value.\r
+Computes polar angles of complex matrix elements.\r
 \r
 \cvdefCpp{void phase(const GpuMat\& x, const GpuMat\& y, GpuMat\& angle,\par\r
   bool angleInDegrees=false);\newline\r
index e0eb552..acd9706 100644 (file)
@@ -23,7 +23,8 @@ Returns norm of matrix (or of two matrices difference).
 \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
+\cvdefCpp{double norm(const GpuMat\& src1, const GpuMat\& src2,\par\r
+  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