Minor fixes in documentation
authorIlya Lysenkov <no@email>
Tue, 19 Oct 2010 13:44:57 +0000 (13:44 +0000)
committerIlya Lysenkov <no@email>
Tue, 19 Oct 2010 13:44:57 +0000 (13:44 +0000)
doc/features2d_object_detection.tex
doc/features2d_object_recognition.tex
doc/highgui_qt.tex
doc/online-opencv.tex
doc/opencvref_body.tex

index f6d511c128ba13003777e423e5132d83e68c246d..b8ce9f9ae5e79498e23b626a0270ba5535890f90 100644 (file)
@@ -1,6 +1,5 @@
 \section{Object detection and descriptors}
 \ifCpp
-
 \cvclass{RandomizedTree}
 The class contains base structure for \texttt{RTreeClassifier}
 
@@ -95,7 +94,7 @@ void train(std::vector<BaseKeypoint> const\& base\_set, cv::RNG \&rng,
 \cvarg{num\_quant\_bits} {Number of bits are used for quantization}
 \end{description}              
 
-\cvCppFunc {RandomizedTree::read}
+\cvCppFunc{RandomizedTree::read}
 Reads pre-saved randomized tree from file or stream
 \cvdefCpp{read(const char* file\_name, int num\_quant\_bits)}  
 \cvdefCpp{read(std::istream \&is, int num\_quant\_bits)}       
@@ -105,7 +104,7 @@ Reads pre-saved randomized tree from file or stream
 \cvarg{num\_quant\_bits} {Number of bits are used for quantization}
 \end{description}
 
-\cvCppFunc {RandomizedTree::write}
+\cvCppFunc{RandomizedTree::write}
 Writes current randomized tree to a file or stream
 \cvdefCpp{void write(const char* file\_name) const;}   
 \cvdefCpp{void write(std::ostream \&os) const;}        
@@ -115,7 +114,7 @@ Writes current randomized tree to a file or stream
 \end{description}
 
 
-\cvCppFunc {RandomizedTree::applyQuantization}
+\cvCppFunc{RandomizedTree::applyQuantization}
 Applies quantization to the current randomized tree
 \cvdefCpp{void applyQuantization(int num\_quant\_bits)}
 \begin{description}
@@ -285,7 +284,7 @@ static int countNonZeroElements(float *vec, int n, double tol=1e-10);
 \cvarg{tol} {The threshold used for elements counting. We take all elements are less than \texttt{tol} as zero elements}
 \end{description}
 
-\cvCppFunc {RTreeClassifier::read}
+\cvCppFunc{RTreeClassifier::read}
 Reads pre-saved RTreeClassifier from file or stream
 \cvdefCpp{read(const char* file\_name)}        
 \cvdefCpp{read(std::istream \&is)}     
@@ -294,7 +293,7 @@ Reads pre-saved RTreeClassifier from file or stream
 \cvarg{is}{Input stream associated with file contains randomized tree data}
 \end{description}
 
-\cvCppFunc {RTreeClassifier::write}
+\cvCppFunc{RTreeClassifier::write}
 Writes current RTreeClassifier to a file or stream
 \cvdefCpp{void write(const char* file\_name) const;}   
 \cvdefCpp{void write(std::ostream \&os) const;}        
@@ -304,7 +303,7 @@ Writes current RTreeClassifier to a file or stream
 \end{description}
 
 
-\cvCppFunc {RTreeClassifier::setQuantization}
+\cvCppFunc{RTreeClassifier::setQuantization}
 Applies quantization to the current randomized tree
 \cvdefCpp{void setQuantization(int num\_quant\_bits)}
 \begin{description}
@@ -400,5 +399,4 @@ for(i=0; i < imageKeypoints->total; i++)
 }
        
 \end{lstlisting}
-
 \fi
index 56470dfb5743401d6805d3acca49921917d3f283..b599c1e2c4c85b1435b1fd0376797acfdc2f2765 100755 (executable)
@@ -2,7 +2,11 @@
 
 \subsection{Bag of Visual Words Matching}
 
-The functions and classes described in this section are used to allow OpenCV's 2D feature descriptors to be used in a bag of words framework, first described in \cite{sivic_zisserman_2003}.
+%The functions and classes described in this section are used to allow OpenCV's
+%2D feature descriptors to be used in a bag of words framework, first described
+%in \cite{sivic_zisserman_2003}.
+
+\ifCpp
 
 \cvclass{BasicBOWTrainer}
 Class used for training visual vocabularies using the bag of words approach.
@@ -660,3 +664,5 @@ public:
         vector<KeyPoint>& keypoints, Mat& descriptors) const;
 };
 \end{lstlisting}
+
+\fi
\ No newline at end of file
index 55e8599de8b4280bdefc7f5dc8a6980b0e40f6a1..e900f5279882bbda73cf418bb1af47d739e79e13 100644 (file)
@@ -523,7 +523,7 @@ cvAddText( img1, ``Hello World !'', cvPoint(50,50), font);
 \end{lstlisting}\r
 \r
 \r
-\cvCPyFunc{addText}\r
+\cvCPyFunc{AddText}\r
 Create the font to be used to draw text on an image \r
 \cvdefC{void cvAddText(const CvArr* img, const char* text, CvPoint location, CvFont *font);}\r
 \r
@@ -538,7 +538,7 @@ The function \texttt{cvAddText} draw \emph{text} on the image \emph{img} using a
 \r
 \r
 %CVAPI(void) cvDisplayOverlay(const char* name, const char* text, int delay);\r
-\cvCPyFunc{displayOverlay}\r
+\cvCPyFunc{DisplayOverlay}\r
 Display text on the window's image as an overlay for delay milliseconds. This is not editing the image's data. The text is display on the top of the image.\r
 \cvdefC{void cvDisplayOverlay(const char* name, const char* text, int delay);}\r
 \r
@@ -552,7 +552,7 @@ The function \texttt{cvDisplayOverlay} aims at displaying useful information/tip
 \r
 \r
 %CVAPI(void) cvDisplayStatusBar(const char* name, const char* text, int delayms);\r
-\cvCPyFunc{displayStatusBar}\r
+\cvCPyFunc{DisplayStatusBar}\r
 Display text on the window's statusbar as for delay milliseconds.\r
 \cvdefC{void cvDisplayStatusBar(const char* name, const char* text, int delayms);}\r
 \r
@@ -567,7 +567,7 @@ The function \texttt{cvDisplayOverlay} aims at displaying useful information/tip
 \r
 \r
 %CVAPI(void) cvCreateOpenGLCallback( const char* window_name, CvOpenGLCallback callbackOpenGL, void* userdata CV_DEFAULT(NULL), double angle CV_DEFAULT(-1), double zmin CV_DEFAULT(-1), double zmax CV_DEFAULT(-1));\r
-\cvCPyFunc{createOpenGLCallback}\r
+\cvCPyFunc{CreateOpenGLCallback}\r
 Create a callback function called to draw OpenGL on top the the image display by \emph{window\_name}.\r
 \cvdefC{void cvCreateOpenGLCallback( const char* window\_name, CvOpenGLCallback callbackOpenGL, void* userdata CV\_DEFAULT(NULL), double angle CV\_DEFAULT(-1), double zmin CV\_DEFAULT(-1), double zmax CV\_DEFAULT(-1);}\r
 \r
@@ -621,7 +621,7 @@ CV_EXTERN_C_FUNCPTR( *CvOpenGLCallback)(void* userdata));
 \r
 \r
 %CVAPI(void) cvSaveWindowParameters(const char* name);\r
-\cvCPyFunc{saveWindowParameters}\r
+\cvCPyFunc{SaveWindowParameters}\r
 Save parameters of the window \emph{window\_name}.\r
 \cvdefC{void cvSaveWindowParameters(const char* name);}\r
 \r
@@ -633,7 +633,7 @@ The function \texttt{cvSaveWindowParameters} saves size, location, flags,  track
 \r
 \r
 %CVAPI(void) cvLoadWindowParameters(const char* name);\r
-\cvCPyFunc{loadWindowParameters}\r
+\cvCPyFunc{LoadWindowParameters}\r
 Load parameters of the window \emph{window\_name}.\r
 \cvdefC{void cvLoadWindowParameters(const char* name);}\r
 \r
@@ -645,7 +645,7 @@ The function \texttt{cvLoadWindowParameters} load size, location, flags,  trackb
 \r
 \r
 %CVAPI(int) cvCreateButton( const char* button_name CV_DEFAULT(NULL),CvButtonCallback on_change CV_DEFAULT(NULL), void* userdata CV_DEFAULT(NULL) , int button_type CV_DEFAULT(CV_PUSH_BUTTON), int initial_button_state CV_DEFAULT(0));\r
-\cvCPyFunc{createButton}\r
+\cvCPyFunc{CreateButton}\r
 Create a callback function called to draw OpenGL on top the the image display by \emph{window\_name}.\r
 \cvdefC{cvCreateButton( const char* button\_name CV\_DEFAULT(NULL),CvButtonCallback on\_change CV\_DEFAULT(NULL), void* userdata CV\_DEFAULT(NULL) , int button\_type CV\_DEFAULT(CV\_PUSH\_BUTTON), int initial\_button\_state CV\_DEFAULT(0);}\r
 \r
index 25245525f410f2b7b884c750992124a19d54a500..91bfcd84ce12123f1ff870424c255a71c3ffe365 100644 (file)
 \tableofcontents
 
 %%% Chapters %%%
-\input{core_introduction}
-
-\chapter{core. The Core Functionality}
-\input{core_basic_structures}
-\input{core_array_operations}
-\input{core_dynamic_structures}
-\input{core_drawing_functions}
-\input{core_persistence}
-\input{core_clustering_search}
-\input{core_utilities_system_functions}
-
-
-\chapter{imgproc. Image Processing}
-\input{imgproc_histograms}
-\input{imgproc_image_filtering}
-\input{imgproc_image_warping}
-\input{imgproc_image_transform}
-\input{imgproc_struct_shape_analysis}
-\input{imgproc_planar_subdivisions}
-\input{imgproc_motion_tracking}
-\input{imgproc_feature_detection}
-
-\chapter{features2d. Feature Detection and Descriptor Extraction}
-\input{features2d_feature_detection}
-%\input{features2d_object_recognition}
-%\input{features2d_object_detection}
-
-\chapter{flann. Clustering and Search in Multi-Dimensional Spaces}
-\input{flann}
-
-\chapter{objdetect. Object Detection}
-\input{objdetect}
-
-\chapter{video. Video Analysis}
-\input{video_motion_tracking}
-
-\chapter{highgui. High-level GUI and Media I/O}
-\input{highgui}
-\ifPy     %Qt is for C and Cpp, so do nothing
-\else
-\input{highgui_qt}
-\fi
-
-\chapter{calib3d. Camera Calibration, Pose Estimation and Stereo}
-\input{calib3d}
-
-
-\chapter{ml. Machine Learning}
-\input{ml}
+\input{opencvref_body}
 %%%%%%%%%%%%%%%%
 
 \end{document}             % End of document.
index 778a14c14b936c2e9b223d3f7bdec8276718287a..6808ff54fea5d479d0c0992d0537319552375713 100644 (file)
@@ -19,6 +19,7 @@
 \input{imgproc_planar_subdivisions}
 \input{imgproc_motion_tracking}
 \input{imgproc_feature_detection}
+\input{imgproc_object_detection}
 
 \chapter{features2d. Feature Detection and Descriptor Extraction}
 \input{features2d_feature_detection}