Minor fixes in documentation

This commit is contained in:
Ilya Lysenkov 2010-10-19 13:44:57 +00:00
parent 8af83e6d37
commit e41c6a35b8
5 changed files with 22 additions and 65 deletions

View File

@ -1,6 +1,5 @@
\section{Object detection and descriptors} \section{Object detection and descriptors}
\ifCpp \ifCpp
\cvclass{RandomizedTree} \cvclass{RandomizedTree}
The class contains base structure for \texttt{RTreeClassifier} The class contains base structure for \texttt{RTreeClassifier}
@ -400,5 +399,4 @@ for(i=0; i < imageKeypoints->total; i++)
} }
\end{lstlisting} \end{lstlisting}
\fi \fi

View File

@ -2,7 +2,11 @@
\subsection{Bag of Visual Words Matching} \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} \cvclass{BasicBOWTrainer}
Class used for training visual vocabularies using the bag of words approach. Class used for training visual vocabularies using the bag of words approach.
@ -660,3 +664,5 @@ public:
vector<KeyPoint>& keypoints, Mat& descriptors) const; vector<KeyPoint>& keypoints, Mat& descriptors) const;
}; };
\end{lstlisting} \end{lstlisting}
\fi

View File

@ -523,7 +523,7 @@ cvAddText( img1, ``Hello World !'', cvPoint(50,50), font);
\end{lstlisting} \end{lstlisting}
\cvCPyFunc{addText} \cvCPyFunc{AddText}
Create the font to be used to draw text on an image Create the font to be used to draw text on an image
\cvdefC{void cvAddText(const CvArr* img, const char* text, CvPoint location, CvFont *font);} \cvdefC{void cvAddText(const CvArr* img, const char* text, CvPoint location, CvFont *font);}
@ -538,7 +538,7 @@ The function \texttt{cvAddText} draw \emph{text} on the image \emph{img} using a
%CVAPI(void) cvDisplayOverlay(const char* name, const char* text, int delay); %CVAPI(void) cvDisplayOverlay(const char* name, const char* text, int delay);
\cvCPyFunc{displayOverlay} \cvCPyFunc{DisplayOverlay}
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. 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.
\cvdefC{void cvDisplayOverlay(const char* name, const char* text, int delay);} \cvdefC{void cvDisplayOverlay(const char* name, const char* text, int delay);}
@ -552,7 +552,7 @@ The function \texttt{cvDisplayOverlay} aims at displaying useful information/tip
%CVAPI(void) cvDisplayStatusBar(const char* name, const char* text, int delayms); %CVAPI(void) cvDisplayStatusBar(const char* name, const char* text, int delayms);
\cvCPyFunc{displayStatusBar} \cvCPyFunc{DisplayStatusBar}
Display text on the window's statusbar as for delay milliseconds. Display text on the window's statusbar as for delay milliseconds.
\cvdefC{void cvDisplayStatusBar(const char* name, const char* text, int delayms);} \cvdefC{void cvDisplayStatusBar(const char* name, const char* text, int delayms);}
@ -567,7 +567,7 @@ The function \texttt{cvDisplayOverlay} aims at displaying useful information/tip
%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)); %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));
\cvCPyFunc{createOpenGLCallback} \cvCPyFunc{CreateOpenGLCallback}
Create a callback function called to draw OpenGL on top the the image display by \emph{window\_name}. Create a callback function called to draw OpenGL on top the the image display by \emph{window\_name}.
\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);} \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);}
@ -621,7 +621,7 @@ CV_EXTERN_C_FUNCPTR( *CvOpenGLCallback)(void* userdata));
%CVAPI(void) cvSaveWindowParameters(const char* name); %CVAPI(void) cvSaveWindowParameters(const char* name);
\cvCPyFunc{saveWindowParameters} \cvCPyFunc{SaveWindowParameters}
Save parameters of the window \emph{window\_name}. Save parameters of the window \emph{window\_name}.
\cvdefC{void cvSaveWindowParameters(const char* name);} \cvdefC{void cvSaveWindowParameters(const char* name);}
@ -633,7 +633,7 @@ The function \texttt{cvSaveWindowParameters} saves size, location, flags, track
%CVAPI(void) cvLoadWindowParameters(const char* name); %CVAPI(void) cvLoadWindowParameters(const char* name);
\cvCPyFunc{loadWindowParameters} \cvCPyFunc{LoadWindowParameters}
Load parameters of the window \emph{window\_name}. Load parameters of the window \emph{window\_name}.
\cvdefC{void cvLoadWindowParameters(const char* name);} \cvdefC{void cvLoadWindowParameters(const char* name);}
@ -645,7 +645,7 @@ The function \texttt{cvLoadWindowParameters} load size, location, flags, trackb
%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)); %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));
\cvCPyFunc{createButton} \cvCPyFunc{CreateButton}
Create a callback function called to draw OpenGL on top the the image display by \emph{window\_name}. Create a callback function called to draw OpenGL on top the the image display by \emph{window\_name}.
\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);} \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);}

View File

@ -20,55 +20,7 @@
\tableofcontents \tableofcontents
%%% Chapters %%% %%% Chapters %%%
\input{core_introduction} \input{opencvref_body}
\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}
%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%
\end{document} % End of document. \end{document} % End of document.

View File

@ -19,6 +19,7 @@
\input{imgproc_planar_subdivisions} \input{imgproc_planar_subdivisions}
\input{imgproc_motion_tracking} \input{imgproc_motion_tracking}
\input{imgproc_feature_detection} \input{imgproc_feature_detection}
\input{imgproc_object_detection}
\chapter{features2d. Feature Detection and Descriptor Extraction} \chapter{features2d. Feature Detection and Descriptor Extraction}
\input{features2d_feature_detection} \input{features2d_feature_detection}