finished gpu module docs for matrix operations
authorAlexey Spizhevoy <no@email>
Mon, 17 Jan 2011 09:27:01 +0000 (09:27 +0000)
committerAlexey Spizhevoy <no@email>
Mon, 17 Jan 2011 09:27:01 +0000 (09:27 +0000)
doc/gpu_data_structures.tex
doc/gpu_matrix_operations.tex
doc/gpu_object_detection.tex

index 075f07f..68a2ddd 100644 (file)
@@ -9,5 +9,5 @@ Creates continuous matrix in GPU memory.
 \cvarg{rows}{Row count.}\r
 \cvarg{cols}{Column count.}\r
 \cvarg{type}{Type of the matrix.}\r
-\cvarg{m}{Destination matrix. Will be reshaped only if it has proper type and area ($rows \times cols$).}\r
+\cvarg{m}{Destination matrix. Will be only reshaped if it has proper type and area (\texttt{rows} $\times$ \texttt{cols}).}\r
 \end{description}
\ No newline at end of file
index cc25309..e69c9e2 100644 (file)
@@ -6,7 +6,7 @@ Transposes the matrix.
 \r
 \cvdefCpp{void transpose(const GpuMat\& src, GpuMat\& dst);}\r
 \begin{description}\r
-\cvarg{src}{Source matrix. Elements sizes 1, 4, 8 bytes are supported for now.}\r
+\cvarg{src}{Source matrix. 1, 4, 8 bytes element sizes are supported for now.}\r
 \cvarg{dst}{Destination matrix.}\r
 \end{description}\r
 \r
@@ -30,20 +30,40 @@ Flips a 2D matrix around vertical, horizontal or both axes.
 \r
 See also: \cvCppCross{flip}.\r
 \r
+\r
+\cvCppFunc{gpu::LUT}\r
+Transforms source matrix into 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
+\cvarg{src}{Source matrix. 8UC1 and 8UC3 matrixes are supported for now.}\r
+\cvarg{lut}{Look-up table. Must be continuous, 8U depth matrix. Its area must satisfy to \texttt{lut.rows} $\times$ \texttt{lut.cols} = 256.}\r
+\cvarg{dst}{Destination matrix. Will have the same depth as \texttt{lut} and the same number of channels as \texttt{src}.}\r
+\end{description}\r
+\r
+See also: \cvCppCross{LUT}.\r
+\r
+\r
 \cvCppFunc{gpu::merge}\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
-  const Stream\& stream);\newline\newline\r
-void merge(const vector$<$GpuMat$>$\& src, GpuMat\& dst);\newline\r
+  const Stream\& stream);\newline}\r
+\begin{description}\r
+\cvarg{src}{Pointer to array of the source matrices.}\r
+\cvarg{n}{Number of source matrices.}\r
+\cvarg{dst}{Destination matrix.}\r
+\cvarg{stream}{Stream for the asynchronous version.}\r
+\end{description}\r
+\r
+\cvdefCpp{void merge(const vector$<$GpuMat$>$\& src, GpuMat\& dst);\newline\r
 void merge(const vector$<$GpuMat$>$\& src, GpuMat\& dst,\par\r
   const Stream\& stream);}\r
 \begin{description}\r
-\cvarg{src}{Vector or pointer to array of the source matrices.}\r
-\cvarg{n}{Number of source matrices.}\r
+\cvarg{src}{Vector of the source matrices.}\r
 \cvarg{dst}{Destination matrix.}\r
-\cvarg{stream}{Stream for the asynchronous versions.}\r
+\cvarg{stream}{Stream for the asynchronous version.}\r
 \end{description}\r
 \r
 See also: \cvCppCross{merge}.\r
@@ -53,14 +73,20 @@ See also: \cvCppCross{merge}.
 Copies each plane of a multi-channel matrix into an array.\r
 \r
 \cvdefCpp{void split(const GpuMat\& src, GpuMat* dst);\newline\r
-void split(const GpuMat\& src, GpuMat* dst, const Stream\& stream);\newline\newline\r
-void split(const GpuMat\& src, vector$<$GpuMat$>$\& dst);\newline\r
+void split(const GpuMat\& src, GpuMat* dst, const Stream\& stream);}\r
+\begin{description}\r
+\cvarg{src}{Source matrix.}\r
+\cvarg{dst}{Pointer to array of single-channel matrices.}\r
+\cvarg{stream}{Stream for the asynchronous version.}\r
+\end{description}\r
+\r
+\cvdefCpp{void split(const GpuMat\& src, vector$<$GpuMat$>$\& dst);\newline\r
 void split(const GpuMat\& src, vector$<$GpuMat$>$\& dst,\par\r
   const Stream\& stream);}\r
 \begin{description}\r
 \cvarg{src}{Source matrix.}\r
-\cvarg{dst}{Destination vector or pointer to array of single-channel matrices.}\r
-\cvarg{stream}{Stream for the asynchronous versions.}\r
+\cvarg{dst}{Destination vector of single-channel matrices.}\r
+\cvarg{stream}{Stream for the asynchronous version.}\r
 \end{description}\r
 \r
 See also: \cvCppCross{split}.\r
index 70e88d2..bf828e4 100644 (file)
@@ -132,7 +132,7 @@ Perfroms object detection without increasing detection window.
 \r
 \r
 \cvCppFunc{gpu::HOGDescriptor::detectMultiScale}\r
-Perfroms object detection with increasing detection window.\r
+Perfroms object detection several times with preliminary increase of detection window.\r
 \r
 \cvdefCpp{void detectMultiScale(const GpuMat\& img, vector<Rect>\& found\_locations,\par\r
                       double hit\_threshold=0, Size win\_stride=Size(),\par\r