generic-library/opencv
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

converted user guide & tutorials from tex to rst; added them into the whole documentation tree; added html_docs target.

Browse Source
This commit is contained in:
Vadim Pisarevsky 2011-05-10 22:09:07 +00:00
parent 6facf8ba3b
commit b699e946b5
75 changed files with 1506 additions and 2120 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
doc/CMakeLists.txt
View File

@ -9,8 +9,52 @@ file(GLOB FILES_TEX_PICS pics/*.png pics/*.jpg)
if(BUILD_DOCS AND PDFLATEX_COMPILER AND HAVE_SPHINX)
add_subdirectory(opencv1)
add_subdirectory(opencv2)
project(opencv_docs)
file(GLOB_RECURSE OPENCV2_FILES_PICT ../modules/*.png ../modules/*.jpg)
file(GLOB_RECURSE OPENCV2_FILES_RST ../modules/*.rst)
file(GLOB_RECURSE OPENCV1_FILES_PICT pics/*.png pics/*.jpg)
file(GLOB_RECURSE OPENCV1_FILES_RST opencv1/*.rst)
file(GLOB_RECURSE OPENCV_FILES_UG user_guide/*.rst)
file(GLOB_RECURSE OPENCV_FILES_TUT tutorials/*.rst)
set(OPENCV_DOC_DEPS conf.py ${OPENCV2_FILES_RST} ${OPENCV2_FILES_PICT}
${OPENCV1_FILES_RST} ${OPENCV1_FILES_PICT}
${OPENCV_FILES_UG} ${OPENCV_FILES_TUT})
add_custom_target(docs
${SPHINX_BUILD}
-b latex -c ${CMAKE_CURRENT_SOURCE_DIR}
${CMAKE_CURRENT_SOURCE_DIR}/.. .
COMMAND ${CMAKE_COMMAND} -E copy_directory
${CMAKE_CURRENT_SOURCE_DIR}/pics ${CMAKE_CURRENT_BINARY_DIR}/doc/opencv1/pics
COMMAND ${CMAKE_COMMAND} -E copy
${CMAKE_CURRENT_SOURCE_DIR}/mymath.sty ${CMAKE_CURRENT_BINARY_DIR}
COMMAND ${PDFLATEX_COMPILER} opencv2refman
COMMAND ${PDFLATEX_COMPILER} opencv2refman
COMMAND ${PDFLATEX_COMPILER} opencv1refman_c
COMMAND ${PDFLATEX_COMPILER} opencv1refman_c
COMMAND ${PDFLATEX_COMPILER} opencv1refman_py
COMMAND ${PDFLATEX_COMPILER} opencv1refman_py
COMMAND ${PDFLATEX_COMPILER} opencv_user
COMMAND ${PDFLATEX_COMPILER} opencv_user
COMMAND ${PDFLATEX_COMPILER} opencv_tutorials
COMMAND ${PDFLATEX_COMPILER} opencv_tutorials
DEPENDS ${OPENCV_DOC_DEPS}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating the PDF Manuals")
add_custom_target(html_docs
${SPHINX_BUILD}
-b html -c ${CMAKE_CURRENT_SOURCE_DIR}
${CMAKE_CURRENT_SOURCE_DIR}/.. ./_html
COMMAND ${CMAKE_COMMAND} -E copy_directory
${CMAKE_CURRENT_SOURCE_DIR}/pics ${CMAKE_CURRENT_BINARY_DIR}/doc/opencv1/pics
COMMAND ${CMAKE_COMMAND} -E copy
${CMAKE_CURRENT_SOURCE_DIR}/mymath.sty ${CMAKE_CURRENT_BINARY_DIR}
DEPENDS ${OPENCV_DOC_DEPS}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating Online Documentation")
endif()

65
doc/opencv2/conf.py → doc/conf.py
View File

@ -41,7 +41,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'opencvrefman'
project = u'OpenCV'
copyright = u'2011, opencv dev team'
# The version info for the project you're documenting, acts as replacement for
@ -101,7 +101,7 @@ html_theme = 'blue'
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['../_themes']
html_theme_path = ['_themes']
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
@ -112,7 +112,7 @@ html_theme_path = ['../_themes']
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = '../opencv-logo2.png'
#html_logo = 'opencv-logo2.png'
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
@ -122,7 +122,7 @@ html_logo = '../opencv-logo2.png'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['../_static']
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
@ -143,7 +143,7 @@ html_static_path = ['../_static']
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
@ -168,6 +168,49 @@ html_static_path = ['../_static']
# Output file base name for HTML help builder.
htmlhelp_basename = 'opencv'
# OpenCV docs use some custom LaTeX macros in the formulae. Make sure we include the definitions
pngmath_latex_preamble = r"""
\usepackage{amssymb}\usepackage{amsmath}\usepackage{bbm}
\newcommand{\matTT}[9]{
\[
\left|\begin{array}{ccc}
#1 & #2 & #3\\
#4 & #5 & #6\\
#7 & #8 & #9
\end{array}\right|
\]
}
\newcommand{\fork}[4]{
\left\{
\begin{array}{l l}
#1 & \mbox{#2}\\
#3 & \mbox{#4}\\
\end{array} \right.}
\newcommand{\forkthree}[6]{
\left\{
\begin{array}{l l}
#1 & \mbox{#2}\\
#3 & \mbox{#4}\\
#5 & \mbox{#6}\\
\end{array} \right.}
\newcommand{\vecthree}[3]{
\begin{bmatrix}
#1\\
#2\\
#3
\end{bmatrix}
}
\newcommand{\vecthreethree}[9]{
\begin{bmatrix}
#1 & #2 & #3\\
#4 & #5 & #6\\
#7 & #8 & #9
\end{bmatrix}
}
"""
# -- Options for LaTeX output --------------------------------------------------
@ -180,8 +223,16 @@ htmlhelp_basename = 'opencv'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'opencv.tex', u'The OpenCV Reference Manual',
('modules/refman', 'opencv2refman.tex', u'The OpenCV Reference Manual',
u'', 'manual'),
('doc/opencv1/c/c_index', 'opencv1refman_c.tex', u'The OpenCV 1.x C Reference Manual',
u'', 'manual'),
('doc/opencv1/py/py_index', 'opencv1refman_py.tex', u'The OpenCV 1.x Python Reference Manual',
u'', 'manual'),
('doc/user_guide/user_guide', 'opencv_user.tex', u'The OpenCV User Guide',
u'', 'manual'),
('doc/tutorials/tutorials', 'opencv_tutorials.tex', u'The OpenCV Tutorials',
u'', 'manual'),
]
latex_elements = {'preamble': '\usepackage{mymath}\usepackage{amssymb}\usepackage{amsmath}\usepackage{bbm}\setcounter{secnumdepth}{1}'}
@ -192,7 +243,7 @@ latex_elements = {'preamble': '\usepackage{mymath}\usepackage{amssymb}\usepackag
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False

185
doc/opencv.sty
View File

@ -1,185 +0,0 @@
\ProvidesPackage{opencv}
\lstset{ %
language=Python, % choose the language of the code
%basicstyle=\footnotesize, % the size of the fonts that are used for the code
%numbers=left, % where to put the line-numbers
%numberstyle=\footnotesize, % the size of the fonts that are used for the line-numbers
%stepnumber=2, % the step between two line-numbers. If it's 1 each line will be numbered
%numbersep=5pt, % how far the line-numbers are from the code
%backgroundcolor=\color{white}, % choose the background color. You must add \usepackage{color}
showspaces=false, % show spaces adding particular underscores
showstringspaces=false, % underline spaces within strings
showtabs=false, % show tabs within strings adding particular underscores
%frame=single, % adds a frame around the code
%tabsize=2, % sets default tabsize to 2 spaces
%captionpos=b, % sets the caption-position to bottom
%breaklines=true, % sets automatic line breaking
%breakatwhitespace=false, % sets if automatic breaks should only happen at whitespace
%escapeinside={\%*}{*)} % if you want to add a comment within your code
}
\newcommand{\wikiHref}[1]{\hspace{0.1in}\href{http://opencv.willowgarage.com/wiki/documentation/\targetlang/\curModule/#1}{(view/add comments)}}
\newcommand{\curModule}{}
\newcommand{\cvclass}[1]{
\ifthenelse{\equal{\targetlang}{cpp}}
{
\subsection[cv::#1]{cv::#1\wikiHref{#1}}
%\addcontentsline{toc}{subsection}{#1}
\index{cv...!#1}
}
{
\subsection[#1]{#1\wikiHref{#1}}
%\addcontentsline{toc}{subsection}{#1}
\index{cv...!#1}
}
}
\newcommand{\cvfunc}[1]{
\subsection[#1]{#1\wikiHref{#1}}
%\addcontentsline{toc}{subsection}{#1}
\index{cv...!#1}
}
\newcommand{\cvstruct}[1]{
\subsection[#1]{#1\wikiHref{#1}}
%\addcontentsline{toc}{subsection}{#1}
\index{cv...!#1}
}
\newcommand{\cvmacro}[1]{
\subsection[#1]{#1\wikiHref{#1}}
%\addcontentsline{toc}{subsection}{#1}
\index{cv...!#1}
}
\newcommand{\cvarg}[2]{
\item[\texttt{#1}] #2
}
\newcommand{\cvFunc}[2]{
\ifthenelse{\equal{\targetlang}{c}}
{\subsection[cv::#1]{cv#1\wikiHref{#1}}\index{cv#1}\label{cfunc.#1}}
{\ifthenelse{\equal{\targetlang}{cpp}}
{\subsection[cv::#2]{cv::#2\wikiHref{#2}}\index{cv::#2}\label{cppfunc.#2}}
{\subsection[cv::#1]{cv.#1\wikiHref{#1}}\index{cv.#1}\label{pyfunc.#1}}}}
\newcommand{\cvCPyFunc}[1]{\cvFunc{#1}{}}
\newcommand{\cvCppFunc}[1]{\cvFunc{}{#1}}
\newcommand{\cvCross}[2]{
\ifthenelse{\equal{\targetlang}{c}}
{\hyperref[cfunc.#1]{cv#1}}
{\ifthenelse{\equal{\targetlang}{cpp}}
{\hyperref[cppfunc.#2]{cv::#2}}
{\hyperref[pyfunc.#1]{cv.#1}}}}
\newcommand{\cvCPyCross}[1]{\cvCross{#1}{}}
\newcommand{\cvCppCross}[1]{\cvCross{}{#1}}
\newcommand{\cvdefC}[1]{
\ifthenelse{\equal{\targetlang}{c}}{
\begin{shaded}
\begin{alltt}
\setlength{\parindent}{1in}
#1
\end{alltt}
\end{shaded}
}{}
}
\newcommand{\cvdefCpp}[1]{
\ifthenelse{\equal{\targetlang}{cpp}}{
\begin{shaded}
\begin{alltt}
\setlength{\parindent}{1in}
#1
\end{alltt}
\end{shaded}
}{}
}
\newcommand{\cvdefPy}[1]{
\ifthenelse{\equal{\targetlang}{python}}{
\begin{shaded}
\begin{alltt}
\setlength{\parindent}{1in}
#1
\end{alltt}
\end{shaded}
}{}
}
\newcommand{\cvC}[1]{
\ifthenelse{\equal{\targetlang}{c}}{#1}{}
}
\newcommand{\cvCpp}[1]{
\ifthenelse{\equal{\targetlang}{cpp}}{#1}{}
}
\newcommand{\cvPy}[1]{
\ifthenelse{\equal{\targetlang}{python}}{#1}{}}
\newcommand{\cvCPy}[1]{
\ifthenelse{\equal{\targetlang}{c}\or\equal{\targetlang}{python}}{#1}{}
}
\newcommand{\cvcode}[1]{
\begin{shaded}
\begin{alltt}
\setlength{\parindent}{1in}
#1
\end{alltt}
\end{shaded}
}
%\newcommand{\cross}[1]{#1 (page \pageref{#1})}
\newcommand{\cross}[1]{ \hyperref[#1]{#1} }
\newcommand{\matTT}[9]{
\[
\left|\begin{array}{ccc}
#1 & #2 & #3\\
#4 & #5 & #6\\
#7 & #8 & #9
\end{array}\right|
\]
}
\newcommand{\fork}[4]{
\left\{
\begin{array}{l l}
#1 & \mbox{#2}\\
#3 & \mbox{#4}\\
\end{array} \right.}
\newcommand{\forkthree}[6]{
\left\{
\begin{array}{l l}
#1 & \mbox{#2}\\
#3 & \mbox{#4}\\
#5 & \mbox{#6}\\
\end{array} \right.}
\newcommand{\vecthree}[3]{
\begin{bmatrix}
#1\\
#2\\
#3
\end{bmatrix}
}
\newcommand{\vecthreethree}[9]{
\begin{bmatrix}
#1 & #2 & #3\\
#4 & #5 & #6\\
#7 & #8 & #9
\end{bmatrix}
}
% allow special plastex handling
\newif\ifplastex
\plastexfalse

20
doc/opencv1/CMakeLists.txt
View File

@ -1,20 +0,0 @@
project(opencv_refman1)
file(GLOB_RECURSE OPENCV1_FILES_PICT pics/*.png pics/*.jpg)
file(GLOB_RECURSE OPENCV1_FILES_RST *.rst)
add_custom_target(refman1
${SPHINX_BUILD}
-b latex -c ${CMAKE_CURRENT_SOURCE_DIR}
${CMAKE_CURRENT_SOURCE_DIR} .
COMMAND ${CMAKE_COMMAND} -E copy_directory
${CMAKE_CURRENT_SOURCE_DIR}/../pics ${CMAKE_CURRENT_BINARY_DIR}/pics
COMMAND ${CMAKE_COMMAND} -E copy
${CMAKE_CURRENT_SOURCE_DIR}/../mymath.sty ${CMAKE_CURRENT_BINARY_DIR}
COMMAND ${PDFLATEX_COMPILER} opencv1x
COMMAND ${PDFLATEX_COMPILER} opencv1x
DEPENDS conf.py ${OPENCV1_FILES_RST} ${OPENCV1_FILES_PICT}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating the OpenCV 1.x Reference Manual")
#install(FILES ${CURRENT_BINARY_DIR}/opencv1x.pdf DESTINATION "${OPENCV_DOC_INSTALL_PATH}" COMPONENT main)

6
doc/opencv1/c/c_index.rst
View File

@ -1,6 +1,6 @@
###########
C Reference
###########
##########################
OpenCV 1.x C API Reference
##########################
.. highlight:: python

68
doc/opencv1/c/calib3d_camera_calibration_and_3d_reconstruction.rst
View File

@ -157,7 +157,7 @@ The functions below use the above model to
CalcImageHomography
-------------------
`id=0.733621944503 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/CalcImageHomography>`__
@ -202,7 +202,7 @@ in the OpenCV Guide 3D Reconstruction Chapter).
CalibrateCamera2
----------------
`id=0.047494999013 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/CalibrateCamera2>`__
@ -346,7 +346,7 @@ See also:
ComputeCorrespondEpilines
-------------------------
`id=0.245813963965 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/ComputeCorrespondEpilines>`__
@ -422,7 +422,7 @@ Line coefficients are defined up to a scale. They are normalized, such that
ConvertPointsHomogeneous
------------------------
`id=0.283238515237 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/ConvertPointsHomogeneous>`__
@ -467,7 +467,7 @@ If the output array dimensionality is larger, an extra 1 is appended to each poi
CreatePOSITObject
-----------------
`id=0.908065035962 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/CreatePOSITObject>`__
@ -512,7 +512,7 @@ must be called to free memory.
CreateStereoBMState
-------------------
`id=0.967939258435 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/CreateStereoBMState>`__
@ -555,7 +555,7 @@ the calls to
CreateStereoGCState
-------------------
`id=0.358252470639 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/CreateStereoGCState>`__
@ -588,7 +588,7 @@ The function creates the stereo correspondence structure and initializes it. It
CvStereoBMState
---------------
`id=0.343226402356 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/CvStereoBMState>`__
.. ctype:: CvStereoBMState
@ -760,7 +760,7 @@ Note that the algorithm searches for the corresponding blocks in x direction onl
CvStereoGCState
---------------
`id=0.177638065166 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/CvStereoGCState>`__
.. ctype:: CvStereoGCState
@ -817,7 +817,7 @@ and then override necessary parameters if needed.
DecomposeProjectionMatrix
-------------------------
`id=0.0345049807701 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/DecomposeProjectionMatrix>`__
@ -872,7 +872,7 @@ The function is based on
DrawChessboardCorners
---------------------
`id=0.976073399441 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/DrawChessboardCorners>`__
@ -912,7 +912,7 @@ The function draws the individual chessboard corners detected as red circles if
FindChessboardCorners
---------------------
`id=0.171470909447 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/FindChessboardCorners>`__
@ -1010,7 +1010,7 @@ the function requires some white space (like a square-thick border, the wider th
FindExtrinsicCameraParams2
--------------------------
`id=0.220088405626 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/FindExtrinsicCameraParams2>`__
@ -1064,7 +1064,7 @@ The function's counterpart in the C++ API is
FindFundamentalMat
------------------
`id=0.704773042204 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/FindFundamentalMat>`__
@ -1185,7 +1185,7 @@ to compute the rectification transformation.
FindHomography
--------------
`id=0.447400721885 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/FindHomography>`__
@ -1318,7 +1318,7 @@ See also:
FindStereoCorrespondenceBM
--------------------------
`id=0.0255529902071 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/FindStereoCorrespondenceBM>`__
@ -1359,7 +1359,7 @@ in the case of 16-bit fixed-point disparity map)
FindStereoCorrespondenceGC
--------------------------
`id=0.989115762769 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/FindStereoCorrespondenceGC>`__
@ -1487,7 +1487,7 @@ left disparity images are usually negative):
GetOptimalNewCameraMatrix
-------------------------
`id=0.809174556358 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/GetOptimalNewCameraMatrix>`__
@ -1546,7 +1546,7 @@ to produce the maps for
InitIntrinsicParams2D
---------------------
`id=0.266047155492 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/InitIntrinsicParams2D>`__
@ -1590,7 +1590,7 @@ Currently, the function only supports planar calibration patterns, i.e. patterns
InitUndistortMap
----------------
`id=0.851817673191 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/InitUndistortMap>`__
@ -1633,7 +1633,7 @@ is identity matrix and
InitUndistortRectifyMap
-----------------------
`id=0.249366479773 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/InitUndistortRectifyMap>`__
@ -1742,7 +1742,7 @@ can be chosen arbitrarily.
POSIT
-----
`id=0.678024470382 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/POSIT>`__
@ -1789,7 +1789,7 @@ serves to stop the algorithm if the difference is small.
ProjectPoints2
--------------
`id=0.0577222169105 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/ProjectPoints2>`__
@ -1868,7 +1868,7 @@ to 3x3 identity matrix, or by passing zero distortion coefficients, you can get
ReprojectImageTo3D
------------------
`id=0.134721984306 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/ReprojectImageTo3D>`__
@ -1927,7 +1927,7 @@ matrix, e.g. the one computed by
RQDecomp3x3
-----------
`id=0.744854921725 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/RQDecomp3x3>`__
@ -1978,7 +1978,7 @@ that could be used in OpenGL.
ReleasePOSITObject
------------------
`id=0.26823386799 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/ReleasePOSITObject>`__
@ -2008,7 +2008,7 @@ The function releases memory previously allocated by the function
ReleaseStereoBMState
--------------------
`id=0.746678435544 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/ReleaseStereoBMState>`__
@ -2036,7 +2036,7 @@ The function releases the stereo correspondence structure and all the associated
ReleaseStereoGCState
--------------------
`id=0.279280186521 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/ReleaseStereoGCState>`__
@ -2064,7 +2064,7 @@ The function releases the stereo correspondence structure and all the associated
Rodrigues2
----------
`id=0.23072370096 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/Rodrigues2>`__
@ -2123,7 +2123,7 @@ or
StereoCalibrate
---------------
`id=0.348893862152 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/StereoCalibrate>`__
@ -2273,7 +2273,7 @@ The function returns the final value of the re-projection error.
StereoRectify
-------------
`id=0.753398392404 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/StereoRectify>`__
@ -2419,7 +2419,7 @@ and
StereoRectifyUncalibrated
-------------------------
`id=0.622333108977 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/StereoRectifyUncalibrated>`__
@ -2477,7 +2477,7 @@ and then the images can be corrected using
Undistort2
----------
`id=0.329515394146 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/Undistort2>`__
@ -2541,7 +2541,7 @@ need to be scaled accordingly, while the distortion coefficients remain the same
UndistortPoints
---------------
`id=0.111600695455 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/calib3d/UndistortPoints>`__

28
doc/opencv1/c/core_basic_structures.rst
View File

@ -69,7 +69,7 @@ CvPoint
CvPoint2D32f
------------
`id=0.245532424939 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvPoint2D32f>`__
.. ctype:: CvPoint2D32f
@ -138,7 +138,7 @@ CvPoint2D32f
CvPoint3D32f
------------
`id=0.0440394368915 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvPoint3D32f>`__
.. ctype:: CvPoint3D32f
@ -213,7 +213,7 @@ CvPoint3D32f
CvPoint2D64f
------------
`id=0.709504732939 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvPoint2D64f>`__
.. ctype:: CvPoint2D64f
@ -282,7 +282,7 @@ CvPoint2D64f
CvPoint3D64f
------------
`id=0.0506448340848 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvPoint3D64f>`__
.. ctype:: CvPoint3D64f
@ -357,7 +357,7 @@ CvPoint3D64f
CvSize
------
`id=0.554248071465 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvSize>`__
.. ctype:: CvSize
@ -423,7 +423,7 @@ Pixel-accurate size of a rectangle.
CvSize2D32f
-----------
`id=0.905432526523 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvSize2D32f>`__
.. ctype:: CvSize2D32f
@ -489,7 +489,7 @@ Sub-pixel accurate size of a rectangle.
CvRect
------
`id=0.213953446247 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvRect>`__
.. ctype:: CvRect
@ -573,7 +573,7 @@ Offset (usually the top-left corner) and size of a rectangle.
CvScalar
--------
`id=0.760314360939 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvScalar>`__
.. ctype:: CvScalar
@ -630,7 +630,7 @@ A container for 1-,2-,3- or 4-tuples of doubles.
CvTermCriteria
--------------
`id=0.267162264997 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvTermCriteria>`__
.. ctype:: CvTermCriteria
@ -716,7 +716,7 @@ Termination criteria for iterative algorithms.
CvMat
-----
`id=0.465191243774 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvMat>`__
.. ctype:: CvMat
@ -830,7 +830,7 @@ Matrices are stored row by row. All of the rows are aligned by 4 bytes.
CvMatND
-------
`id=0.322223772253 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvMatND>`__
.. ctype:: CvMatND
@ -925,7 +925,7 @@ Multi-dimensional dense multi-channel array.
CvSparseMat
-----------
`id=0.451492537542 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvSparseMat>`__
.. ctype:: CvSparseMat
@ -1050,7 +1050,7 @@ Multi-dimensional sparse multi-channel array.
IplImage
--------
`id=0.99460273838 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/IplImage>`__
.. ctype:: IplImage
@ -1341,7 +1341,7 @@ In addition to the above restrictions, OpenCV handles ROIs differently. OpenCV f
CvArr
-----
`id=0.322048506688 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvArr>`__
.. ctype:: CvArr

4
doc/opencv1/c/core_clustering.rst
View File

@ -12,7 +12,7 @@ Clustering
KMeans2
-------
`id=0.323145542573 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/KMeans2>`__
@ -176,7 +176,7 @@ matrix.
SeqPartition
------------
`id=0.684667795556 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SeqPartition>`__

30
doc/opencv1/c/core_drawing_functions.rst
View File

@ -53,7 +53,7 @@ is simply copied to the repainted pixels. Thus, if you want to paint semi-transp
Circle
------
`id=0.533309560434 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/Circle>`__
@ -100,7 +100,7 @@ given center and radius.
ClipLine
--------
`id=0.773573058754 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/ClipLine>`__
@ -134,7 +134,7 @@ It returns 0 if the line segment is completely outside the image and 1 otherwise
DrawContours
------------
`id=0.180838715035 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/DrawContours>`__
@ -237,7 +237,7 @@ Example: Connected component detection via contour functions
Ellipse
-------
`id=0.702580088492 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/Ellipse>`__
@ -304,7 +304,7 @@ Parameters of Elliptic Arc
EllipseBox
----------
`id=0.594855594674 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/EllipseBox>`__
@ -348,7 +348,7 @@ do. The ellipse drawn is clipped by ROI rectangle. A piecewise-linear approximat
FillConvexPoly
--------------
`id=0.492328679574 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/FillConvexPoly>`__
@ -397,7 +397,7 @@ line) twice at the most.
FillPoly
--------
`id=0.225907613807 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/FillPoly>`__
@ -445,7 +445,7 @@ areas with holes, contour self-intersection, and so forth.
GetTextSize
-----------
`id=0.524127677241 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GetTextSize>`__
@ -482,7 +482,7 @@ The function calculates the dimensions of a rectangle to enclose a text string w
InitFont
--------
`id=0.0379839040886 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/InitFont>`__
@ -558,7 +558,7 @@ The function initializes the font structure that can be passed to text rendering
InitLineIterator
----------------
`id=0.82383633716 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/InitLineIterator>`__
@ -655,7 +655,7 @@ Example: Using line iterator to calculate the sum of pixel values along the colo
Line
----
`id=0.447321958155 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/Line>`__
@ -725,7 +725,7 @@ the line color, the user may use the macro
PolyLine
--------
`id=0.384796564044 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/PolyLine>`__
@ -779,7 +779,7 @@ The function draws single or multiple polygonal curves.
PutText
-------
`id=0.662272934911 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/PutText>`__
@ -822,7 +822,7 @@ replaced with the symbol for a rectangle.
Rectangle
---------
`id=0.025949516421 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/Rectangle>`__
@ -872,7 +872,7 @@ and
CV_RGB
------
`id=0.708413350932 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CV_RGB>`__

158
doc/opencv1/c/core_dynamic_structures.rst
View File

@ -12,7 +12,7 @@ Dynamic Structures
CvMemStorage
------------
`id=0.334804981773 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvMemStorage>`__
.. ctype:: CvMemStorage
@ -115,7 +115,7 @@ or reset via
CvMemBlock
----------
`id=0.108820280688 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvMemBlock>`__
.. ctype:: CvMemBlock
@ -158,7 +158,7 @@ to access the storage structure fields directly.
CvMemStoragePos
---------------
`id=0.832479670677 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvMemStoragePos>`__
.. ctype:: CvMemStoragePos
@ -196,7 +196,7 @@ and restored via
CvSeq
-----
`id=0.387726368946 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvSeq>`__
.. ctype:: CvSeq
@ -436,7 +436,7 @@ blocks of sequences can be found below.
CvSeqBlock
----------
`id=0.211082721332 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvSeqBlock>`__
.. ctype:: CvSeqBlock
@ -506,7 +506,7 @@ some elements have been inserted at the beginning of the sequence.
CvSlice
-------
`id=0.519045630752 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvSlice>`__
.. ctype:: CvSlice
@ -598,7 +598,7 @@ buffer with
CvSet
-----
`id=0.825263988294 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvSet>`__
.. ctype:: CvSet
@ -703,7 +703,7 @@ sparse multi-dimensional arrays (
CvGraph
-------
`id=0.878989998624 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvGraph>`__
.. ctype:: CvGraph
@ -807,7 +807,7 @@ edges.
CvGraphScanner
--------------
`id=0.551304755988 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvGraphScanner>`__
.. ctype:: CvGraphScanner
@ -863,7 +863,7 @@ functions described below in this section.
CvTreeNodeIterator
------------------
`id=0.486956655882 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvTreeNodeIterator>`__
.. ctype:: CvTreeNodeIterator
@ -946,7 +946,7 @@ comply with the requirement.
ClearGraph
----------
`id=0.332439919365 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/ClearGraph>`__
@ -974,7 +974,7 @@ The function removes all vertices and edges from a graph. The function has O(1)
ClearMemStorage
---------------
`id=0.771544719824 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/ClearMemStorage>`__
@ -1005,7 +1005,7 @@ all blocks to the parent.
ClearSeq
--------
`id=0.773624423506 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/ClearSeq>`__
@ -1037,7 +1037,7 @@ memory is reused later when new elements are added to the sequence. The function
ClearSet
--------
`id=0.561246622558 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/ClearSet>`__
@ -1066,7 +1066,7 @@ The function removes all elements from set. It has O(1) time complexity.
CloneGraph
----------
`id=0.516560929963 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CloneGraph>`__
@ -1101,7 +1101,7 @@ the vertex and edge sets.
CloneSeq
--------
`id=0.219909371893 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CloneSeq>`__
@ -1159,7 +1159,7 @@ is equivalent to
CreateChildMemStorage
---------------------
`id=0.901847234907 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CreateChildMemStorage>`__
@ -1225,7 +1225,7 @@ Dynamic data processing using a child storage
CreateGraph
-----------
`id=0.714927849129 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CreateGraph>`__
@ -1265,7 +1265,7 @@ The function creates an empty graph and returns a pointer to it.
CreateGraphScanner
------------------
`id=0.761147235713 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CreateGraphScanner>`__
@ -1320,7 +1320,7 @@ function - the incremental traversal procedure.
CreateMemStorage
----------------
`id=0.484842854055 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CreateMemStorage>`__
@ -1350,7 +1350,7 @@ description.
CreateSeq
---------
`id=0.879299981261 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CreateSeq>`__
@ -1406,7 +1406,7 @@ bytes.
CreateSet
---------
`id=0.149633794529 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CreateSet>`__
@ -1445,7 +1445,7 @@ The function creates an empty set with a specified header size and element size,
CvtSeqToArray
-------------
`id=0.900164505728 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvtSeqToArray>`__
@ -1479,7 +1479,7 @@ The function copies the entire sequence or subsequence to the specified buffer a
EndWriteSeq
-----------
`id=0.919895703214 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/EndWriteSeq>`__
@ -1513,7 +1513,7 @@ and
FindGraphEdge
-------------
`id=0.18087190834 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/FindGraphEdge>`__
@ -1561,7 +1561,7 @@ The function finds the graph edge connecting two specified vertices and returns
FindGraphEdgeByPtr
------------------
`id=0.509139476588 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/FindGraphEdgeByPtr>`__
@ -1607,7 +1607,7 @@ The function finds the graph edge connecting two specified vertices and returns
FlushSeqWriter
--------------
`id=0.821406812895 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/FlushSeqWriter>`__
@ -1642,7 +1642,7 @@ instead.
GetGraphVtx
-----------
`id=0.802641800298 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GetGraphVtx>`__
@ -1674,7 +1674,7 @@ The function finds the graph vertex by using its index and returns the pointer t
GetSeqElem
----------
`id=0.778073099468 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GetSeqElem>`__
@ -1744,7 +1744,7 @@ number of elements.
GetSeqReaderPos
---------------
`id=0.869101167847 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GetSeqReaderPos>`__
@ -1774,7 +1774,7 @@ The function returns the current reader position (within 0 ...
GetSetElem
----------
`id=0.506490712171 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GetSetElem>`__
@ -1807,7 +1807,7 @@ to locate the node.
GraphAddEdge
------------
`id=0.752253770377 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GraphAddEdge>`__
@ -1847,7 +1847,7 @@ The function connects two specified vertices. The function returns 1 if the edge
GraphAddEdgeByPtr
-----------------
`id=0.313903446977 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GraphAddEdgeByPtr>`__
@ -1892,7 +1892,7 @@ the result is negative), the function also reports an error by default.
GraphAddVtx
-----------
`id=0.236553727886 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GraphAddVtx>`__
@ -1926,7 +1926,7 @@ The function adds a vertex to the graph and returns the vertex index.
GraphEdgeIdx
------------
`id=0.571043881578 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GraphEdgeIdx>`__
@ -1957,7 +1957,7 @@ The function returns the index of a graph edge.
GraphRemoveEdge
---------------
`id=0.608632884153 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GraphRemoveEdge>`__
@ -1991,7 +1991,7 @@ The function removes the edge connecting two specified vertices. If the vertices
GraphRemoveEdgeByPtr
--------------------
`id=0.642579664169 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GraphRemoveEdgeByPtr>`__
@ -2025,7 +2025,7 @@ The function removes the edge connecting two specified vertices. If the vertices
GraphRemoveVtx
--------------
`id=0.970005049786 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GraphRemoveVtx>`__
@ -2059,7 +2059,7 @@ number of edges deleted, or -1 if the vertex does not belong to the graph.
GraphRemoveVtxByPtr
-------------------
`id=0.605088135179 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GraphRemoveVtxByPtr>`__
@ -2090,7 +2090,7 @@ The function removes a vertex from the graph by using its pointer together with
GraphVtxDegree
--------------
`id=0.257037043726 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GraphVtxDegree>`__
@ -2146,7 +2146,7 @@ that follows after
GraphVtxDegreeByPtr
-------------------
`id=0.739296929217 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GraphVtxDegreeByPtr>`__
@ -2178,7 +2178,7 @@ The function returns the number of edges incident to the specified vertex, both
GraphVtxIdx
-----------
`id=0.717221417419 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GraphVtxIdx>`__
@ -2209,7 +2209,7 @@ The function returns the index of a graph vertex.
InitTreeNodeIterator
--------------------
`id=0.483111798793 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/InitTreeNodeIterator>`__
@ -2243,7 +2243,7 @@ The function initializes the tree iterator. The tree is traversed in depth-first
InsertNodeIntoTree
------------------
`id=0.159347112834 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/InsertNodeIntoTree>`__
@ -2277,7 +2277,7 @@ The function adds another node into tree. The function does not allocate any mem
MakeSeqHeaderForArray
---------------------
`id=0.960790357917 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/MakeSeqHeaderForArray>`__
@ -2329,7 +2329,7 @@ most cases.
MemStorageAlloc
---------------
`id=0.301172131439 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/MemStorageAlloc>`__
@ -2364,7 +2364,7 @@ otherwise a runtime error is raised. The buffer address is aligned by
MemStorageAllocString
---------------------
`id=0.109838084699 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/MemStorageAllocString>`__
@ -2417,7 +2417,7 @@ or computed length of the string and pointer to the copied string.
NextGraphItem
-------------
`id=0.801658747963 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/NextGraphItem>`__
@ -2476,7 +2476,7 @@ vertex of the edge - at
NextTreeNode
------------
`id=0.892783495145 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/NextTreeNode>`__
@ -2511,7 +2511,7 @@ are no more nodes.
PrevTreeNode
------------
`id=0.199395520003 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/PrevTreeNode>`__
@ -2546,7 +2546,7 @@ if there are no more nodes.
ReleaseGraphScanner
-------------------
`id=0.572499008135 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/ReleaseGraphScanner>`__
@ -2576,7 +2576,7 @@ The function completes the graph traversal procedure and releases the traverser
ReleaseMemStorage
-----------------
`id=0.449342726691 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/ReleaseMemStorage>`__
@ -2608,7 +2608,7 @@ parent storage block is released.
RestoreMemStoragePos
--------------------
`id=0.0596222862557 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/RestoreMemStoragePos>`__
@ -2644,7 +2644,7 @@ are the only methods to release memory occupied in memory blocks. Note again tha
SaveMemStoragePos
-----------------
`id=0.625300615076 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SaveMemStoragePos>`__
@ -2680,7 +2680,7 @@ can further retrieve this position.
SeqElemIdx
----------
`id=0.724143019934 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SeqElemIdx>`__
@ -2714,7 +2714,7 @@ The function returns the index of a sequence element or a negative number if the
SeqInsert
---------
`id=0.0992440051218 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SeqInsert>`__
@ -2751,7 +2751,7 @@ content there if the pointer is not NULL. The function returns a pointer to the
SeqInsertSlice
--------------
`id=0.819564817378 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SeqInsertSlice>`__
@ -2789,7 +2789,7 @@ can be a matrix or another sequence.
SeqInvert
---------
`id=0.695189452157 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SeqInvert>`__
@ -2817,7 +2817,7 @@ The function reverses the sequence in-place - makes the first element go last, t
SeqPop
------
`id=0.891792572997 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SeqPop>`__
@ -2848,7 +2848,7 @@ The function removes an element from a sequence. The function reports an error i
SeqPopFront
-----------
`id=0.802844810483 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SeqPopFront>`__
@ -2879,7 +2879,7 @@ The function removes an element from the beginning of a sequence. The function r
SeqPopMulti
-----------
`id=0.260750127544 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SeqPopMulti>`__
@ -2922,7 +2922,7 @@ The function removes several elements from either end of the sequence. If the nu
SeqPush
-------
`id=0.90060051534 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SeqPush>`__
@ -2988,7 +2988,7 @@ and related functions).
SeqPushFront
------------
`id=0.862751238482 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SeqPushFront>`__
@ -3021,7 +3021,7 @@ but it adds the new element to the beginning of the sequence. The function has O
SeqPushMulti
------------
`id=0.958302949543 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SeqPushMulti>`__
@ -3067,7 +3067,7 @@ different sequence blocks.
SeqRemove
---------
`id=0.432719803682 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SeqRemove>`__
@ -3105,7 +3105,7 @@ the sequence elements between the nearest end of the sequence and the
SeqRemoveSlice
--------------
`id=0.971861630547 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SeqRemoveSlice>`__
@ -3136,7 +3136,7 @@ The function removes a slice from the sequence.
SeqSearch
---------
`id=0.729745795436 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SeqSearch>`__
@ -3198,7 +3198,7 @@ elements if a linear search is used, or to the smallest index
SeqSlice
--------
`id=0.0557062585643 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SeqSlice>`__
@ -3235,7 +3235,7 @@ The function creates a sequence that represents the specified slice of the input
SeqSort
-------
`id=0.290622936492 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SeqSort>`__
@ -3327,7 +3327,7 @@ The function sorts the sequence in-place using the specified criteria. Below is
SetAdd
------
`id=0.151496822644 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SetAdd>`__
@ -3368,7 +3368,7 @@ a faster function for allocating set nodes (see
SetNew
------
`id=0.448446991925 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SetNew>`__
@ -3399,7 +3399,7 @@ The function is an inline lightweight variant of
SetRemove
---------
`id=0.513485030618 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SetRemove>`__
@ -3435,7 +3435,7 @@ if it is located already.
SetRemoveByPtr
--------------
`id=0.511092796762 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SetRemoveByPtr>`__
@ -3469,7 +3469,7 @@ that requires an element pointer. The function does not check whether the node i
SetSeqBlockSize
---------------
`id=0.94569516135 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SetSeqBlockSize>`__
@ -3515,7 +3515,7 @@ constraints.
SetSeqReaderPos
---------------
`id=0.435675937023 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SetSeqReaderPos>`__
@ -3550,7 +3550,7 @@ The function moves the read position to an absolute position or relative to the
StartAppendToSeq
----------------
`id=0.481797162299 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/StartAppendToSeq>`__
@ -3589,7 +3589,7 @@ yield an incorrect result or even corrupt the sequence (see description of
StartReadSeq
------------
`id=0.274476331583 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/StartReadSeq>`__
@ -3688,7 +3688,7 @@ to use the sequence writer and reader.
StartWriteSeq
-------------
`id=0.633886985438 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/StartWriteSeq>`__
@ -3737,7 +3737,7 @@ function that should be called at the end.
TreeToNodeSeq
-------------
`id=0.995912413662 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/TreeToNodeSeq>`__

276
doc/opencv1/c/core_operations_on_arrays.rst
View File

File diff suppressed because it is too large Load Diff

34
doc/opencv1/c/core_utility_and_system_functions_and_macros.rst
View File

@ -215,7 +215,7 @@ Example: Use of Error Handling Macros
GetErrStatus
------------
`id=0.158872599983 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GetErrStatus>`__
@ -249,7 +249,7 @@ error mode.
SetErrStatus
------------
`id=0.548990286602 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SetErrStatus>`__
@ -283,7 +283,7 @@ or
GetErrMode
----------
`id=0.395450807117 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GetErrMode>`__
@ -306,7 +306,7 @@ call.
SetErrMode
----------
`id=0.837950474175 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SetErrMode>`__
@ -348,7 +348,7 @@ The function sets the specified error mode. For descriptions of different error
Error
-----
`id=0.755789688999 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/Error>`__
@ -392,7 +392,7 @@ The function sets the error status to the specified value (via
ErrorStr
--------
`id=0.116403749541 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/ErrorStr>`__
@ -422,7 +422,7 @@ returns a NULL pointer.
RedirectError
-------------
`id=0.0620147644903 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/RedirectError>`__
@ -480,7 +480,7 @@ to make a decision.
cvNulDevReport cvStdErrReport cvGuiBoxReport
--------------------------------------------
`id=0.940927070556 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/cvNulDevReport%20cvStdErrReport%20cvGuiBoxReport>`__
@ -576,7 +576,7 @@ If the error handler is set to
Alloc
-----
`id=0.593055881775 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/Alloc>`__
@ -618,7 +618,7 @@ function.
Free
----
`id=0.667310584005 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/Free>`__
@ -652,7 +652,7 @@ does nothing.
GetTickCount
------------
`id=0.0577183375288 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GetTickCount>`__
@ -675,7 +675,7 @@ The function returns number of the ticks starting from some platform-dependent e
GetTickFrequency
----------------
`id=0.796183003536 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GetTickFrequency>`__
@ -700,7 +700,7 @@ will give the number of microseconds starting from the platform-dependent event.
RegisterModule
--------------
`id=0.265903415766 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/RegisterModule>`__
@ -775,7 +775,7 @@ on how IPP and MKL are connected to the modules.
GetModuleInfo
-------------
`id=0.510096912729 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GetModuleInfo>`__
@ -812,7 +812,7 @@ text strings.
UseOptimized
------------
`id=0.657951043449 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/UseOptimized>`__
@ -851,7 +851,7 @@ the program (actually, it will only increase the startup time).
SetMemoryManager
----------------
`id=0.591055548987 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SetMemoryManager>`__
@ -925,7 +925,7 @@ pointers are
SetIPLAllocators
----------------
`id=0.433242475449 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/SetIPLAllocators>`__

82
doc/opencv1/c/core_xml_yaml_persistence.rst
View File

@ -12,7 +12,7 @@ XML/YAML Persistence
CvFileStorage
-------------
`id=0.857247720381 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvFileStorage>`__
.. ctype:: CvFileStorage
@ -97,7 +97,7 @@ file, .xml for XML files and .yml or .yaml for YAML.
CvFileNode
----------
`id=0.608842304291 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvFileNode>`__
.. ctype:: CvFileNode
@ -263,7 +263,7 @@ functions.
CvAttrList
----------
`id=0.988512335517 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvAttrList>`__
.. ctype:: CvAttrList
@ -309,7 +309,7 @@ attribute).
CvTypeInfo
----------
`id=0.181522293243 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/CvTypeInfo>`__
.. ctype:: CvTypeInfo
@ -383,7 +383,7 @@ standard types and override the basic methods.
Clone
-----
`id=0.360041292134 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/Clone>`__
@ -413,7 +413,7 @@ with the passed object.
EndWriteStruct
--------------
`id=0.211232129115 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/EndWriteStruct>`__
@ -441,7 +441,7 @@ The function finishes the currently written structure.
FindType
--------
`id=0.0662543825018 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/FindType>`__
@ -470,7 +470,7 @@ The function finds a registered type by its name. It returns NULL if there is no
FirstType
---------
`id=0.938501911774 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/FirstType>`__
@ -497,7 +497,7 @@ structure.
GetFileNode
-----------
`id=0.800469512645 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GetFileNode>`__
@ -538,7 +538,7 @@ discussion). Also, the function can insert a new node, if it is not in the map y
GetFileNodeByName
-----------------
`id=0.715012469883 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GetFileNodeByName>`__
@ -587,7 +587,7 @@ and
GetFileNodeName
---------------
`id=0.83341764078 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GetFileNodeName>`__
@ -620,7 +620,7 @@ is
GetHashedKey
------------
`id=0.30931895543 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GetHashedKey>`__
@ -748,7 +748,7 @@ in a single numeric sequence.
GetRootFileNode
---------------
`id=0.971822903294 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/GetRootFileNode>`__
@ -786,7 +786,7 @@ may be used as a base for recursive traversal of the file storage.
Load
----
`id=0.212907012591 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/Load>`__
@ -829,7 +829,7 @@ should pass a valid memory storage destination to the function.
OpenFileStorage
---------------
`id=0.471296965858 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/OpenFileStorage>`__
@ -891,7 +891,7 @@ structure.
Read
----
`id=0.832153339685 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/Read>`__
@ -943,7 +943,7 @@ using the generic
ReadByName
----------
`id=0.859151866222 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/ReadByName>`__
@ -984,7 +984,7 @@ and
ReadInt
-------
`id=0.251615646906 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/ReadInt>`__
@ -1032,7 +1032,7 @@ result is not determined.
ReadIntByName
-------------
`id=0.556319809758 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/ReadIntByName>`__
@ -1074,7 +1074,7 @@ and
ReadRawData
-----------
`id=0.664870960197 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/ReadRawData>`__
@ -1111,7 +1111,7 @@ The function reads elements from a file node that represents a sequence of scala
ReadRawDataSlice
----------------
`id=0.0436069303098 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/ReadRawDataSlice>`__
@ -1165,7 +1165,7 @@ using
ReadReal
--------
`id=0.547608842907 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/ReadReal>`__
@ -1213,7 +1213,7 @@ and returned. Otherwise the result is not determined.
ReadRealByName
--------------
`id=0.199185093644 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/ReadRealByName>`__
@ -1254,7 +1254,7 @@ and
ReadString
----------
`id=0.228184525072 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/ReadString>`__
@ -1295,7 +1295,7 @@ is returned. Otherwise the result is not determined.
ReadStringByName
----------------
`id=0.742009259569 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/ReadStringByName>`__
@ -1336,7 +1336,7 @@ and
RegisterType
------------
`id=0.10246276777 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/RegisterType>`__
@ -1368,7 +1368,7 @@ so the user should delete it after calling the function.
Release
-------
`id=0.367773300801 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/Release>`__
@ -1398,7 +1398,7 @@ with the double pointer.
ReleaseFileStorage
------------------
`id=0.300689925981 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/ReleaseFileStorage>`__
@ -1426,7 +1426,7 @@ The function closes the file associated with the storage and releases all the te
Save
----
`id=0.697129486728 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/Save>`__
@ -1468,7 +1468,7 @@ The function saves an object to a file. It provides a simple interface to
StartNextStream
---------------
`id=0.540837242781 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/StartNextStream>`__
@ -1496,7 +1496,7 @@ The function starts the next stream in file storage. Both YAML and XML support m
StartReadRawData
----------------
`id=0.262029855416 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/StartReadRawData>`__
@ -1532,7 +1532,7 @@ The function initializes the sequence reader to read data from a file node. The
StartWriteStruct
----------------
`id=0.604510957069 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/StartWriteStruct>`__
@ -1598,7 +1598,7 @@ function for a some user object (see
TypeOf
------
`id=0.618133406874 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/TypeOf>`__
@ -1631,7 +1631,7 @@ the latter case, the function returns NULL.
UnregisterType
--------------
`id=0.894988383071 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/UnregisterType>`__
@ -1668,7 +1668,7 @@ iterating the type list, starting from
Write
-----
`id=0.950003121002 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/Write>`__
@ -1784,7 +1784,7 @@ description:
WriteComment
------------
`id=0.075756561075 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/WriteComment>`__
@ -1818,7 +1818,7 @@ The function writes a comment into file storage. The comments are skipped when t
WriteFileNode
-------------
`id=0.595246053119 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/WriteFileNode>`__
@ -1856,7 +1856,7 @@ The function writes a copy of a file node to file storage. Possible applications
WriteInt
--------
`id=0.339025962084 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/WriteInt>`__
@ -1890,7 +1890,7 @@ The function writes a single integer value (with or without a name) to the file
WriteRawData
------------
`id=0.300064906822 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/WriteRawData>`__
@ -1968,7 +1968,7 @@ have a name, they should be written to a sequence rather than a map.
WriteReal
---------
`id=0.882217128317 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/WriteReal>`__
@ -2033,7 +2033,7 @@ registering a new type.
WriteString
-----------
`id=0.310765342599 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/core/WriteString>`__

4
doc/opencv1/c/features2d_feature_detection_and_description.rst
View File

@ -29,7 +29,7 @@ Feature detection and description
ExtractSURF
-----------
`id=0.726137466362 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/features2d/ExtractSURF>`__
@ -136,7 +136,7 @@ demo in OpenCV samples directory.
GetStarKeypoints
----------------
`id=0.460873667573 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/features2d/GetStarKeypoints>`__

20
doc/opencv1/c/highgui_qt_new_functions.rst
View File

@ -87,7 +87,7 @@ The following code is an example used to generate the figure.
SetWindowProperty
-----------------
`id=0.0287199623208 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/SetWindowProperty>`__
@ -158,7 +158,7 @@ allows to change the window's properties.
GetWindowProperty
-----------------
`id=0.951341223423 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/GetWindowProperty>`__
@ -209,7 +209,7 @@ return window's properties.
FontQt
------
`id=0.31590502208 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/FontQt>`__
:ref:`addText`
@ -304,7 +304,7 @@ A basic usage of this function is:
AddText
-------
`id=0.363444830722 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/AddText>`__
@ -352,7 +352,7 @@ using a specific font
DisplayOverlay
--------------
`id=0.523794338823 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/DisplayOverlay>`__
@ -391,7 +391,7 @@ aims at displaying useful information/tips on the window for a certain amount of
DisplayStatusBar
----------------
`id=0.240145617982 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/DisplayStatusBar>`__
@ -433,7 +433,7 @@ flags).
CreateOpenGLCallback
--------------------
`id=0.0904185033479 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/CreateOpenGLCallback>`__
*_*
@ -531,7 +531,7 @@ can be used to draw 3D data on the window. An example of callback could be:
SaveWindowParameters
--------------------
`id=0.0271612689206 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/SaveWindowParameters>`__
*_*
@ -561,7 +561,7 @@ saves size, location, flags, trackbars' value, zoom and panning location of the
LoadWindowParameters
--------------------
`id=0.700334072235 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/LoadWindowParameters>`__
*_*
@ -591,7 +591,7 @@ load size, location, flags, trackbars' value, zoom and panning location of the
CreateButton
------------
`id=0.718841096532 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/CreateButton>`__
*_*

30
doc/opencv1/c/highgui_reading_and_writing_images_and_video.rst
View File

@ -12,7 +12,7 @@ Reading and Writing Images and Video
LoadImage
---------
`id=0.469255746245 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/LoadImage>`__
@ -82,7 +82,7 @@ Note that in the current implementation the alpha channel, if any, is stripped f
LoadImageM
----------
`id=0.563485365507 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/LoadImageM>`__
@ -153,7 +153,7 @@ Note that in the current implementation the alpha channel, if any, is stripped f
SaveImage
---------
`id=0.495970549198 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/SaveImage>`__
@ -197,7 +197,7 @@ to save the image to XML or YAML format.
CvCapture
---------
`id=0.279260095238 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/CvCapture>`__
.. ctype:: CvCapture
@ -224,7 +224,7 @@ does not have a public interface and is used only as a parameter for video captu
CaptureFromCAM
--------------
`id=0.051648241367 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/CaptureFromCAM>`__
@ -259,7 +259,7 @@ To release the structure, use
CaptureFromFile
---------------
`id=0.832457799312 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/CaptureFromFile>`__
@ -293,7 +293,7 @@ function.
GetCaptureProperty
------------------
`id=0.315272026867 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/GetCaptureProperty>`__
@ -387,7 +387,7 @@ retrieves the specified property of the camera or video file.
GrabFrame
---------
`id=0.423832304356 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/GrabFrame>`__
@ -422,7 +422,7 @@ should be used.
QueryFrame
----------
`id=0.155007724473 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/QueryFrame>`__
@ -456,7 +456,7 @@ and
ReleaseCapture
--------------
`id=0.412581622343 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/ReleaseCapture>`__
@ -489,7 +489,7 @@ or
RetrieveFrame
-------------
`id=0.780832955331 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/RetrieveFrame>`__
@ -522,7 +522,7 @@ function. The returned image should not be released or modified by the user. In
SetCaptureProperty
------------------
`id=0.0459451505183 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/SetCaptureProperty>`__
@ -624,7 +624,7 @@ NB This function currently does nothing when using the latest CVS download on li
CreateVideoWriter
-----------------
`id=0.960560559623 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/CreateVideoWriter>`__
@ -670,7 +670,7 @@ Which codecs and file formats are supported depends on the back end library. On
ReleaseVideoWriter
------------------
`id=0.271528060303 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/ReleaseVideoWriter>`__
@ -699,7 +699,7 @@ finishes writing to the video file and releases the structure.
WriteFrame
----------
`id=0.0551918795805 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/WriteFrame>`__

30
doc/opencv1/c/highgui_user_interface.rst
View File

@ -12,7 +12,7 @@ User Interface
ConvertImage
------------
`id=0.770096998899 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/ConvertImage>`__
@ -56,7 +56,7 @@ converts one image to another and flips the result vertically if desired. The fu
CreateTrackbar
--------------
`id=0.331453824667 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/CreateTrackbar>`__
@ -130,7 +130,7 @@ By clicking on the label of each trackbar, it is possible to edit the trackbar's
DestroyAllWindows
-----------------
`id=0.237220691544 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/DestroyAllWindows>`__
@ -153,7 +153,7 @@ destroys all of the opened HighGUI windows.
DestroyWindow
-------------
`id=0.224383930532 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/DestroyWindow>`__
@ -183,7 +183,7 @@ destroys the window with the given name.
GetTrackbarPos
--------------
`id=0.99562223249 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/GetTrackbarPos>`__
@ -226,7 +226,7 @@ qt-specific details:
GetWindowHandle
---------------
`id=0.506913773725 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/GetWindowHandle>`__
@ -264,7 +264,7 @@ returns the native window handle inheriting from the Qt class QWidget.
GetWindowName
-------------
`id=0.793825437585 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/GetWindowName>`__
@ -301,7 +301,7 @@ returns the name of the window given its native handle (QWidget).
InitSystem
----------
`id=0.090225420475 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/InitSystem>`__
@ -349,7 +349,7 @@ is automatically called at the first cvNameWindow call.
MoveWindow
----------
`id=0.601355766212 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/MoveWindow>`__
@ -385,7 +385,7 @@ changes the position of the window.
NamedWindow
-----------
`id=0.661605671694 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/NamedWindow>`__
@ -456,7 +456,7 @@ qt-specific details:
ResizeWindow
------------
`id=0.689489754706 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/ResizeWindow>`__
@ -492,7 +492,7 @@ changes the size of the window.
SetMouseCallback
----------------
`id=0.619148465549 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/SetMouseCallback>`__
@ -593,7 +593,7 @@ parameter is a combination of :
SetTrackbarPos
--------------
`id=0.998171131545 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/SetTrackbarPos>`__
@ -639,7 +639,7 @@ qt-specific details:
ShowImage
---------
`id=0.466244635488 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/ShowImage>`__
@ -691,7 +691,7 @@ flag then the image is shown with its original size, otherwise the image is scal
WaitKey
-------
`id=0.996058007458 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/highgui/WaitKey>`__

18
doc/opencv1/c/imgproc_feature_detection.rst
View File

@ -12,7 +12,7 @@ Feature Detection
Canny
-----
`id=0.99528666363 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Canny>`__
@ -60,7 +60,7 @@ is used for edge linking, the largest value is used to find the initial segments
CornerEigenValsAndVecs
----------------------
`id=0.880597486716 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CornerEigenValsAndVecs>`__
@ -131,7 +131,7 @@ where
CornerHarris
------------
`id=0.765194293954 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CornerHarris>`__
@ -190,7 +190,7 @@ to the destination image. Corners in the image can be found as the local maxima
CornerMinEigenVal
-----------------
`id=0.956867089452 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CornerMinEigenVal>`__
@ -231,7 +231,7 @@ in terms of the previous function.
FindCornerSubPix
----------------
`id=0.941466183497 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/FindCornerSubPix>`__
@ -336,7 +336,7 @@ and then iterates until the center keeps within a set threshold.
GoodFeaturesToTrack
-------------------
`id=0.0876392134647 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/GoodFeaturesToTrack>`__
@ -423,7 +423,7 @@ will be the prefix of the output corners array with
HoughLines2
-----------
`id=0.689753287363 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/HoughLines2>`__
@ -611,7 +611,7 @@ case):
PreCornerDetect
---------------
`id=0.671562199289 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/PreCornerDetect>`__
@ -681,7 +681,7 @@ The corners can be found as local maximums of the function below:
SampleLine
----------
`id=0.852353847021 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/SampleLine>`__

20
doc/opencv1/c/imgproc_geometric_image_transformations.rst
View File

@ -69,7 +69,7 @@ and to the simplest and the fastest
GetRotationMatrix2D
-------------------
`id=0.623450579574 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/GetRotationMatrix2D>`__
@ -126,7 +126,7 @@ The transformation maps the rotation center to itself. If this is not the purpos
GetAffineTransform
------------------
`id=0.933805421933 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/GetAffineTransform>`__
@ -178,7 +178,7 @@ where
GetPerspectiveTransform
-----------------------
`id=0.709057737517 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/GetPerspectiveTransform>`__
@ -232,7 +232,7 @@ where
GetQuadrangleSubPix
-------------------
`id=0.480550634961 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/GetQuadrangleSubPix>`__
@ -301,7 +301,7 @@ The values of pixels at non-integer coordinates are retrieved using bilinear int
GetRectSubPix
-------------
`id=0.37305758361 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/GetRectSubPix>`__
@ -354,7 +354,7 @@ pixel values beyond the image boundaries.
LogPolar
--------
`id=0.0887380164552 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/LogPolar>`__
@ -487,7 +487,7 @@ is passed to it
Remap
-----
`id=0.485916549227 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Remap>`__
@ -547,7 +547,7 @@ Note that the function can not operate in-place.
Resize
------
`id=0.249690626324 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Resize>`__
@ -598,7 +598,7 @@ so that it fits exactly into
WarpAffine
----------
`id=0.0915967317176 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/WarpAffine>`__
@ -681,7 +681,7 @@ function from cxcore.
WarpPerspective
---------------
`id=0.647385091755 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/WarpPerspective>`__

34
doc/opencv1/c/imgproc_histograms.rst
View File

@ -12,7 +12,7 @@ Histograms
CvHistogram
-----------
`id=0.29416496784 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CvHistogram>`__
.. ctype:: CvHistogram
@ -48,7 +48,7 @@ Multi-dimensional histogram.
CalcBackProject
---------------
`id=0.262445080297 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CalcBackProject>`__
@ -108,7 +108,7 @@ That is the approximate algorithm of Camshift color object tracker, except for t
CalcBackProjectPatch
--------------------
`id=0.510320009557 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CalcBackProjectPatch>`__
@ -193,7 +193,7 @@ Back Project Calculation by Patches
CalcHist
--------
`id=0.247250829359 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CalcHist>`__
@ -301,7 +301,7 @@ input images.
CalcProbDensity
---------------
`id=0.806356307482 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CalcProbDensity>`__
@ -349,7 +349,7 @@ So the destination histogram bins are within less than
ClearHist
---------
`id=0.835401602212 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/ClearHist>`__
@ -377,7 +377,7 @@ The function sets all of the histogram bins to 0 in the case of a dense histogra
CompareHist
-----------
`id=0.50848857362 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CompareHist>`__
@ -495,7 +495,7 @@ function.
CopyHist
--------
`id=0.454990024463 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CopyHist>`__
@ -537,7 +537,7 @@ as in
CreateHist
----------
`id=0.761254826094 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CreateHist>`__
@ -602,7 +602,7 @@ bin ranges, they assume thy are equally spaced in 0 to 255 bins.
GetHistValue*D
--------------
`id=0.909653638644 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/GetHistValue%2AD>`__
@ -668,7 +668,7 @@ return a pointer to the specified bin of the 1D, 2D, 3D or N-D histogram. In the
GetMinMaxHistValue
------------------
`id=0.649289865958 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/GetMinMaxHistValue>`__
@ -713,7 +713,7 @@ is returned.
MakeHistHeaderForArray
----------------------
`id=0.153593673347 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/MakeHistHeaderForArray>`__
@ -759,7 +759,7 @@ does not need to be called afterwards. Only dense histograms can be initialized
NormalizeHist
-------------
`id=0.494984568711 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/NormalizeHist>`__
@ -792,7 +792,7 @@ The function normalizes the histogram bins by scaling them, such that the sum of
QueryHistValue*D
----------------
`id=0.0495732815752 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/QueryHistValue%2AD>`__
@ -844,7 +844,7 @@ The macros return the value of the specified bin of the 1D, 2D, 3D or N-D histog
ReleaseHist
-----------
`id=0.635490375005 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/ReleaseHist>`__
@ -876,7 +876,7 @@ pointer is already
SetHistBinRanges
----------------
`id=0.097775620677 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/SetHistBinRanges>`__
@ -916,7 +916,7 @@ function, that can initialize the ranges as well. Ranges for the histogram bins
ThreshHist
----------
`id=0.2471087134 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/ThreshHist>`__

24
doc/opencv1/c/imgproc_image_filtering.rst
View File

@ -23,7 +23,7 @@ filter, then during the processing of the left-most pixels in each row we need p
IplConvKernel
-------------
`id=0.193062601082 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/IplConvKernel>`__
.. ctype:: IplConvKernel
@ -41,7 +41,7 @@ An IplConvKernel is a rectangular convolution kernel, created by function
CopyMakeBorder
--------------
`id=0.294015080522 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CopyMakeBorder>`__
@ -88,7 +88,7 @@ The function copies the source 2D array into the interior of the destination arr
CreateStructuringElementEx
--------------------------
`id=0.198112593438 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CreateStructuringElementEx>`__
@ -147,7 +147,7 @@ The function CreateStructuringElementEx allocates and fills the structure
Dilate
------
`id=0.862952069683 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Dilate>`__
@ -196,7 +196,7 @@ The function supports the in-place mode. Dilation can be applied several (
Erode
-----
`id=0.789537037619 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Erode>`__
@ -245,7 +245,7 @@ The function supports the in-place mode. Erosion can be applied several (
Filter2D
--------
`id=0.417959887843 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Filter2D>`__
@ -282,7 +282,7 @@ The function applies an arbitrary linear filter to the image. In-place operation
Laplace
-------
`id=0.525523278714 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Laplace>`__
@ -338,7 +338,7 @@ function, no scaling is done and the same combinations of input and output forma
MorphologyEx
------------
`id=0.564904115593 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/MorphologyEx>`__
@ -442,7 +442,7 @@ is required for a morphological gradient and, in the case of in-place operation,
PyrDown
-------
`id=0.202607003604 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/PyrDown>`__
@ -476,7 +476,7 @@ The function performs the downsampling step of the Gaussian pyramid decompositio
ReleaseStructuringElement
-------------------------
`id=0.80859820706 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/ReleaseStructuringElement>`__
@ -509,7 +509,7 @@ is
Smooth
------
`id=0.653842638158 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Smooth>`__
@ -585,7 +585,7 @@ Median and bilateral filters work with 1- or 3-channel 8-bit images and can not
Sobel
-----
`id=0.415353284486 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Sobel>`__

20
doc/opencv1/c/imgproc_miscellaneous_image_transformations.rst
View File

@ -12,7 +12,7 @@ Miscellaneous Image Transformations
AdaptiveThreshold
-----------------
`id=0.746186116585 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/AdaptiveThreshold>`__
@ -106,7 +106,7 @@ pixel neighborhood, minus
CvtColor
--------
`id=0.233371940793 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CvtColor>`__
@ -685,7 +685,7 @@ The function can do the following transformations:
DistTransform
-------------
`id=0.370026475978 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/DistTransform>`__
@ -832,7 +832,7 @@ Voronoi diagram for the binary image.
CvConnectedComp
---------------
`id=0.585492926457 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CvConnectedComp>`__
.. ctype:: CvConnectedComp
@ -866,7 +866,7 @@ CvConnectedComp
FloodFill
---------
`id=0.303812867907 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/FloodFill>`__
@ -1014,7 +1014,7 @@ is the value of one of pixel neighbors. That is, to be added to the connected co
Inpaint
-------
`id=0.233020618935 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Inpaint>`__
@ -1060,7 +1060,7 @@ The function reconstructs the selected image area from the pixel near the area b
Integral
--------
`id=0.247498066723 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Integral>`__
@ -1130,7 +1130,7 @@ It makes possible to do a fast blurring or fast block correlation with variable
PyrMeanShiftFiltering
---------------------
`id=0.448320960436 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/PyrMeanShiftFiltering>`__
@ -1224,7 +1224,7 @@ running the meanshift procedure on the whole original image (i.e. when
PyrSegmentation
---------------
`id=0.0310203817733 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/PyrSegmentation>`__
@ -1302,7 +1302,7 @@ should be 8-bit single-channel or 3-channel images or equal size.
Threshold
---------
`id=0.57512876324 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Threshold>`__

8
doc/opencv1/c/imgproc_motion_analysis_and_object_tracking.rst
View File

@ -12,7 +12,7 @@ Motion Analysis and Object Tracking
Acc
---
`id=0.999960514281 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Acc>`__
@ -57,7 +57,7 @@ or its selected region to the accumulator
MultiplyAcc
-----------
`id=0.550586168837 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/MultiplyAcc>`__
@ -103,7 +103,7 @@ The function adds the product of 2 images or their selected regions to the accum
RunningAvg
----------
`id=0.0736920452652 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/RunningAvg>`__
@ -157,7 +157,7 @@ regulates the update speed (how fast the accumulator forgets about previous fram
SquareAcc
---------
`id=0.22065009551 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/SquareAcc>`__

2
doc/opencv1/c/imgproc_object_detection.rst
View File

@ -12,7 +12,7 @@ Object Detection
MatchTemplate
-------------
`id=0.133207508798 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/MatchTemplate>`__

26
doc/opencv1/c/imgproc_planar_subdivisions.rst
View File

@ -12,7 +12,7 @@ Planar Subdivisions
CvSubdiv2D
----------
`id=0.0330142359402 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CvSubdiv2D>`__
.. ctype:: CvSubdiv2D
@ -80,7 +80,7 @@ morphing, fast location of points on the plane, building special graphs
CvQuadEdge2D
------------
`id=0.774421357321 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CvQuadEdge2D>`__
.. ctype:: CvQuadEdge2D
@ -131,7 +131,7 @@ Quad-edge is a basic element of subdivision containing four edges (e, eRot, reve
CvSubdiv2DPoint
---------------
`id=0.348865048627 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CvSubdiv2DPoint>`__
.. ctype:: CvSubdiv2DPoint
@ -179,7 +179,7 @@ Point of original or dual subdivision.
CalcSubdivVoronoi2D
-------------------
`id=0.780234504298 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CalcSubdivVoronoi2D>`__
@ -210,7 +210,7 @@ cell at that point.
ClearSubdivVoronoi2D
--------------------
`id=0.598833189257 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/ClearSubdivVoronoi2D>`__
@ -243,7 +243,7 @@ was modified after previous call to the function.
CreateSubdivDelaunay2D
----------------------
`id=0.740903386025 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CreateSubdivDelaunay2D>`__
@ -282,7 +282,7 @@ Note that the triangulation is a single large triangle that covers the given rec
FindNearestPoint2D
------------------
`id=0.89077983265 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/FindNearestPoint2D>`__
@ -319,7 +319,7 @@ point. The function returns a pointer to the found subdivision vertex.
Subdiv2DEdgeDst
---------------
`id=0.475748447952 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Subdiv2DEdgeDst>`__
@ -352,7 +352,7 @@ can be calculated using the function
Subdiv2DGetEdge
---------------
`id=0.128594743275 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Subdiv2DGetEdge>`__
@ -417,7 +417,7 @@ The function returns one of the edges related to the input edge.
Subdiv2DNextEdge
----------------
`id=0.250529497726 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Subdiv2DNextEdge>`__
@ -455,7 +455,7 @@ is the input edge)
Subdiv2DLocate
--------------
`id=0.195353110226 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Subdiv2DLocate>`__
@ -536,7 +536,7 @@ The function locates the input point within the subdivision. There are 5 cases:
Subdiv2DRotateEdge
------------------
`id=0.808074440668 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Subdiv2DRotateEdge>`__
@ -587,7 +587,7 @@ The function returns one of the edges of the same quad-edge as the input edge.
SubdivDelaunay2DInsert
----------------------
`id=0.318236209384 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/SubdivDelaunay2DInsert>`__

68
doc/opencv1/c/imgproc_structural_analysis_and_shape_descriptors.rst
View File

@ -12,7 +12,7 @@ Structural Analysis and Shape Descriptors
ApproxChains
------------
`id=0.432936866636 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/ApproxChains>`__
@ -63,7 +63,7 @@ fields of the returned structure.
ApproxPoly
----------
`id=0.861831385172 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/ApproxPoly>`__
@ -109,7 +109,7 @@ correspondence).
ArcLength
---------
`id=0.382186875357 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/ArcLength>`__
@ -154,7 +154,7 @@ The function calculates the length or curve as the sum of lengths of segments be
BoundingRect
------------
`id=0.99193394782 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/BoundingRect>`__
@ -200,7 +200,7 @@ Here is the list of possible combination of the flag values and type of
BoxPoints
---------
`id=0.15348377114 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/BoxPoints>`__
@ -258,7 +258,7 @@ Here is the function code:
CalcPGH
-------
`id=0.713512953819 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CalcPGH>`__
@ -303,7 +303,7 @@ definition). The histogram can be used for contour matching.
CalcEMD2
--------
`id=0.642501185958 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CalcEMD2>`__
@ -364,7 +364,7 @@ so that they cannot relate to the same object.
CheckContourConvexity
---------------------
`id=0.596409711678 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CheckContourConvexity>`__
@ -392,7 +392,7 @@ The function tests whether the input contour is convex or not. The contour must
CvConvexityDefect
-----------------
`id=0.0456666449216 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CvConvexityDefect>`__
.. ctype:: CvConvexityDefect
@ -432,7 +432,7 @@ Structure describing a single contour convexity defect.
ContourArea
-----------
`id=0.579530349862 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/ContourArea>`__
@ -478,7 +478,7 @@ function from C runtime to get the absolute value of the area.
ContourFromContourTree
----------------------
`id=0.283577660364 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/ContourFromContourTree>`__
@ -514,7 +514,7 @@ determines the accuracy and/or the number of tree levels used for reconstruction
ConvexHull2
-----------
`id=0.07365440701 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/ConvexHull2>`__
@ -661,7 +661,7 @@ Example. Building convex hull for a sequence or array of points
ConvexityDefects
----------------
`id=0.246826049247 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/ConvexityDefects>`__
@ -695,7 +695,7 @@ The function finds all convexity defects of the input contour and returns a sequ
CreateContourTree
-----------------
`id=0.116090901246 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/CreateContourTree>`__
@ -737,7 +737,7 @@ is less than or equal to 0, the function creates a full binary tree representati
EndFindContours
---------------
`id=0.772927708524 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/EndFindContours>`__
@ -765,7 +765,7 @@ The function finishes the scanning process and returns a pointer to the first co
FindContours
------------
`id=0.804514745402 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/FindContours>`__
@ -874,7 +874,7 @@ is modified by this function.
FindNextContour
---------------
`id=0.251954589601 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/FindNextContour>`__
@ -902,7 +902,7 @@ The function locates and retrieves the next contour in the image and returns a p
FitEllipse2
-----------
`id=0.639828157054 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/FitEllipse2>`__
@ -938,7 +938,7 @@ not half-lengths.
FitLine
-------
`id=0.0204712084438 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/FitLine>`__
@ -1058,7 +1058,7 @@ is a distance function, one of:
GetCentralMoment
----------------
`id=0.574094648001 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/GetCentralMoment>`__
@ -1110,7 +1110,7 @@ are the coordinates of the gravity center:
GetHuMoments
------------
`id=0.56722466619 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/GetHuMoments>`__
@ -1156,7 +1156,7 @@ These values are proved to be invariant to the image scale, rotation, and reflec
GetNormalizedCentralMoment
--------------------------
`id=0.460978782732 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/GetNormalizedCentralMoment>`__
@ -1197,7 +1197,7 @@ The function retrieves the normalized central moment:
GetSpatialMoment
----------------
`id=0.768768789318 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/GetSpatialMoment>`__
@ -1244,7 +1244,7 @@ is the intensity of the pixel
MatchContourTrees
-----------------
`id=0.555027093069 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/MatchContourTrees>`__
@ -1283,7 +1283,7 @@ The function calculates the value of the matching measure for two contour trees.
MatchShapes
-----------
`id=0.492880753336 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/MatchShapes>`__
@ -1386,7 +1386,7 @@ respectively.
MinAreaRect2
------------
`id=0.325416946848 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/MinAreaRect2>`__
@ -1425,7 +1425,7 @@ Picture. Minimal-area bounding rectangle for contour
MinEnclosingCircle
------------------
`id=0.232805538989 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/MinEnclosingCircle>`__
@ -1462,7 +1462,7 @@ if the resultant circle contains all the input points and zero otherwise
Moments
-------
`id=0.145895685877 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/Moments>`__
@ -1498,7 +1498,7 @@ The function calculates spatial and central moments up to the third order and wr
PointPolygonTest
----------------
`id=0.21757803031 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/PointPolygonTest>`__
@ -1550,7 +1550,7 @@ Here is the sample output of the function, where each image pixel is tested agai
PointSeqFromMat
---------------
`id=0.728001629164 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/PointSeqFromMat>`__
@ -1635,7 +1635,7 @@ Here is a simple usage example.
ReadChainPoint
--------------
`id=0.760176226481 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/ReadChainPoint>`__
@ -1663,7 +1663,7 @@ The function returns the current chain point and updates the reader position.
StartFindContours
-----------------
`id=0.411171934048 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/StartFindContours>`__
@ -1708,7 +1708,7 @@ to retrieve the rest of the contours.
StartReadChainPoints
--------------------
`id=0.532234897641 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/StartReadChainPoints>`__
@ -1729,7 +1729,7 @@ The function initializes a special reader.
SubstituteContour
-----------------
`id=0.692706172642 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/imgproc/SubstituteContour>`__

12
doc/opencv1/c/objdetect_cascade_classification.rst
View File

@ -73,7 +73,7 @@ for details.
CvHaarFeature, CvHaarClassifier, CvHaarStageClassifier, CvHaarClassifierCascade
-------------------------------------------------------------------------------
`id=0.970306065104 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/objdetect/CvHaarFeature%2C%20CvHaarClassifier%2C%20CvHaarStageClassifier%2C%20CvHaarClassifierCascade>`__
.. ctype:: CvHaarFeature, CvHaarClassifier, CvHaarStageClassifier, CvHaarClassifierCascade
@ -205,7 +205,7 @@ The whole hierarchy can be constructed manually or loaded from a file or an embe
LoadHaarClassifierCascade
-------------------------
`id=0.804773488212 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/objdetect/LoadHaarClassifierCascade>`__
@ -246,7 +246,7 @@ function.
HaarDetectObjects
-----------------
`id=0.264108155188 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/objdetect/HaarDetectObjects>`__
@ -409,7 +409,7 @@ The function finds rectangular regions in the given image that are likely to con
SetImagesForHaarClassifierCascade
---------------------------------
`id=0.160913357144 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/objdetect/SetImagesForHaarClassifierCascade>`__
@ -455,7 +455,7 @@ function and reused again. The function is used to prepare cascade for detecting
ReleaseHaarClassifierCascade
----------------------------
`id=0.359777913959 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/objdetect/ReleaseHaarClassifierCascade>`__
@ -487,7 +487,7 @@ or
RunHaarClassifierCascade
------------------------
`id=0.100465569078 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/objdetect/RunHaarClassifierCascade>`__

38
doc/opencv1/c/video_motion_analysis_and_object_tracking.rst
View File

@ -12,7 +12,7 @@ Motion Analysis and Object Tracking
CalcGlobalOrientation
---------------------
`id=0.848432169537 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/CalcGlobalOrientation>`__
@ -59,7 +59,7 @@ a circular sum of the basic orientation and the shift.
CalcMotionGradient
------------------
`id=0.691063668639 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/CalcMotionGradient>`__
@ -143,7 +143,7 @@ neighborhood and assumes the gradient is valid only if
CalcOpticalFlowBM
-----------------
`id=0.754519759158 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/CalcOpticalFlowBM>`__
@ -209,7 +209,7 @@ function call (if
CalcOpticalFlowHS
-----------------
`id=0.152735471909 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/CalcOpticalFlowHS>`__
@ -257,7 +257,7 @@ Horn81
CalcOpticalFlowLK
-----------------
`id=0.853253276574 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/CalcOpticalFlowLK>`__
@ -299,7 +299,7 @@ Lucas81
CalcOpticalFlowPyrLK
--------------------
`id=0.47107753089 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/CalcOpticalFlowPyrLK>`__
@ -396,7 +396,7 @@ is set).
CamShift
--------
`id=0.583105572641 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/CamShift>`__
@ -487,7 +487,7 @@ http://www.dai.ed.ac.uk/CVonline/LOCAL\_COPIES/ISARD1/condensation.html
CreateConDensation
------------------
`id=0.31878352255 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/CreateConDensation>`__
@ -523,7 +523,7 @@ structure and returns a pointer to the structure.
ConDensInitSampleSet
--------------------
`id=0.386398764636 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/ConDensInitSampleSet>`__
@ -558,7 +558,7 @@ with values within the specified ranges.
CvKalman
--------
`id=0.625509453461 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/CvKalman>`__
.. ctype:: CvKalman
@ -691,7 +691,7 @@ structure is allocated via
CreateKalman
------------
`id=0.495816671145 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/CreateKalman>`__
@ -728,7 +728,7 @@ and all its matrices and initializes them somehow.
KalmanCorrect
-------------
`id=0.247263362016 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/KalmanCorrect>`__
@ -902,7 +902,7 @@ Example. Using Kalman filter to track a rotating point
KalmanPredict
-------------
`id=0.406145730558 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/KalmanPredict>`__
@ -972,7 +972,7 @@ Synonym for
MeanShift
---------
`id=0.377464124859 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/MeanShift>`__
@ -1013,7 +1013,7 @@ of iterations. The function returns the number of iterations made.
ReleaseConDensation
-------------------
`id=0.860558456819 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/ReleaseConDensation>`__
@ -1043,7 +1043,7 @@ The function releases the structure
ReleaseKalman
-------------
`id=0.202454950979 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/ReleaseKalman>`__
@ -1073,7 +1073,7 @@ and all of the underlying matrices.
SegmentMotion
-------------
`id=0.604815881374 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/SegmentMotion>`__
@ -1125,7 +1125,7 @@ component
SnakeImage
----------
`id=0.376286588765 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/SnakeImage>`__
@ -1207,7 +1207,7 @@ iterations, the function terminates.
UpdateMotionHistory
-------------------
`id=0.131540988983 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/c/video/UpdateMotionHistory>`__

220
doc/opencv1/conf.py
View File

@ -1,220 +0,0 @@
# -*- coding: utf-8 -*-
#
# opencvstd documentation build configuration file, created by
# sphinx-quickstart on Mon Feb 14 00:30:43 2011.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.pngmath', 'sphinx.ext.ifconfig', 'sphinx.ext.todo']
doctest_test_doctest_blocks = 'block'
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'opencvrefman1x'
copyright = u'2011, opencv dev team'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '2.3'
# The full version, including alpha/beta/rc tags.
release = '2.3'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
todo_include_todos=True
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'blue'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['../_themes']
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = '../opencv-logo2.png'
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['../_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'opencv1x'
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'opencv1x.tex', u'The OpenCV 1.x API Reference Manual',
u'', 'manual'),
]
latex_elements = {'preamble': '\usepackage{mymath}\usepackage{amssymb}\usepackage{amsmath}\usepackage{bbm}'}
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
latex_use_parts = True
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'opencv1x', u'The OpenCV 1.x API Reference Manual',
[u'opencv-dev@itseez.com'], 1)
]

16
doc/opencv1/index.rst
View File

@ -1,16 +0,0 @@
Welcome to opencv 1.x reference manual
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Contents:
.. toctree::
:maxdepth: 2
c/c_index
py/py_index
bibliography
Indices and tables
~~~~~~~~~~~~~~~~~~
* :ref:`genindex`
* :ref:`search`

60
doc/opencv1/py/calib3d_camera_calibration_and_3d_reconstruction.rst
View File

@ -157,7 +157,7 @@ The functions below use the above model to
CalibrateCamera2
----------------
`id=0.782194232075 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/CalibrateCamera2>`__
.. function:: CalibrateCamera2(objectPoints,imagePoints,pointCounts,imageSize,cameraMatrix,distCoeffs,rvecs,tvecs,flags=0)-> None
@ -316,7 +316,7 @@ See also:
ComputeCorrespondEpilines
-------------------------
`id=0.812565376037 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/ComputeCorrespondEpilines>`__
.. function:: ComputeCorrespondEpilines(points, whichImage, F, lines) -> None
@ -398,7 +398,7 @@ Line coefficients are defined up to a scale. They are normalized, such that
ConvertPointsHomogeneous
------------------------
`id=0.174046913553 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/ConvertPointsHomogeneous>`__
.. function:: ConvertPointsHomogeneous( src, dst ) -> None
@ -442,7 +442,7 @@ If the output array dimensionality is larger, an extra 1 is appended to each poi
CreatePOSITObject
-----------------
`id=0.575884728475 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/CreatePOSITObject>`__
.. function:: CreatePOSITObject(points)-> POSITObject
@ -484,7 +484,7 @@ must be called to free memory.
CreateStereoBMState
-------------------
`id=0.181953212374 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/CreateStereoBMState>`__
.. function:: CreateStereoBMState(preset=CV_STEREO_BM_BASIC,numberOfDisparities=0)-> StereoBMState
@ -529,7 +529,7 @@ the calls to
CreateStereoGCState
-------------------
`id=0.718216892131 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/CreateStereoGCState>`__
.. function:: CreateStereoGCState(numberOfDisparities,maxIters)-> StereoGCState
@ -564,7 +564,7 @@ The function creates the stereo correspondence structure and initializes it. It
CvStereoBMState
---------------
`id=0.314911926499 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/CvStereoBMState>`__
.. class:: CvStereoBMState
@ -698,7 +698,7 @@ Note that the algorithm searches for the corresponding blocks in x direction onl
CvStereoGCState
---------------
`id=0.396531770881 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/CvStereoGCState>`__
.. class:: CvStereoGCState
@ -782,7 +782,7 @@ and then override necessary parameters if needed.
DecomposeProjectionMatrix
-------------------------
`id=0.997149293534 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/DecomposeProjectionMatrix>`__
.. function:: DecomposeProjectionMatrix(projMatrix, cameraMatrix, rotMatrix, transVect, rotMatrX = None, rotMatrY = None, rotMatrZ = None) -> eulerAngles
@ -851,7 +851,7 @@ The function is based on
DrawChessboardCorners
---------------------
`id=0.657339526052 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/DrawChessboardCorners>`__
.. function:: DrawChessboardCorners(image,patternSize,corners,patternWasFound)-> None
@ -894,7 +894,7 @@ The function draws the individual chessboard corners detected as red circles if
FindChessboardCorners
---------------------
`id=0.629260035574 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/FindChessboardCorners>`__
.. function:: FindChessboardCorners(image, patternSize, flags=CV_CALIB_CB_ADAPTIVE_THRESH) -> corners
@ -995,7 +995,7 @@ the function requires some white space (like a square-thick border, the wider th
FindExtrinsicCameraParams2
--------------------------
`id=0.0389878424328 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/FindExtrinsicCameraParams2>`__
.. function:: FindExtrinsicCameraParams2(objectPoints,imagePoints,cameraMatrix,distCoeffs,rvec,tvec,useExtrinsicGuess=0)-> None
@ -1061,7 +1061,7 @@ The function's counterpart in the C++ API is
FindFundamentalMat
------------------
`id=0.89177797951 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/FindFundamentalMat>`__
.. function:: FindFundamentalMat(points1, points2, fundamentalMatrix, method=CV_FM_RANSAC, param1=1., param2=0.99, status = None) -> None
@ -1161,7 +1161,7 @@ to compute the rectification transformation.
FindHomography
--------------
`id=0.964547232485 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/FindHomography>`__
.. function:: FindHomography(srcPoints,dstPoints,H,method,ransacReprojThreshold=3.0, status=None)-> None
@ -1304,7 +1304,7 @@ See also:
FindStereoCorrespondenceBM
--------------------------
`id=0.6416249077 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/FindStereoCorrespondenceBM>`__
.. function:: FindStereoCorrespondenceBM(left,right,disparity,state)-> None
@ -1351,7 +1351,7 @@ in the case of 16-bit fixed-point disparity map)
FindStereoCorrespondenceGC
--------------------------
`id=0.511426409323 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/FindStereoCorrespondenceGC>`__
.. function:: FindStereoCorrespondenceGC( left, right, dispLeft, dispRight, state, useDisparityGuess=(0))-> None
@ -1458,7 +1458,7 @@ left disparity images are usually negative):
GetOptimalNewCameraMatrix
-------------------------
`id=0.850139058889 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/GetOptimalNewCameraMatrix>`__
.. function:: GetOptimalNewCameraMatrix(cameraMatrix, distCoeffs, imageSize, alpha, newCameraMatrix, newImageSize=(0,0), validPixROI=0) -> None
@ -1529,7 +1529,7 @@ to produce the maps for
InitIntrinsicParams2D
---------------------
`id=0.845508653607 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/InitIntrinsicParams2D>`__
.. function:: InitIntrinsicParams2D(objectPoints, imagePoints, npoints, imageSize, cameraMatrix, aspectRatio=1.) -> None
@ -1583,7 +1583,7 @@ Currently, the function only supports planar calibration patterns, i.e. patterns
InitUndistortMap
----------------
`id=0.720345336817 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/InitUndistortMap>`__
.. function:: InitUndistortMap(cameraMatrix,distCoeffs,map1,map2)-> None
@ -1632,7 +1632,7 @@ is identity matrix and
InitUndistortRectifyMap
-----------------------
`id=0.00679135152837 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/InitUndistortRectifyMap>`__
.. function:: InitUndistortRectifyMap(cameraMatrix,distCoeffs,R,newCameraMatrix,map1,map2)-> None
@ -1751,7 +1751,7 @@ can be chosen arbitrarily.
POSIT
-----
`id=0.474051901242 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/POSIT>`__
.. function:: POSIT(posit_object,imagePoints,focal_length,criteria)-> (rotationMatrix,translation_vector)
@ -1808,7 +1808,7 @@ serves to stop the algorithm if the difference is small.
ProjectPoints2
--------------
`id=0.754356933502 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/ProjectPoints2>`__
.. function:: ProjectPoints2(objectPoints,rvec,tvec,cameraMatrix,distCoeffs, imagePoints,dpdrot=NULL,dpdt=NULL,dpdf=NULL,dpdc=NULL,dpddist=NULL)-> None
@ -1907,7 +1907,7 @@ to 3x3 identity matrix, or by passing zero distortion coefficients, you can get
ReprojectImageTo3D
------------------
`id=0.392860739717 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/ReprojectImageTo3D>`__
.. function:: ReprojectImageTo3D(disparity, _3dImage, Q, handleMissingValues=0) -> None
@ -1972,7 +1972,7 @@ matrix, e.g. the one computed by
RQDecomp3x3
-----------
`id=0.479738869484 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/RQDecomp3x3>`__
.. function:: RQDecomp3x3(M, R, Q, Qx = None, Qy = None, Qz = None) -> eulerAngles
@ -2035,7 +2035,7 @@ that could be used in OpenGL.
Rodrigues2
----------
`id=0.83168701891 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/Rodrigues2>`__
.. function:: Rodrigues2(src,dst,jacobian=0)-> None
@ -2098,7 +2098,7 @@ or
StereoCalibrate
---------------
`id=0.0963893421715 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/StereoCalibrate>`__
.. function:: StereoCalibrate( objectPoints, imagePoints1, imagePoints2, pointCounts, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize, R, T, E=NULL, F=NULL, term_crit=(CV_TERMCRIT_ITER+CV_TERMCRIT_EPS,30,1e-6), flags=CV_CALIB_FIX_INTRINSIC)-> None
@ -2273,7 +2273,7 @@ Similarly to
StereoRectify
-------------
`id=0.482375127425 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/StereoRectify>`__
.. function:: StereoRectify( cameraMatrix1, cameraMatrix2, distCoeffs1, distCoeffs2, imageSize, R, T, R1, R2, P1, P2, Q=NULL, flags=CV_CALIB_ZERO_DISPARITY, alpha=-1, newImageSize=(0,0))-> (roi1, roi2)
@ -2431,7 +2431,7 @@ and
StereoRectifyUncalibrated
-------------------------
`id=0.234617492311 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/StereoRectifyUncalibrated>`__
.. function:: StereoRectifyUncalibrated(points1,points2,F,imageSize,H1,H2,threshold=5)-> None
@ -2493,7 +2493,7 @@ and then the images can be corrected using
Undistort2
----------
`id=0.0228781107726 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/Undistort2>`__
.. function:: Undistort2(src,dst,cameraMatrix,distCoeffs)-> None
@ -2563,7 +2563,7 @@ need to be scaled accordingly, while the distortion coefficients remain the same
UndistortPoints
---------------
`id=0.00872451686413 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/calib3d/UndistortPoints>`__
.. function:: UndistortPoints(src,dst,cameraMatrix,distCoeffs,R=NULL,P=NULL)-> None

28
doc/opencv1/py/core_basic_structures.rst
View File

@ -12,7 +12,7 @@ Basic Structures
CvPoint
-------
`id=0.407060643954 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CvPoint>`__
.. class:: CvPoint
@ -31,7 +31,7 @@ CvPoint
CvPoint2D32f
------------
`id=0.638091190655 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CvPoint2D32f>`__
.. class:: CvPoint2D32f
@ -50,7 +50,7 @@ CvPoint2D32f
CvPoint3D32f
------------
`id=0.334583364495 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CvPoint3D32f>`__
.. class:: CvPoint3D32f
@ -69,7 +69,7 @@ CvPoint3D32f
CvPoint2D64f
------------
`id=0.352962148614 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CvPoint2D64f>`__
.. class:: CvPoint2D64f
@ -88,7 +88,7 @@ CvPoint2D64f
CvPoint3D64f
------------
`id=0.00812295344272 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CvPoint3D64f>`__
.. class:: CvPoint3D64f
@ -107,7 +107,7 @@ CvPoint3D64f
CvSize
------
`id=0.980418044509 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CvSize>`__
.. class:: CvSize
@ -126,7 +126,7 @@ Size of a rectangle, represented as a tuple
CvSize2D32f
-----------
`id=0.623013904609 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CvSize2D32f>`__
.. class:: CvSize2D32f
@ -145,7 +145,7 @@ Size of a rectangle, represented as a tuple
CvRect
------
`id=0.706717090055 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CvRect>`__
.. class:: CvRect
@ -164,7 +164,7 @@ Rectangle, represented as a tuple
CvScalar
--------
`id=0.733448405451 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CvScalar>`__
.. class:: CvScalar
@ -202,7 +202,7 @@ CvScalar is always represented as a 4-tuple.
CvTermCriteria
--------------
`id=0.996691519996 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CvTermCriteria>`__
.. class:: CvTermCriteria
@ -264,7 +264,7 @@ Represented by a tuple
CvMat
-----
`id=0.619633266675 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CvMat>`__
.. class:: CvMat
@ -332,7 +332,7 @@ A multi-channel 2D matrix. Created by
CvMatND
-------
`id=0.493284398358 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CvMatND>`__
.. class:: CvMatND
@ -368,7 +368,7 @@ Multi-dimensional dense multi-channel array.
IplImage
--------
`id=0.479556472461 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/IplImage>`__
.. class:: IplImage
@ -493,7 +493,7 @@ formats.
CvArr
-----
`id=0.249942454209 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CvArr>`__
.. class:: CvArr

2
doc/opencv1/py/core_clustering.rst
View File

@ -12,7 +12,7 @@ Clustering
KMeans2
-------
`id=0.682106387651 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/KMeans2>`__
.. function:: KMeans2(samples,nclusters,labels,termcrit)-> None

30
doc/opencv1/py/core_drawing_functions.rst
View File

@ -42,7 +42,7 @@ is simply copied to the repainted pixels. Thus, if you want to paint semi-transp
Circle
------
`id=0.300689351141 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/Circle>`__
.. function:: Circle(img,center,radius,color,thickness=1,lineType=8,shift=0)-> None
@ -101,7 +101,7 @@ given center and radius.
ClipLine
--------
`id=0.251101842576 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/ClipLine>`__
.. function:: ClipLine(imgSize, pt1, pt2) -> (clipped_pt1, clipped_pt2)
@ -139,7 +139,7 @@ If the line segment is outside the image, it returns None. If the line segment i
DrawContours
------------
`id=0.919530584794 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/DrawContours>`__
.. function:: DrawContours(img,contour,external_color,hole_color,max_level,thickness=1,lineType=8,offset=(0,0))-> None
@ -207,7 +207,7 @@ or fills the area bounded by the contours if
Ellipse
-------
`id=0.149495013833 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/Ellipse>`__
.. function:: Ellipse(img,center,axes,angle,start_angle,end_angle,color,thickness=1,lineType=8,shift=0)-> None
@ -292,7 +292,7 @@ Parameters of Elliptic Arc
EllipseBox
----------
`id=0.217567751917 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/EllipseBox>`__
.. function:: EllipseBox(img,box,color,thickness=1,lineType=8,shift=0)-> None
@ -344,7 +344,7 @@ do. The ellipse drawn is clipped by ROI rectangle. A piecewise-linear approximat
FillConvexPoly
--------------
`id=0.27807950676 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/FillConvexPoly>`__
.. function:: FillConvexPoly(img,pn,color,lineType=8,shift=0)-> None
@ -398,7 +398,7 @@ line) twice at the most.
FillPoly
--------
`id=0.470054743188 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/FillPoly>`__
.. function:: FillPoly(img,polys,color,lineType=8,shift=0)-> None
@ -448,7 +448,7 @@ areas with holes, contour self-intersection, and so forth.
GetTextSize
-----------
`id=0.723985190989 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/GetTextSize>`__
.. function:: GetTextSize(textString,font)-> (textSize,baseline)
@ -491,7 +491,7 @@ The function calculates the dimensions of a rectangle to enclose a text string w
InitFont
--------
`id=0.526488936836 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/InitFont>`__
.. function:: InitFont(fontFace,hscale,vscale,shear=0,thickness=1,lineType=8)-> font
@ -579,7 +579,7 @@ The function initializes the font structure that can be passed to text rendering
InitLineIterator
----------------
`id=0.352578115956 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/InitLineIterator>`__
.. function:: InitLineIterator(image, pt1, pt2, connectivity=8, left_to_right=0) -> line_iterator
@ -682,7 +682,7 @@ or more concisely using
Line
----
`id=0.32347581651 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/Line>`__
.. function:: Line(img,pt1,pt2,color,thickness=1,lineType=8,shift=0)-> None
@ -764,7 +764,7 @@ the line color, the user may use the macro
PolyLine
--------
`id=0.899614274707 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/PolyLine>`__
.. function:: PolyLine(img,polys,is_closed,color,thickness=1,lineType=8,shift=0)-> None
@ -824,7 +824,7 @@ The function draws single or multiple polygonal curves.
PutText
-------
`id=0.414755160642 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/PutText>`__
.. function:: PutText(img,text,org,font,color)-> None
@ -875,7 +875,7 @@ replaced with the symbol for a rectangle.
Rectangle
---------
`id=0.243634323886 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/Rectangle>`__
.. function:: Rectangle(img,pt1,pt2,color,thickness=1,lineType=8,shift=0)-> None
@ -937,7 +937,7 @@ and
CV_RGB
------
`id=0.224041402111 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CV_RGB>`__
.. function:: CV_RGB(red,grn,blu)->CvScalar

16
doc/opencv1/py/core_dynamic_structures.rst
View File

@ -12,7 +12,7 @@ Dynamic Structures
CvMemStorage
------------
`id=0.11586833925 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CvMemStorage>`__
.. class:: CvMemStorage
@ -51,7 +51,7 @@ to release a CvMemStorage.
CvSeq
-----
`id=0.0938210237552 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CvSeq>`__
.. class:: CvSeq
@ -104,7 +104,7 @@ In this case the methods return the other sequences. If no relation between seq
CvSet
-----
`id=0.165386903844 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CvSet>`__
.. class:: CvSet
@ -137,7 +137,7 @@ Some OpenCV functions return a CvSet object. The CvSet obect is iterable, for ex
CloneSeq
--------
`id=0.893022984961 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CloneSeq>`__
.. function:: CloneSeq(seq,storage)-> None
@ -170,7 +170,7 @@ The function makes a complete copy of the input sequence and returns it.
CreateMemStorage
----------------
`id=0.141261875659 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/CreateMemStorage>`__
.. function:: CreateMemStorage(blockSize = 0) -> memstorage
@ -200,7 +200,7 @@ description.
SeqInvert
---------
`id=0.420185773758 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/SeqInvert>`__
.. function:: SeqInvert(seq)-> None
@ -228,7 +228,7 @@ The function reverses the sequence in-place - makes the first element go last, t
SeqRemove
---------
`id=0.405976799419 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/SeqRemove>`__
.. function:: SeqRemove(seq,index)-> None
@ -268,7 +268,7 @@ the sequence elements between the nearest end of the sequence and the
SeqRemoveSlice
--------------
`id=0.589674828285 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/SeqRemoveSlice>`__
.. function:: SeqRemoveSlice(seq,slice)-> None

272
doc/opencv1/py/core_operations_on_arrays.rst
View File

File diff suppressed because it is too large Load Diff

4
doc/opencv1/py/core_utility_and_system_functions_and_macros.rst
View File

@ -61,7 +61,7 @@ A function with the
GetTickCount
------------
`id=0.81706194546 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/GetTickCount>`__
.. function:: GetTickCount() -> long
@ -82,7 +82,7 @@ The function returns number of the ticks starting from some platform-dependent e
GetTickFrequency
----------------
`id=0.967317163838 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/GetTickFrequency>`__
.. function:: GetTickFrequency() -> long

4
doc/opencv1/py/core_xml_yaml_persistence.rst
View File

@ -12,7 +12,7 @@ XML/YAML Persistence
Load
----
`id=0.778290631419 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/Load>`__
.. function:: Load(filename,storage=NULL,name=NULL)-> generic
@ -56,7 +56,7 @@ should pass a valid memory storage destination to the function.
Save
----
`id=0.295047298682 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/core/Save>`__
.. function:: Save(filename,structPtr,name=NULL,comment=NULL)-> None

6
doc/opencv1/py/features2d_feature_detection_and_description.rst
View File

@ -29,7 +29,7 @@ Feature detection and description
CvSURFPoint
-----------
`id=0.785092904945 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/features2d/CvSURFPoint>`__
.. class:: CvSURFPoint
@ -99,7 +99,7 @@ A SURF keypoint, represented as a tuple
ExtractSURF
-----------
`id=0.999928834286 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/features2d/ExtractSURF>`__
.. function:: ExtractSURF(image,mask,storage,params)-> (keypoints,descriptors)
@ -193,7 +193,7 @@ To extract strong SURF features from an image
GetStarKeypoints
----------------
`id=0.373658080009 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/features2d/GetStarKeypoints>`__
.. function:: GetStarKeypoints(image,storage,params)-> keypoints

26
doc/opencv1/py/highgui_reading_and_writing_images_and_video.rst
View File

@ -12,7 +12,7 @@ Reading and Writing Images and Video
LoadImage
---------
`id=0.709113485048 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/LoadImage>`__
.. function:: LoadImage(filename, iscolor=CV_LOAD_IMAGE_COLOR)->None
@ -84,7 +84,7 @@ Note that in the current implementation the alpha channel, if any, is stripped f
LoadImageM
----------
`id=0.915605899901 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/LoadImageM>`__
.. function:: LoadImageM(filename, iscolor=CV_LOAD_IMAGE_COLOR)->None
@ -157,7 +157,7 @@ Note that in the current implementation the alpha channel, if any, is stripped f
SaveImage
---------
`id=0.496487139898 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/SaveImage>`__
.. function:: SaveImage(filename,image)-> None
@ -203,7 +203,7 @@ to save the image to XML or YAML format.
CvCapture
---------
`id=0.364337205432 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/CvCapture>`__
.. class:: CvCapture
@ -223,7 +223,7 @@ does not have a public interface and is used only as a parameter for video captu
CaptureFromCAM
--------------
`id=0.68934258142 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/CaptureFromCAM>`__
.. function:: CaptureFromCAM(index) -> CvCapture
@ -258,7 +258,7 @@ To release the structure, use
CaptureFromFile
---------------
`id=0.627099214181 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/CaptureFromFile>`__
.. function:: CaptureFromFile(filename) -> CvCapture
@ -292,7 +292,7 @@ function.
GetCaptureProperty
------------------
`id=0.295657731336 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/GetCaptureProperty>`__
.. function:: GetCaptureProperty(capture, property_id)->double
@ -388,7 +388,7 @@ retrieves the specified property of the camera or video file.
GrabFrame
---------
`id=0.664037861142 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/GrabFrame>`__
.. function:: GrabFrame(capture) -> int
@ -423,7 +423,7 @@ should be used.
QueryFrame
----------
`id=0.15232451714 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/QueryFrame>`__
.. function:: QueryFrame(capture) -> iplimage
@ -457,7 +457,7 @@ and
RetrieveFrame
-------------
`id=0.978271497895 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/RetrieveFrame>`__
.. function:: RetrieveFrame(capture) -> iplimage
@ -490,7 +490,7 @@ function. The returned image should not be released or modified by the user. In
SetCaptureProperty
------------------
`id=0.42439239326 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/SetCaptureProperty>`__
.. function:: SetCaptureProperty(capture, property_id,value)->None
@ -596,7 +596,7 @@ NB This function currently does nothing when using the latest CVS download on li
CreateVideoWriter
-----------------
`id=0.778639527068 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/CreateVideoWriter>`__
.. function:: CreateVideoWriter(filename, fourcc, fps, frame_size, is_color) -> CvVideoWriter
@ -650,7 +650,7 @@ Which codecs and file formats are supported depends on the back end library. On
WriteFrame
----------
`id=0.0385991600269 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/WriteFrame>`__
.. function:: WriteFrame(writer, image)->int

22
doc/opencv1/py/highgui_user_interface.rst
View File

@ -12,7 +12,7 @@ User Interface
CreateTrackbar
--------------
`id=0.859200002353 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/CreateTrackbar>`__
.. function:: CreateTrackbar(trackbarName, windowName, value, count, onChange) -> None
@ -82,7 +82,7 @@ By clicking on the label of each trackbar, it is possible to edit the trackbar's
DestroyAllWindows
-----------------
`id=0.386578572057 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/DestroyAllWindows>`__
.. function:: DestroyAllWindows()-> None
@ -103,7 +103,7 @@ destroys all of the opened HighGUI windows.
DestroyWindow
-------------
`id=0.0256606142145 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/DestroyWindow>`__
.. function:: DestroyWindow(name)-> None
@ -133,7 +133,7 @@ destroys the window with the given name.
GetTrackbarPos
--------------
`id=0.0119794922165 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/GetTrackbarPos>`__
.. function:: GetTrackbarPos(trackbarName,windowName)-> None
@ -178,7 +178,7 @@ qt-specific details:
MoveWindow
----------
`id=0.0432662100889 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/MoveWindow>`__
.. function:: MoveWindow(name,x,y)-> None
@ -218,7 +218,7 @@ changes the position of the window.
NamedWindow
-----------
`id=0.155885062255 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/NamedWindow>`__
.. function:: NamedWindow(name,flags=CV_WINDOW_AUTOSIZE)-> None
@ -291,7 +291,7 @@ qt-specific details:
ResizeWindow
------------
`id=0.266699312987 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/ResizeWindow>`__
.. function:: ResizeWindow(name,width,height)-> None
@ -331,7 +331,7 @@ changes the size of the window.
SetMouseCallback
----------------
`id=0.299310906828 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/SetMouseCallback>`__
.. function:: SetMouseCallback(windowName, onMouse, param) -> None
@ -436,7 +436,7 @@ parameter is a combination of :
SetTrackbarPos
--------------
`id=0.722744232916 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/SetTrackbarPos>`__
.. function:: SetTrackbarPos(trackbarName,windowName,pos)-> None
@ -486,7 +486,7 @@ qt-specific details:
ShowImage
---------
`id=0.260802502296 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/ShowImage>`__
.. function:: ShowImage(name,image)-> None
@ -540,7 +540,7 @@ flag then the image is shown with its original size, otherwise the image is scal
WaitKey
-------
`id=0.742095797983 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/highgui/WaitKey>`__
.. function:: WaitKey(delay=0)-> int

16
doc/opencv1/py/imgproc_feature_detection.rst
View File

@ -12,7 +12,7 @@ Feature Detection
Canny
-----
`id=0.573160740956 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Canny>`__
.. function:: Canny(image,edges,threshold1,threshold2,aperture_size=3)-> None
@ -68,7 +68,7 @@ is used for edge linking, the largest value is used to find the initial segments
CornerEigenValsAndVecs
----------------------
`id=0.769586068428 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CornerEigenValsAndVecs>`__
.. function:: CornerEigenValsAndVecs(image,eigenvv,blockSize,aperture_size=3)-> None
@ -145,7 +145,7 @@ where
CornerHarris
------------
`id=0.619256620171 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CornerHarris>`__
.. function:: CornerHarris(image,harris_dst,blockSize,aperture_size=3,k=0.04)-> None
@ -212,7 +212,7 @@ to the destination image. Corners in the image can be found as the local maxima
CornerMinEigenVal
-----------------
`id=0.523904183834 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CornerMinEigenVal>`__
.. function:: CornerMinEigenVal(image,eigenval,blockSize,aperture_size=3)-> None
@ -259,7 +259,7 @@ in terms of the previous function.
FindCornerSubPix
----------------
`id=0.448453276565 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/FindCornerSubPix>`__
.. function:: FindCornerSubPix(image,corners,win,zero_zone,criteria)-> corners
@ -370,7 +370,7 @@ and then iterates until the center keeps within a set threshold.
GoodFeaturesToTrack
-------------------
`id=0.0875265840344 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/GoodFeaturesToTrack>`__
.. function:: GoodFeaturesToTrack(image,eigImage,tempImage,cornerCount,qualityLevel,minDistance,mask=NULL,blockSize=3,useHarris=0,k=0.04)-> corners
@ -472,7 +472,7 @@ will be the prefix of the output corners array with
HoughLines2
-----------
`id=0.925466467327 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/HoughLines2>`__
.. function:: HoughLines2(image,storage,method,rho,theta,threshold,param1=0,param2=0)-> lines
@ -577,7 +577,7 @@ The function implements a few variants of the Hough transform for line detection
PreCornerDetect
---------------
`id=0.420590326716 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/PreCornerDetect>`__
.. function:: PreCornerDetect(image,corners,apertureSize=3)-> None

20
doc/opencv1/py/imgproc_geometric_image_transformations.rst
View File

@ -69,7 +69,7 @@ and to the simplest and the fastest
GetRotationMatrix2D
-------------------
`id=0.155746043393 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/GetRotationMatrix2D>`__
.. function:: GetRotationMatrix2D(center,angle,scale,mapMatrix)-> None
@ -132,7 +132,7 @@ The transformation maps the rotation center to itself. If this is not the purpos
GetAffineTransform
------------------
`id=0.131853152013 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/GetAffineTransform>`__
.. function:: GetAffineTransform(src,dst,mapMatrix)-> None
@ -188,7 +188,7 @@ where
GetPerspectiveTransform
-----------------------
`id=0.411609579387 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/GetPerspectiveTransform>`__
.. function:: GetPerspectiveTransform(src,dst,mapMatrix)-> None
@ -246,7 +246,7 @@ where
GetQuadrangleSubPix
-------------------
`id=0.522776327076 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/GetQuadrangleSubPix>`__
.. function:: GetQuadrangleSubPix(src,dst,mapMatrix)-> None
@ -319,7 +319,7 @@ The values of pixels at non-integer coordinates are retrieved using bilinear int
GetRectSubPix
-------------
`id=0.947278759693 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/GetRectSubPix>`__
.. function:: GetRectSubPix(src,dst,center)-> None
@ -376,7 +376,7 @@ pixel values beyond the image boundaries.
LogPolar
--------
`id=0.991629705277 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/LogPolar>`__
.. function:: LogPolar(src,dst,center,M,flags=CV_INNER_LINEAR+CV_WARP_FILL_OUTLIERS)-> None
@ -468,7 +468,7 @@ The function can not operate in-place.
Remap
-----
`id=0.129979785029 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Remap>`__
.. function:: Remap(src,dst,mapx,mapy,flags=CV_INNER_LINEAR+CV_WARP_FILL_OUTLIERS,fillval=(0,0,0,0))-> None
@ -538,7 +538,7 @@ Note that the function can not operate in-place.
Resize
------
`id=0.923811087592 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Resize>`__
.. function:: Resize(src,dst,interpolation=CV_INTER_LINEAR)-> None
@ -593,7 +593,7 @@ so that it fits exactly into
WarpAffine
----------
`id=0.314654704506 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/WarpAffine>`__
.. function:: WarpAffine(src,dst,mapMatrix,flags=CV_INTER_LINEAR+CV_WARP_FILL_OUTLIERS,fillval=(0,0,0,0))-> None
@ -684,7 +684,7 @@ function from cxcore.
WarpPerspective
---------------
`id=0.554206520217 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/WarpPerspective>`__
.. function:: WarpPerspective(src,dst,mapMatrix,flags=CV_INNER_LINEAR+CV_WARP_FILL_OUTLIERS,fillval=(0,0,0,0))-> None

30
doc/opencv1/py/imgproc_histograms.rst
View File

@ -12,7 +12,7 @@ Histograms
CvHistogram
-----------
`id=0.182438452658 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CvHistogram>`__
.. class:: CvHistogram
@ -35,7 +35,7 @@ containing the histogram counts.
CalcBackProject
---------------
`id=0.913786988566 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CalcBackProject>`__
.. function:: CalcBackProject(image,back_project,hist)-> None
@ -99,7 +99,7 @@ That is the approximate algorithm of Camshift color object tracker, except for t
CalcBackProjectPatch
--------------------
`id=0.817068389137 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CalcBackProjectPatch>`__
.. function:: CalcBackProjectPatch(images,dst,patch_size,hist,method,factor)-> None
@ -194,7 +194,7 @@ Back Project Calculation by Patches
CalcHist
--------
`id=0.937336139373 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CalcHist>`__
.. function:: CalcHist(image,hist,accumulate=0,mask=NULL)-> None
@ -244,7 +244,7 @@ input images.
CalcProbDensity
---------------
`id=0.656540136559 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CalcProbDensity>`__
.. function:: CalcProbDensity(hist1,hist2,dst_hist,scale=255)-> None
@ -298,7 +298,7 @@ So the destination histogram bins are within less than
ClearHist
---------
`id=0.0803392460869 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/ClearHist>`__
.. function:: ClearHist(hist)-> None
@ -326,7 +326,7 @@ The function sets all of the histogram bins to 0 in the case of a dense histogra
CompareHist
-----------
`id=0.913670879358 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CompareHist>`__
.. function:: CompareHist(hist1,hist2,method)->float
@ -448,7 +448,7 @@ function.
CreateHist
----------
`id=0.716036535258 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CreateHist>`__
.. function:: CreateHist(dims, type, ranges, uniform = 1) -> hist
@ -517,7 +517,7 @@ bin ranges, they assume thy are equally spaced in 0 to 255 bins.
GetMinMaxHistValue
------------------
`id=0.698817534292 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/GetMinMaxHistValue>`__
.. function:: GetMinMaxHistValue(hist)-> (min_value,max_value,min_idx,max_idx)
@ -570,7 +570,7 @@ is returned.
NormalizeHist
-------------
`id=0.905166705956 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/NormalizeHist>`__
.. function:: NormalizeHist(hist,factor)-> None
@ -605,7 +605,7 @@ The function normalizes the histogram bins by scaling them, such that the sum of
QueryHistValue_1D
-----------------
`id=0.26842391983 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/QueryHistValue_1D>`__
.. function:: QueryHistValue_1D(hist, idx0) -> float
@ -636,7 +636,7 @@ QueryHistValue_1D
QueryHistValue_2D
-----------------
`id=0.149356032534 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/QueryHistValue_2D>`__
.. function:: QueryHistValue_2D(hist, idx0, idx1) -> float
@ -672,7 +672,7 @@ QueryHistValue_2D
QueryHistValue_3D
-----------------
`id=0.846880584809 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/QueryHistValue_3D>`__
.. function:: QueryHistValue_3D(hist, idx0, idx1, idx2) -> float
@ -713,7 +713,7 @@ QueryHistValue_3D
QueryHistValue_nD
-----------------
`id=0.36909443826 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/QueryHistValue_nD>`__
.. function:: QueryHistValue_nD(hist, idx) -> float
@ -744,7 +744,7 @@ QueryHistValue_nD
ThreshHist
----------
`id=0.255496509485 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/ThreshHist>`__
.. function:: ThreshHist(hist,threshold)-> None

22
doc/opencv1/py/imgproc_image_filtering.rst
View File

@ -23,7 +23,7 @@ filter, then during the processing of the left-most pixels in each row we need p
IplConvKernel
-------------
`id=0.589941281227 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/IplConvKernel>`__
.. class:: IplConvKernel
@ -41,7 +41,7 @@ An IplConvKernel is a rectangular convolution kernel, created by function
CopyMakeBorder
--------------
`id=0.392095677822 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CopyMakeBorder>`__
.. function:: CopyMakeBorder(src,dst,offset,bordertype,value=(0,0,0,0))-> None
@ -96,7 +96,7 @@ The function copies the source 2D array into the interior of the destination arr
CreateStructuringElementEx
--------------------------
`id=0.317060827729 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CreateStructuringElementEx>`__
.. function:: CreateStructuringElementEx(cols,rows,anchorX,anchorY,shape,values=None)-> kernel
@ -165,7 +165,7 @@ The function CreateStructuringElementEx allocates and fills the structure
Dilate
------
`id=0.716788417488 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Dilate>`__
.. function:: Dilate(src,dst,element=None,iterations=1)-> None
@ -220,7 +220,7 @@ The function supports the in-place mode. Dilation can be applied several (
Erode
-----
`id=0.842620131268 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Erode>`__
.. function:: Erode(src,dst,element=None,iterations=1)-> None
@ -275,7 +275,7 @@ The function supports the in-place mode. Erosion can be applied several (
Filter2D
--------
`id=0.460981812748 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Filter2D>`__
.. function:: Filter2D(src,dst,kernel,anchor=(-1,-1))-> None
@ -318,7 +318,7 @@ The function applies an arbitrary linear filter to the image. In-place operation
Laplace
-------
`id=0.292603296168 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Laplace>`__
.. function:: Laplace(src,dst,apertureSize=3)-> None
@ -378,7 +378,7 @@ function, no scaling is done and the same combinations of input and output forma
MorphologyEx
------------
`id=0.989292823459 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/MorphologyEx>`__
.. function:: MorphologyEx(src,dst,temp,element,operation,iterations=1)-> None
@ -492,7 +492,7 @@ is required for a morphological gradient and, in the case of in-place operation,
PyrDown
-------
`id=0.761058003811 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/PyrDown>`__
.. function:: PyrDown(src,dst,filter=CV_GAUSSIAN_5X5)-> None
@ -530,7 +530,7 @@ The function performs the downsampling step of the Gaussian pyramid decompositio
Smooth
------
`id=0.981627398232 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Smooth>`__
.. function:: Smooth(src,dst,smoothtype=CV_GAUSSIAN,param1=3,param2=0,param3=0,param4=0)-> None
@ -616,7 +616,7 @@ Median and bilateral filters work with 1- or 3-channel 8-bit images and can not
Sobel
-----
`id=0.141242620837 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Sobel>`__
.. function:: Sobel(src,dst,xorder,yorder,apertureSize = 3)-> None

20
doc/opencv1/py/imgproc_miscellaneous_image_transformations.rst
View File

@ -12,7 +12,7 @@ Miscellaneous Image Transformations
AdaptiveThreshold
-----------------
`id=0.347945671563 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/AdaptiveThreshold>`__
.. function:: AdaptiveThreshold(src,dst,maxValue, adaptive_method=CV_ADAPTIVE_THRESH_MEAN_C, thresholdType=CV_THRESH_BINARY,blockSize=3,param1=5)-> None
@ -118,7 +118,7 @@ pixel neighborhood, minus
CvtColor
--------
`id=0.514105031816 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CvtColor>`__
.. function:: CvtColor(src,dst,code)-> None
@ -701,7 +701,7 @@ The function can do the following transformations:
DistTransform
-------------
`id=0.403544454308 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/DistTransform>`__
.. function:: DistTransform(src,dst,distance_type=CV_DIST_L2,mask_size=3,mask=None,labels=NULL)-> None
@ -858,7 +858,7 @@ Voronoi diagram for the binary image.
CvConnectedComp
---------------
`id=0.582359535464 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CvConnectedComp>`__
.. class:: CvConnectedComp
@ -879,7 +879,7 @@ as a
FloodFill
---------
`id=0.993822136735 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/FloodFill>`__
.. function:: FloodFill(image,seed_point,new_val,lo_diff=(0,0,0,0),up_diff=(0,0,0,0),flags=4,mask=NULL)-> comp
@ -1040,7 +1040,7 @@ is the value of one of pixel neighbors. That is, to be added to the connected co
Inpaint
-------
`id=0.0263619127935 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Inpaint>`__
.. function:: Inpaint(src,mask,dst,inpaintRadius,flags) -> None
@ -1094,7 +1094,7 @@ The function reconstructs the selected image area from the pixel near the area b
Integral
--------
`id=0.623787344698 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Integral>`__
.. function:: Integral(image,sum,sqsum=NULL,tiltedSum=NULL)-> None
@ -1170,7 +1170,7 @@ It makes possible to do a fast blurring or fast block correlation with variable
PyrMeanShiftFiltering
---------------------
`id=0.193607300873 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/PyrMeanShiftFiltering>`__
.. function:: PyrMeanShiftFiltering(src,dst,sp,sr,max_level=1,termcrit=(CV_TERMCRIT_ITER+CV_TERMCRIT_EPS,5,1))-> None
@ -1274,7 +1274,7 @@ running the meanshift procedure on the whole original image (i.e. when
PyrSegmentation
---------------
`id=0.0663769417357 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/PyrSegmentation>`__
.. function:: PyrSegmentation(src,dst,storage,level,threshold1,threshold2)-> comp
@ -1364,7 +1364,7 @@ should be 8-bit single-channel or 3-channel images or equal size.
Threshold
---------
`id=0.201828299143 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Threshold>`__
.. function:: Threshold(src,dst,threshold,maxValue,thresholdType)-> None

8
doc/opencv1/py/imgproc_motion_analysis_and_object_tracking.rst
View File

@ -12,7 +12,7 @@ Motion Analysis and Object Tracking
Acc
---
`id=0.629029815041 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Acc>`__
.. function:: Acc(image,sum,mask=NULL)-> None
@ -61,7 +61,7 @@ or its selected region to the accumulator
MultiplyAcc
-----------
`id=0.767428702085 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/MultiplyAcc>`__
.. function:: MultiplyAcc(image1,image2,acc,mask=NULL)-> None
@ -113,7 +113,7 @@ The function adds the product of 2 images or their selected regions to the accum
RunningAvg
----------
`id=0.136357383909 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/RunningAvg>`__
.. function:: RunningAvg(image,acc,alpha,mask=NULL)-> None
@ -173,7 +173,7 @@ regulates the update speed (how fast the accumulator forgets about previous fram
SquareAcc
---------
`id=0.606012635939 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/SquareAcc>`__
.. function:: SquareAcc(image,sqsum,mask=NULL)-> None

2
doc/opencv1/py/imgproc_object_detection.rst
View File

@ -12,7 +12,7 @@ Object Detection
MatchTemplate
-------------
`id=0.180820664163 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/MatchTemplate>`__
.. function:: MatchTemplate(image,templ,result,method)-> None

24
doc/opencv1/py/imgproc_planar_subdivisions.rst
View File

@ -12,7 +12,7 @@ Planar Subdivisions
CvSubdiv2D
----------
`id=0.403332162742 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CvSubdiv2D>`__
.. class:: CvSubdiv2D
@ -68,7 +68,7 @@ morphing, fast location of points on the plane, building special graphs
CvSubdiv2DPoint
---------------
`id=0.753986010152 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CvSubdiv2DPoint>`__
.. class:: CvSubdiv2DPoint
@ -104,7 +104,7 @@ Point of original or dual subdivision.
CalcSubdivVoronoi2D
-------------------
`id=0.119097157929 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CalcSubdivVoronoi2D>`__
.. function:: CalcSubdivVoronoi2D(subdiv)-> None
@ -135,7 +135,7 @@ cell at that point.
ClearSubdivVoronoi2D
--------------------
`id=0.158437620754 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/ClearSubdivVoronoi2D>`__
.. function:: ClearSubdivVoronoi2D(subdiv)-> None
@ -168,7 +168,7 @@ was modified after previous call to the function.
CreateSubdivDelaunay2D
----------------------
`id=0.918020754539 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CreateSubdivDelaunay2D>`__
.. function:: CreateSubdivDelaunay2D(rect,storage)-> delaunay_triangulation
@ -209,7 +209,7 @@ Note that the triangulation is a single large triangle that covers the given rec
FindNearestPoint2D
------------------
`id=0.679601866055 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/FindNearestPoint2D>`__
.. function:: FindNearestPoint2D(subdiv,pt)-> point
@ -248,7 +248,7 @@ point. The function returns a pointer to the found subdivision vertex.
Subdiv2DEdgeDst
---------------
`id=0.723258652692 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Subdiv2DEdgeDst>`__
.. function:: Subdiv2DEdgeDst(edge)-> point
@ -281,7 +281,7 @@ can be calculated using the function
Subdiv2DGetEdge
---------------
`id=0.506587189348 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Subdiv2DGetEdge>`__
.. function:: Subdiv2DGetEdge(edge,type)-> CvSubdiv2DEdge
@ -348,7 +348,7 @@ The function returns one of the edges related to the input edge.
Subdiv2DNextEdge
----------------
`id=0.406592929731 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Subdiv2DNextEdge>`__
.. function:: Subdiv2DNextEdge(edge)-> CvSubdiv2DEdge
@ -386,7 +386,7 @@ is the input edge)
Subdiv2DLocate
--------------
`id=0.614412184993 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Subdiv2DLocate>`__
.. function:: Subdiv2DLocate(subdiv, pt) -> (loc, where)
@ -481,7 +481,7 @@ The function locates the input point within the subdivision. There are 5 cases:
Subdiv2DRotateEdge
------------------
`id=0.775095566923 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Subdiv2DRotateEdge>`__
.. function:: Subdiv2DRotateEdge(edge,rotate)-> CvSubdiv2DEdge
@ -534,7 +534,7 @@ The function returns one of the edges of the same quad-edge as the input edge.
SubdivDelaunay2DInsert
----------------------
`id=0.291010420302 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/SubdivDelaunay2DInsert>`__
.. function:: SubdivDelaunay2DInsert(subdiv,pt)-> point

54
doc/opencv1/py/imgproc_structural_analysis_and_shape_descriptors.rst
View File

@ -12,7 +12,7 @@ Structural Analysis and Shape Descriptors
ApproxChains
------------
`id=0.891722904536 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/ApproxChains>`__
.. function:: ApproxChains(src_seq,storage,method=CV_CHAIN_APPROX_SIMPLE,parameter=0,minimal_perimeter=0,recursive=0)-> chains
@ -73,7 +73,7 @@ fields of the returned structure.
ApproxPoly
----------
`id=0.511872225874 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/ApproxPoly>`__
.. function::
@ -126,7 +126,7 @@ correspondence).
ArcLength
---------
`id=0.00865407229522 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/ArcLength>`__
.. function:: ArcLength(curve,slice=CV_WHOLE_SEQ,isClosed=-1)-> double
@ -175,7 +175,7 @@ The function calculates the length or curve as the sum of lengths of segments be
BoundingRect
------------
`id=0.0890624819294 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/BoundingRect>`__
.. function:: BoundingRect(points,update=0)-> CvRect
@ -223,7 +223,7 @@ Here is the list of possible combination of the flag values and type of
BoxPoints
---------
`id=0.833111863214 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/BoxPoints>`__
.. function:: BoxPoints(box)-> points
@ -256,7 +256,7 @@ The function calculates the vertices of the input 2d box.
CalcPGH
-------
`id=0.492952101193 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CalcPGH>`__
.. function:: CalcPGH(contour,hist)-> None
@ -299,7 +299,7 @@ definition). The histogram can be used for contour matching.
CalcEMD2
--------
`id=0.390300478738 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CalcEMD2>`__
.. function:: CalcEMD2(signature1, signature2, distance_type, distance_func = None, cost_matrix=None, flow=None, lower_bound=None, userdata = None) -> float
@ -374,7 +374,7 @@ so that they cannot relate to the same object.
CheckContourConvexity
---------------------
`id=0.472970769213 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CheckContourConvexity>`__
.. function:: CheckContourConvexity(contour)-> int
@ -402,7 +402,7 @@ The function tests whether the input contour is convex or not. The contour must
CvConvexityDefect
-----------------
`id=0.484949869638 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CvConvexityDefect>`__
.. class:: CvConvexityDefect
@ -462,7 +462,7 @@ A single contour convexity defect, represented by a tuple
ContourArea
-----------
`id=0.958766756024 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/ContourArea>`__
.. function:: ContourArea(contour,slice=CV_WHOLE_SEQ)-> double
@ -510,7 +510,7 @@ function from C runtime to get the absolute value of the area.
ContourFromContourTree
----------------------
`id=0.162786680111 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/ContourFromContourTree>`__
.. function:: ContourFromContourTree(tree,storage,criteria)-> contour
@ -544,7 +544,7 @@ determines the accuracy and/or the number of tree levels used for reconstruction
ConvexHull2
-----------
`id=0.277941655963 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/ConvexHull2>`__
.. function:: ConvexHull2(points,storage,orientation=CV_CLOCKWISE,return_points=0)-> convex_hull
@ -593,7 +593,7 @@ is a CvMat, the function returns NULL.
ConvexityDefects
----------------
`id=0.819226332619 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/ConvexityDefects>`__
.. function:: ConvexityDefects(contour,convexhull,storage)-> convexity_defects
@ -631,7 +631,7 @@ The function finds all convexity defects of the input contour and returns a sequ
CreateContourTree
-----------------
`id=0.249344062216 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/CreateContourTree>`__
.. function:: CreateContourTree(contour,storage,threshold)-> contour_tree
@ -671,7 +671,7 @@ is less than or equal to 0, the function creates a full binary tree representati
FindContours
------------
`id=0.577796431347 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/FindContours>`__
.. function:: FindContours(image, storage, mode=CV_RETR_LIST, method=CV_CHAIN_APPROX_SIMPLE, offset=(0,0)) -> cvseq
@ -781,7 +781,7 @@ is modified by this function.
FitEllipse2
-----------
`id=0.461296656973 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/FitEllipse2>`__
.. function:: FitEllipse2(points)-> Box2D
@ -817,7 +817,7 @@ not half-lengths.
FitLine
-------
`id=0.681153539505 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/FitLine>`__
.. function:: FitLine(points, dist_type, param, reps, aeps) -> line
@ -947,7 +947,7 @@ is a distance function, one of:
GetCentralMoment
----------------
`id=0.28222157071 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/GetCentralMoment>`__
.. function:: GetCentralMoment(moments, x_order, y_order) -> double
@ -1003,7 +1003,7 @@ are the coordinates of the gravity center:
GetHuMoments
------------
`id=0.855980556214 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/GetHuMoments>`__
.. function:: GetHuMoments(moments) -> hu
@ -1070,7 +1070,7 @@ These values are proved to be invariant to the image scale, rotation, and reflec
GetNormalizedCentralMoment
--------------------------
`id=0.725127020324 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/GetNormalizedCentralMoment>`__
.. function:: GetNormalizedCentralMoment(moments, x_order, y_order) -> double
@ -1115,7 +1115,7 @@ The function retrieves the normalized central moment:
GetSpatialMoment
----------------
`id=0.191749557246 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/GetSpatialMoment>`__
.. function:: GetSpatialMoment(moments, x_order, y_order) -> double
@ -1166,7 +1166,7 @@ is the intensity of the pixel
MatchContourTrees
-----------------
`id=0.480547577878 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/MatchContourTrees>`__
.. function:: MatchContourTrees(tree1,tree2,method,threshold)-> double
@ -1203,7 +1203,7 @@ The function calculates the value of the matching measure for two contour trees.
MatchShapes
-----------
`id=0.317335085559 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/MatchShapes>`__
.. function:: MatchShapes(object1,object2,method,parameter=0)-> None
@ -1312,7 +1312,7 @@ respectively.
MinAreaRect2
------------
`id=0.271581100753 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/MinAreaRect2>`__
.. function:: MinAreaRect2(points,storage=NULL)-> CvBox2D
@ -1353,7 +1353,7 @@ Picture. Minimal-area bounding rectangle for contour
MinEnclosingCircle
------------------
`id=0.696424733079 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/MinEnclosingCircle>`__
.. function:: MinEnclosingCircle(points)-> (int,center,radius)
@ -1394,7 +1394,7 @@ if the resultant circle contains all the input points and zero otherwise
Moments
-------
`id=0.590982994221 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/Moments>`__
.. function:: Moments(arr, binary = 0) -> moments
@ -1434,7 +1434,7 @@ The function calculates spatial and central moments up to the third order and wr
PointPolygonTest
----------------
`id=0.315610322671 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/imgproc/PointPolygonTest>`__
.. function:: PointPolygonTest(contour,pt,measure_dist)-> double

2
doc/opencv1/py/objdetect_cascade_classification.rst
View File

@ -84,7 +84,7 @@ A simple demonstration of face detection, which draws a rectangle around each de
HaarDetectObjects
-----------------
`id=0.467753723618 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/objdetect/HaarDetectObjects>`__
.. function:: HaarDetectObjects(image,cascade,storage,scaleFactor=1.1,minNeighbors=3,flags=0,minSize=(0,0))-> detected_objects

6
doc/opencv1/py/py_index.rst
View File

@ -1,6 +1,6 @@
################
Python Reference
################
###############################
OpenCV 1.x Python API Reference
###############################
.. highlight:: python

30
doc/opencv1/py/video_motion_analysis_and_object_tracking.rst
View File

@ -12,7 +12,7 @@ Motion Analysis and Object Tracking
CalcGlobalOrientation
---------------------
`id=0.671861796406 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/video/CalcGlobalOrientation>`__
.. function:: CalcGlobalOrientation(orientation,mask,mhi,timestamp,duration)-> float
@ -67,7 +67,7 @@ a circular sum of the basic orientation and the shift.
CalcMotionGradient
------------------
`id=0.734160644258 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/video/CalcMotionGradient>`__
.. function:: CalcMotionGradient(mhi,mask,orientation,delta1,delta2,apertureSize=3)-> None
@ -161,7 +161,7 @@ neighborhood and assumes the gradient is valid only if
CalcOpticalFlowBM
-----------------
`id=0.167052327583 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/video/CalcOpticalFlowBM>`__
.. function:: CalcOpticalFlowBM(prev,curr,blockSize,shiftSize,max_range,usePrevious,velx,vely)-> None
@ -241,7 +241,7 @@ function call (if
CalcOpticalFlowHS
-----------------
`id=0.932788904949 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/video/CalcOpticalFlowHS>`__
.. function:: CalcOpticalFlowHS(prev,curr,usePrevious,velx,vely,lambda,criteria)-> None
@ -301,7 +301,7 @@ Horn81
CalcOpticalFlowLK
-----------------
`id=0.849649850841 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/video/CalcOpticalFlowLK>`__
.. function:: CalcOpticalFlowLK(prev,curr,winSize,velx,vely)-> None
@ -351,7 +351,7 @@ Lucas81
CalcOpticalFlowPyrLK
--------------------
`id=0.333066207955 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/video/CalcOpticalFlowPyrLK>`__
.. function:: CalcOpticalFlowPyrLK( prev, curr, prevPyr, currPyr, prevFeatures, winSize, level, criteria, flags, guesses = None) -> (currFeatures, status, track_error)
@ -470,7 +470,7 @@ is set).
CamShift
--------
`id=0.228709757227 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/video/CamShift>`__
.. function:: CamShift(prob_image,window,criteria)-> (int, comp, box)
@ -529,7 +529,7 @@ class declared in cv.hpp implements the color object tracker that uses the funct
CvKalman
--------
`id=0.911390647458 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/video/CvKalman>`__
.. class:: CvKalman
@ -712,7 +712,7 @@ structure is allocated via
CreateKalman
------------
`id=0.636220879554 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/video/CreateKalman>`__
.. function:: CreateKalman(dynam_params, measure_params, control_params=0) -> CvKalman
@ -753,7 +753,7 @@ and all its matrices and initializes them somehow.
KalmanCorrect
-------------
`id=0.175175296579 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/video/KalmanCorrect>`__
.. function:: KalmanCorrect(kalman, measurement) -> cvmat
@ -808,7 +808,7 @@ and returns it on output.
KalmanPredict
-------------
`id=0.930945319496 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/video/KalmanPredict>`__
.. function:: KalmanPredict(kalman, control=None) -> cvmat
@ -880,7 +880,7 @@ Synonym for
MeanShift
---------
`id=0.555115149553 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/video/MeanShift>`__
.. function:: MeanShift(prob_image,window,criteria)-> comp
@ -927,7 +927,7 @@ of iterations. The function returns the number of iterations made.
SegmentMotion
-------------
`id=0.698315173881 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/video/SegmentMotion>`__
.. function:: SegmentMotion(mhi,seg_mask,storage,timestamp,seg_thresh)-> None
@ -987,7 +987,7 @@ component
SnakeImage
----------
`id=0.218492276516 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/video/SnakeImage>`__
.. function:: SnakeImage(image,points,alpha,beta,gamma,win,criteria,calc_gradient=1)-> new_points
@ -1070,7 +1070,7 @@ The function returns the updated list of points.
UpdateMotionHistory
-------------------
`id=0.316306086975 Comments from the Wiki <http://opencv.willowgarage.com/wiki/documentation/py/video/UpdateMotionHistory>`__
.. function:: UpdateMotionHistory(silhouette,mhi,timestamp,duration)-> None

107
doc/opencv_tutorials.tex
View File

@ -1,107 +0,0 @@
\documentclass[11pt]{book}
\usepackage{cite}
\usepackage[pdftex]{graphicx}
\usepackage{titlesec}
\usepackage{listings}
\usepackage{fancyvrb}
\usepackage[svgnames]{xcolor}
\usepackage{framed}
\usepackage{amsmath}
\usepackage{amssymb}
\usepackage{bbm}
\usepackage{hyperref}
\usepackage{makeidx}
\usepackage{color}
\usepackage{verbatim}
\setcounter{secnumdepth}{1}
\definecolor{shadecolor}{gray}{0.95} % Background color of title bars
\lstset{
language=C,
basicstyle=\small\ttfamily,
backgroundcolor=\color{shadecolor}
}
\definecolor{cvlinkcolor}{rgb}{0.0 0.3 0.8}
% taken from http://en.wikibooks.org/wiki/LaTeX/Hyperlinks
\hypersetup{
bookmarks=true, % show bookmarks bar?
unicode=false, % non-Latin characters in Acrobat’s bookmarks
%pdftoolbar=true, % show Acrobat’s toolbar?
%pdfmenubar=true, % show Acrobat’s menu?
%pdffitwindow=false, % window fit to page when opened
%pdfstartview={FitH}, % fits the width of the page to the window
%pdftitle={My title}, % title
%pdfauthor={Author}, % author
%pdfsubject={Subject}, % subject of the document
%pdfcreator={Creator}, % creator of the document
%pdfproducer={Producer}, % producer of the document
%pdfkeywords={keywords}, % list of keywords
%pdfnewwindow=true, % links in new window
colorlinks=true, % false: boxed links; true: colored links
linkcolor=cvlinkcolor, % color of internal links
citecolor=cvlinkcolor, % color of links to bibliography
filecolor=magenta, % color of file links
urlcolor=cyan % color of external links
}
\makeindex
\newcommand{\piRsquare}{\pi r^2} % This is my own macro !!!
\usepackage{helvetica}
\usepackage{ifthen}
\usepackage{alltt}
\usepackage{opencv}
%%% Margins %%%
\oddsidemargin 0.0in
\evensidemargin 0.0in
\textwidth 6.5in
%\headheight 1.0in
%\topmargin 0.5in
%\textheight 9.0in
%\footheight 1.0in
%%%%%%%%%%%%%%%
\title{OpenCV Tutorials} % used by \maketitle
\author{v2.2} % used by \maketitle
\date{February, 2011} % used by \maketitle
\begin{document}
\maketitle % automatic title!
\setcounter{tocdepth}{8}
\tableofcontents
\titleformat{\subsection}
{\titlerule
\vspace{.8ex}%
\normalfont\bfseries\Large}
{\thesection.}{.5em}{}
%%% Define these to get rid of warnings
\def\genc{true}
\def\genpy{true}
\def\gencpp{true}
\newif\ifC
\newif\ifPy
\newif\ifCpp
\newif\ifCPy
\Cfalse
\Cpptrue
\Pyfalse
\CPyfalse
\def\targetlang{cpp}
\part{C++ API tutorials}
\input{tutorials/opencv_tutorials_body}
\addcontentsline{toc}{part}{Index}
\printindex
\end{document} % End of document.

107
doc/opencv_user.tex
View File

@ -1,107 +0,0 @@
\documentclass[11pt]{book}
\usepackage{cite}
\usepackage[pdftex]{graphicx}
\usepackage{titlesec}
\usepackage{listings}
\usepackage{fancyvrb}
\usepackage[svgnames]{xcolor}
\usepackage{framed}
\usepackage{amsmath}
\usepackage{amssymb}
\usepackage{bbm}
\usepackage{hyperref}
\usepackage{makeidx}
\usepackage{color}
\usepackage{verbatim}
\setcounter{secnumdepth}{1}
\definecolor{shadecolor}{gray}{0.95} % Background color of title bars
\lstset{
language=C,
basicstyle=\small\ttfamily,
backgroundcolor=\color{shadecolor}
}
\definecolor{cvlinkcolor}{rgb}{0.0 0.3 0.8}
% taken from http://en.wikibooks.org/wiki/LaTeX/Hyperlinks
\hypersetup{
bookmarks=true, % show bookmarks bar?
unicode=false, % non-Latin characters in Acrobat’s bookmarks
%pdftoolbar=true, % show Acrobat’s toolbar?
%pdfmenubar=true, % show Acrobat’s menu?
%pdffitwindow=false, % window fit to page when opened
%pdfstartview={FitH}, % fits the width of the page to the window
%pdftitle={My title}, % title
%pdfauthor={Author}, % author
%pdfsubject={Subject}, % subject of the document
%pdfcreator={Creator}, % creator of the document
%pdfproducer={Producer}, % producer of the document
%pdfkeywords={keywords}, % list of keywords
%pdfnewwindow=true, % links in new window
colorlinks=true, % false: boxed links; true: colored links
linkcolor=cvlinkcolor, % color of internal links
citecolor=cvlinkcolor, % color of links to bibliography
filecolor=magenta, % color of file links
urlcolor=cyan % color of external links
}
\makeindex
\newcommand{\piRsquare}{\pi r^2} % This is my own macro !!!
\usepackage{helvetica}
\usepackage{ifthen}
\usepackage{alltt}
\usepackage{opencv}
%%% Margins %%%
\oddsidemargin 0.0in
\evensidemargin 0.0in
\textwidth 6.5in
%\headheight 1.0in
%\topmargin 0.5in
%\textheight 9.0in
%\footheight 1.0in
%%%%%%%%%%%%%%%
\title{OpenCV User Guide} % used by \maketitle
\author{v2.2} % used by \maketitle
\date{December, 2010} % used by \maketitle
\begin{document}
\maketitle % automatic title!
\setcounter{tocdepth}{8}
\tableofcontents
\titleformat{\subsection}
{\titlerule
\vspace{.8ex}%
\normalfont\bfseries\Large}
{\thesection.}{.5em}{}
%%% Define these to get rid of warnings
\def\genc{true}
\def\genpy{true}
\def\gencpp{true}
\newif\ifC
\newif\ifPy
\newif\ifCpp
\newif\ifCPy
\Cfalse
\Cpptrue
\Pyfalse
\CPyfalse
\def\targetlang{cpp}
\part{C++ API User Guide}
\input{user_guide/opencv_guide_body}
\addcontentsline{toc}{part}{Index}
\printindex
\end{document} % End of document.

64
doc/tutorials/calib3d.rst Normal file
View File

@ -0,0 +1,64 @@
#######
Calib3D
#######
.. highlight:: cpp
Camera calibration
==================
The goal of this tutorial is to learn how to calibrate a camera given a set of chessboard images.
*Test data*: use images in your data/chess folder.
#.
Compile opencv with samples by setting ``BUILD_EXAMPLES`` to ``ON`` in cmake configuration.
#.
Go to ``bin`` folder and use ``imagelist_creator`` to create an ``XML/YAML`` list of your images.
#.
Then, run ``calibration`` sample to get camera parameters. Use square size equal to 3cm.
Pose estimation
===============
Now, let us write a code that detects a chessboard in a new image and finds its distance from the camera. You can apply the same method to any object with known 3D geometry that you can detect in an image.
*Test data*: use chess_test*.jpg images from your data folder.
#.
Create an empty console project. Load a test image: ::
Mat img = imread(argv[1], CV_LOAD_IMAGE_GRAYSCALE);
#.
Detect a chessboard in this image using findChessboard function. ::
bool found = findChessboardCorners( img, boardSize, ptvec, CV_CALIB_CB_ADAPTIVE_THRESH );
#.
Now, write a function that generates a ``vector<Point3f>`` array of 3d coordinates of a chessboard in any coordinate system. For simplicity, let us choose a system such that one of the chessboard corners is in the origin and the board is in the plane *z = 0*.
#.
Read camera parameters from XML/YAML file: ::
FileStorage fs(filename, FileStorage::READ);
Mat intrinsics, distortion;
fs["camera_matrix"] >> intrinsics;
fs["distortion_coefficients"] >> distortion;
#.
Now we are ready to find chessboard pose by running ``solvePnP``: ::
vector<Point3f> boardPoints;
// fill the array
...
solvePnP(Mat(boardPoints), Mat(foundBoardCorners), cameraMatrix,
distCoeffs, rvec, tvec, false);
#.
Calculate reprojection error like it is done in ``calibration`` sample (see ``opencv/samples/cpp/calibration.cpp``, function ``computeReprojectionErrors``).
Question: how to calculate the distance from the camera origin to any of the corners?

56
doc/tutorials/calib3d.tex
View File

@ -1,56 +0,0 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% C++ %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\ifCpp
\section{Camera calibration}
The goal of this tutorial is to learn how to calibrate a camera given a set of chessboard images.
\texttt{Test data}: use images in your data/chess folder.
Compile opencv with samples by setting BUILD\_EXAMPLES to ON in cmake configuration.
Go to bin folder and use \texttt{imagelist\_creator} to create an xml/yaml list of your images. Then, run \texttt{calibration} sample to get camera parameters. Use square size equal to 3cm.
\section{Pose estimation}
Now, let us write a code that detects a chessboard in a new image and finds its distance from the camera. You can apply the same method to any object with knwon 3d geometry that you can detect in an image.
\texttt{Test data}: use chess\_test*.jpg images from your data folder.
Create an empty console project. Load a test image:
\begin{lstlisting}
Mat img = imread(argv[1], CV_LOAD_IMAGE_GRAYSCALE);
\end{lstlisting}
Detect a chessboard in this image using findChessboard function.
\begin{lstlisting}
bool found = findChessboardCorners( img, boardSize, ptvec, CV_CALIB_CB_ADAPTIVE_THRESH );
\end{lstlisting}
Now, write a function that generates a \texttt{vector<Point3f>} array of 3d coordinates of a chessboard in any coordinate system. For simplicity, let us choose a system such that one of the chessboard corners is in the origin and the board is in the plane \(z = 0\).
Read camera parameters from xml/yaml file:
\begin{lstlisting}
FileStorage fs(filename, FileStorage::READ);
Mat intrinsics, distortion;
fs["camera_matrix"] >> intrinsics;
fs["distortion_coefficients"] >> distortion;
\end{lstlisting}
Now we are ready to find chessboard pose by running solvePnP:
\begin{lstlisting}
vector<Point3f> boardPoints;
// fill the array
...
solvePnP(Mat(boardPoints), Mat(foundBoardCorners), cameraMatrix,
distCoeffs, rvec, tvec, false);
\end{lstlisting}
Calculate reprojection error like it is done in \texttt{calibration} sample (see textttt{opencv/samples/cpp/calibration.cpp}, function \texttt{computeReprojectionErrors}).
How to calculate the distance from the camera origin to any of the corners?
\fi

74
doc/tutorials/features2d.rst Normal file
View File

@ -0,0 +1,74 @@
##########
Features2D
##########
.. highlight:: cpp
Detection of planar objects
===========================
The goal of this tutorial is to learn how to use *features2d* and *calib3d* modules for detecting known planar objects in scenes.
*Test data*: use images in your data folder, for instance, ``box.png`` and ``box_in_scene.png``.
#.
Create a new console project. Read two input images. ::
Mat img1 = imread(argv[1], CV_LOAD_IMAGE_GRAYSCALE);
Mat img2 = imread(argv[2], CV_LOAD_IMAGE_GRAYSCALE);
#.
Detect keypoints in both images. ::
// detecting keypoints
FastFeatureDetector detector(15);
vector<KeyPoint> keypoints1;
detector.detect(img1, keypoints1);
... // do the same for the second image
#.
Compute descriptors for each of the keypoints. ::
// computing descriptors
SurfDescriptorExtractor extractor;
Mat descriptors1;
extractor.compute(img1, keypoints1, descriptors1);
... // process keypoints from the second image as well
#.
Now, find the closest matches between descriptors from the first image to the second: ::
// matching descriptors
BruteForceMatcher<L2<float> > matcher;
vector<DMatch> matches;
matcher.match(descriptors1, descriptors2, matches);
#.
Visualize the results: ::
// drawing the results
namedWindow("matches", 1);
Mat img_matches;
drawMatches(img1, keypoints1, img2, keypoints2, matches, img_matches);
imshow("matches", img_matches);
waitKey(0);
#.
Find the homography transformation between two sets of points: ::
vector<Point2f> points1, points2;
// fill the arrays with the points
....
Mat H = findHomography(Mat(points1), Mat(points2), CV_RANSAC, ransacReprojThreshold);
#.
Create a set of inlier matches and draw them. Use perspectiveTransform function to map points with homography:
Mat points1Projected;
perspectiveTransform(Mat(points1), points1Projected, H);
#.
Use ``drawMatches`` for drawing inliers.

67
doc/tutorials/features2d.tex
View File

@ -1,67 +0,0 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% C++ %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\ifCpp
\section{Detection of planar objects}
The goal of this tutorial is to learn how to use features2d and calib3d modules for detecting known planar objects in scenes.
\texttt{Test data}: use images in your data folder, for instance, box.png and box\_in\_scene.png.
Create a new console project. Read two input images. Example:
\begin{lstlisting}
Mat img1 = imread(argv[1], CV_LOAD_IMAGE_GRAYSCALE);
\end{lstlisting}
Detect keypoints in both images. Example:
\begin{lstlisting}
// detecting keypoints
FastFeatureDetector detector(15);
vector<KeyPoint> keypoints1;
detector.detect(img1, keypoints1);
\end{lstlisting}
Compute descriptors for each of the keypoints. Example:
\begin{lstlisting}
// computing descriptors
SurfDescriptorExtractor extractor;
Mat descriptors1;
extractor.compute(img1, keypoints1, descriptors1);
\end{lstlisting}
Now, find the closest matches between descriptors from the first image to the second:
\begin{lstlisting}
// matching descriptors
BruteForceMatcher<L2<float> > matcher;
vector<DMatch> matches;
matcher.match(descriptors1, descriptors2, matches);
\end{lstlisting}
Visualize the results:
\begin{lstlisting}
// drawing the results
namedWindow("matches", 1);
Mat img_matches;
drawMatches(img1, keypoints1, img2, keypoints2, matches, img_matches);
imshow("matches", img_matches);
waitKey(0);
\end{lstlisting}
Find the homography transformation between two sets of points:
\begin{lstlisting}
vector<Point2f> points1, points2;
// fill the arrays with the points
....
Mat H = findHomography(Mat(points1), Mat(points2), CV_RANSAC, ransacReprojThreshold);
\end{lstlisting}
Create a set of inlier matches and draw them. Use perspectiveTransform function to map points with homography:
\begin{lstlisting}
Mat points1Projected;
perspectiveTransform(Mat(points1), points1Projected, H);
\end{lstlisting}
Use drawMatches for drawing inliers.
\fi

12
doc/tutorials/opencv_tutorials_body.tex
View File

@ -1,12 +0,0 @@
\chapter{Prerequisites}
\renewcommand{\curModule}{Prerequisites}
\input{tutorials/prerequisites}
\chapter{Features2d}
\renewcommand{\curModule}{Features2d}
\input{tutorials/features2d}
\chapter{Calib3d}
\renewcommand{\curModule}{Calib3d}
\input{tutorials/calib3d}

5
doc/tutorials/prerequisites.rst Normal file
View File

@ -0,0 +1,5 @@
#############
Prerequisites
#############
Download the latest release of opencv from \url{http://sourceforge.net/projects/opencvlibrary/}. You will need cmake and your favorite compiler environment in order to build opencv from sources. Please refer to the installation guide \url{http://opencv.willowgarage.com/wiki/InstallGuide} for detailed instructions.

12
doc/tutorials/prerequisites.tex
View File

@ -1,12 +0,0 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% C++ %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\ifCpp
\section{Prerequisites}
Download the latest release of opencv from \url{http://sourceforge.net/projects/opencvlibrary/}. You will need cmake and your favorite compiler environment in order to build opencv from sources. Please refer to the installation guide \url{http://opencv.willowgarage.com/wiki/InstallGuide} for detailed instructions.
\fi

10
doc/tutorials/tutorials.rst Normal file
View File

@ -0,0 +1,10 @@
#################
OpenCV Tutorials
#################
.. toctree::
:maxdepth: 2
prerequisites.rst
features2d.rst
calib3d.rst

12
doc/user_guide/opencv_guide_body.tex
View File

@ -1,12 +0,0 @@
\chapter{cv::Mat. Operations with images.}
\renewcommand{\curModule}{cv::Mat. Operations with images.}
\input{user_guide/user_mat}
\chapter{Features2d.}
\renewcommand{\curModule}{Features2d}
\input{user_guide/user_features2d}
\chapter{Highgui.}
\renewcommand{\curModule}{Highgui.}
\input{user_guide/user_highgui}

97
doc/user_guide/ug_features2d.rst Normal file
View File

@ -0,0 +1,97 @@
**********
Features2d
**********
.. highlight:: cpp
Detectors
=========
Descriptors
===========
Matching keypoints
==================
The code
-------
We will start with a short sample ``opencv/samples/cpp/matcher_simple.cpp``: ::
Mat img1 = imread(argv[1], CV_LOAD_IMAGE_GRAYSCALE);
Mat img2 = imread(argv[2], CV_LOAD_IMAGE_GRAYSCALE);
if(img1.empty() || img2.empty())
{
printf("Can't read one of the images\n");
return -1;
}
// detecting keypoints
SurfFeatureDetector detector(400);
vector<KeyPoint> keypoints1, keypoints2;
detector.detect(img1, keypoints1);
detector.detect(img2, keypoints2);
// computing descriptors
SurfDescriptorExtractor extractor;
Mat descriptors1, descriptors2;
extractor.compute(img1, keypoints1, descriptors1);
extractor.compute(img2, keypoints2, descriptors2);
// matching descriptors
BruteForceMatcher<L2<float> > matcher;
vector<DMatch> matches;
matcher.match(descriptors1, descriptors2, matches);
// drawing the results
namedWindow("matches", 1);
Mat img_matches;
drawMatches(img1, keypoints1, img2, keypoints2, matches, img_matches);
imshow("matches", img_matches);
waitKey(0);
The code explained
------------------
Let us break the code down. ::
Mat img1 = imread(argv[1], CV_LOAD_IMAGE_GRAYSCALE);
Mat img2 = imread(argv[2], CV_LOAD_IMAGE_GRAYSCALE);
if(img1.empty() || img2.empty())
{
printf("Can't read one of the images\n");
return -1;
}
We load two images and check if they are loaded correctly.::
// detecting keypoints
FastFeatureDetector detector(15);
vector<KeyPoint> keypoints1, keypoints2;
detector.detect(img1, keypoints1);
detector.detect(img2, keypoints2);
First, we create an instance of a keypoint detector. All detectors inherit the abstract ``FeatureDetector`` interface, but the constructors are algorithm-dependent. The first argument to each detector usually controls the balance between the amount of keypoints and their stability. The range of values is different for different detectors (For instance, *FAST* threshold has the meaning of pixel intensity difference and usually varies in the region *[0,40]*. *SURF* threshold is applied to a Hessian of an image and usually takes on values larger than *100*), so use defaults in case of doubt. ::
// computing descriptors
SurfDescriptorExtractor extractor;
Mat descriptors1, descriptors2;
extractor.compute(img1, keypoints1, descriptors1);
extractor.compute(img2, keypoints2, descriptors2);
We create an instance of descriptor extractor. The most of OpenCV descriptors inherit ``DescriptorExtractor`` abstract interface. Then we compute descriptors for each of the keypoints. The output ``Mat`` of the ``DescriptorExtractor::compute`` method contains a descriptor in a row *i* for each *i*-th keypoint. Note that the method can modify the keypoints vector by removing the keypoints such that a descriptor for them is not defined (usually these are the keypoints near image border). The method makes sure that the ouptut keypoints and descriptors are consistent with each other (so that the number of keypoints is equal to the descriptors row count). ::
// matching descriptors
BruteForceMatcher<L2<float> > matcher;
vector<DMatch> matches;
matcher.match(descriptors1, descriptors2, matches);
Now that we have descriptors for both images, we can match them. First, we create a matcher that for each descriptor from image 2 does exhaustive search for the nearest descriptor in image 1 using Euclidean metric. Manhattan distance is also implemented as well as a Hamming distance for Brief descriptor. The output vector ``matches`` contains pairs of corresponding points indices. ::
// drawing the results
namedWindow("matches", 1);
Mat img_matches;
drawMatches(img1, keypoints1, img2, keypoints2, matches, img_matches);
imshow("matches", img_matches);
waitKey(0);
The final part of the sample is about visualizing the matching results.

83
doc/user_guide/ug_highgui.rst Normal file
View File

@ -0,0 +1,83 @@
*******
HighGUI
*******
.. highlight:: cpp
Using Kinect sensor
===================
Kinect sensor is supported through ``VideoCapture`` class. Depth map, RGB image and some other formats of Kinect output can be retrieved by using familiar interface of ``VideoCapture``.
In order to use Kinect with OpenCV you should do the following preliminary steps:
#.
Install OpenNI library and PrimeSensor Module for OpenNI from here \url{http://www.openni.org/downloadfiles}. The installation should be done to default folders listed in the instructions of these products:
.. code-block:: text
OpenNI:
Linux & MacOSX:
Libs into: /usr/lib
Includes into: /usr/include/ni
Windows:
Libs into: c:/Program Files/OpenNI/Lib
Includes into: c:/Program Files/OpenNI/Include
PrimeSensor Module:
Linux & MacOSX:
Bins into: /usr/bin
Windows:
Bins into: c:/Program Files/Prime Sense/Sensor/Bin
If one or both products were installed to the other folders, the user should change corresponding CMake variables ``OPENNI_LIB_DIR``, ``OPENNI_INCLUDE_DIR`` or/and ``OPENNI_PRIME_SENSOR_MODULE_BIN_DIR``.
#.
Configure OpenCV with OpenNI support by setting \texttt{WITH\_OPENNI} flag in CMake. If OpenNI is found in default install folders OpenCV will be built with OpenNI library regardless of whether PrimeSensor Module is found or not. If PrimeSensor Module was not found you will get a warning in CMake log. Without PrimeSensor module OpenCV will be successfully compiled with OpenNI library, but ``VideoCapture`` object will not grab data from Kinect sensor.
#.
Build OpenCV.
VideoCapture can retrieve the following Kinect data:
#.
data given from depth generator:
* ``OPENNI_DEPTH_MAP`` - depth values in mm (CV_16UC1)
* ``OPENNI_POINT_CLOUD_MAP`` - XYZ in meters (CV_32FC3)
* ``OPENNI_DISPARITY_MAP`` - disparity in pixels (CV_8UC1)
* ``OPENNI_DISPARITY_MAP_32F`` - disparity in pixels (CV_32FC1)
* ``OPENNI_VALID_DEPTH_MASK`` - mask of valid pixels (not ocluded, not shaded etc.) (CV_8UC1)
#.
data given from RGB image generator:
* ``OPENNI_BGR_IMAGE`` - color image (CV_8UC3)
* ``OPENNI_GRAY_IMAGE`` - gray image (CV_8UC1)
In order to get depth map from Kinect use ``VideoCapture::operator >>``, e. g. ::
VideoCapture capture(0); // or CV_CAP_OPENNI
for(;;)
{
Mat depthMap;
capture >> depthMap;
if( waitKey( 30 ) >= 0 )
break;
}
For getting several Kinect maps use ``VideoCapture::grab`` and ``VideoCapture::retrieve``, e.g. ::
VideoCapture capture(0); // or CV_CAP_OPENNI
for(;;)
{
Mat depthMap;
Mat rgbImage
capture.grab();
capture.retrieve( depthMap, OPENNI_DEPTH_MAP );
capture.retrieve( bgrImage, OPENNI_BGR_IMAGE );
if( waitKey( 30 ) >= 0 )
break;
}
For more information please refer to a Kinect example of usage ``kinect_maps.cpp`` in ``opencv/samples/cpp`` folder.

147
doc/user_guide/ug_mat.rst Normal file
View File

@ -0,0 +1,147 @@
**********************
Operations with images
**********************
.. highlight:: cpp
Input/Output
============
Images
------
Load an image from a file: ::
Mat img = imread(filename)
If you read a jpg file, a 3 channel image is created by default. If you need a grayscale image, use: ::
Mat img = imread(filename, 0);
Save an image to a file: ::
Mat img = imwrite(filename);
XML/YAML
--------
TBD
Basic operations with images
============================
Accessing pixel intensity values
--------------------------------
In order to get pixel intensity value, you have to know the type of an image and the number of channels. Here is an example for a single channel grey scale image (type 8UC1) and pixel coordinates x and y: ::
Scalar intensity = img.at<uchar>(x, y);
``intensity.val[0]`` contains a value from 0 to 255. Now let us consider a 3 channel image with ``BGR`` color ordering (the default format returned by ``imread``): ::
Vec3b intensity = img.at<Vec3b>(x, y);
uchar blue = intensity.val[0];
uchar green = intensity.val[1];
uchar red = intensity.val[2];
You can use the same method for floating-point images (for example, you can get such an image by running Sobel on a 3 channel image): ::
Vec3f intensity = img.at<Vec3f>(x, y);
float blue = intensity.val[0];
float green = intensity.val[1];
float red = intensity.val[2];
The same method can be used to change pixel intensities: ::
img.at<uchar>(x, y) = 128;
There are functions in OpenCV, especially from calib3d module, such as ``projectPoints``, that take an array of 2D or 3D points in the form of ``Mat``. Matrix should contain exactly one column, each row corresponds to a point, matrix type should be 32FC2 or 32FC3 correspondingly. Such a matrix can be easily constructed from ``std::vector``: ::
vector<Point2f> points;
//... fill the array
Mat pointsMat = Mat(points);
One can access a point in this matrix using the same method \texttt{Mat::at}: ::
Point2f point = pointsMat.at<Point2f>(i, 0);
Memory management and reference counting
----------------------------------------
``Mat`` is a structure that keeps matrix/image characteristics (rows and columns number, data type etc) and a pointer to data. So nothing prevents us from having several instances of ``Mat`` corresponding to the same data. A ``Mat`` keeps a reference count that tells if data has to be deallocated when a particular instance of ``Mat`` is destroyed. Here is an example of creating two matrices without copying data: ::
std::vector<Point3f> points;
// .. fill the array
Mat pointsMat = Mat(points).reshape(1);
As a result we get a 32FC1 matrix with 3 columns instead of 32FC3 matrix with 1 column. ``pointsMat`` uses data from ``points`` and will not deallocate the memory when destroyed. In this particular instance, however, developer has to make sure that lifetime of ``points`` is longer than of ``pointsMat``.
If we need to copy the data, this is done using, for example, ``Mat::copyTo`` or ``Mat::clone``: ::
Mat img = imread("image.jpg");
Mat img1 = img.clone();
To the contrary with C API where an output image had to be created by developer, an empty output ``Mat`` can be supplied to each function. Each implementation calls ``Mat::create`` for a destination matrix. This method allocates data for a matrix if it is empty. If it is not empty and has the correct size and type, the method does nothing. If, however, size or type are different from input arguments, the data is deallocated (and lost) and a new data is allocated. For example: ::
Mat img = imread("image.jpg");
Mat sobelx;
Sobel(img, sobelx, CV_32F, 1, 0);
Primitive operations
--------------------
There is a number of convenient operators defined on a matrix. For example, here is how we can make a black image from an existing greyscale image ``img``: ::
img = Scalar(0);
Selecting a region of interest: ::
Rect r(10, 10, 100, 100);
Mat smallImg = img(r);
A convertion from \texttt{Mat} to C API data structures: ::
Mat img = imread("image.jpg");
IplImage img1 = img;
CvMat m = img;
Note that there is no data copying here.
Conversion from color to grey scale: ::
Mat img = imread("image.jpg"); // loading a 8UC3 image
Mat grey;
cvtColor(img, grey, CV_BGR2GRAY);
Change image type from 8UC1 to 32FC1: ::
src.convertTo(dst, CV_32F);
Visualizing images
------------------
It is very useful to see intermediate results of your algorithm during development process. OpenCV provides a convenient way of visualizing images. A 8U image can be shown using: ::
Mat img = imread("image.jpg");
namedWindow("image", CV_WINDOW_AUTOSIZE);
imshow("image", img);
waitKey();
A call to ``waitKey()`` starts a message passing cycle that waits for a key stroke in the ``"image"`` window. A ``32F`` image needs to be converted to ``8U`` type. For example: ::
Mat img = imread("image.jpg");
Mat grey;
cvtColor(img, grey, CV_BGR2GREY);
Mat sobelx;
Sobel(grey, sobelx, CV_32F, 1, 0);
double minVal, maxVal;
minMaxLoc(sobelx, &minVal, &maxVal); //find minimum and maximum intensities
Mat draw;
sobelx.convertTo(draw, CV_8U, 255.0/(maxVal - minVal), -minVal);
namedWindow("image", CV_WINDOW_AUTOSIZE);
imshow("image", draw);
waitKey();

97
doc/user_guide/user_features2d.tex
View File

@ -1,97 +0,0 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% C++ %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\ifCpp
\section{Detectors}
\section{Descriptors}
\section{Matching keypoints}
\subsection{The code}
We will start with a short sample opencv/samples/cpp/matcher\_simple.cpp:
\begin{lstlisting}
Mat img1 = imread(argv[1], CV_LOAD_IMAGE_GRAYSCALE);
Mat img2 = imread(argv[2], CV_LOAD_IMAGE_GRAYSCALE);
if(img1.empty() || img2.empty())
{
printf("Can't read one of the images\n");
return -1;
}
// detecting keypoints
SurfFeatureDetector detector(400);
vector<KeyPoint> keypoints1, keypoints2;
detector.detect(img1, keypoints1);
detector.detect(img2, keypoints2);
// computing descriptors
SurfDescriptorExtractor extractor;
Mat descriptors1, descriptors2;
extractor.compute(img1, keypoints1, descriptors1);
extractor.compute(img2, keypoints2, descriptors2);
// matching descriptors
BruteForceMatcher<L2<float> > matcher;
vector<DMatch> matches;
matcher.match(descriptors1, descriptors2, matches);
// drawing the results
namedWindow("matches", 1);
Mat img_matches;
drawMatches(img1, keypoints1, img2, keypoints2, matches, img_matches);
imshow("matches", img_matches);
waitKey(0);
\end{lstlisting}
\subsection{The code explained}
Let us break the code down.
\begin{lstlisting}
Mat img1 = imread(argv[1], CV_LOAD_IMAGE_GRAYSCALE);
Mat img2 = imread(argv[2], CV_LOAD_IMAGE_GRAYSCALE);
if(img1.empty() || img2.empty())
{
printf("Can't read one of the images\n");
return -1;
}
\end{lstlisting}
We load two images and check if they are loaded correctly.
\begin{lstlisting}
// detecting keypoints
FastFeatureDetector detector(15);
vector<KeyPoint> keypoints1, keypoints2;
detector.detect(img1, keypoints1);
detector.detect(img2, keypoints2);
\end{lstlisting}
First, we create an instance of a keypoint detector. All detectors inherit the abstract FeatureDetector interface, but the constructors are algorithm-dependent. The first argument to each detector usually controls the balance between the amount of keypoints and their stability. The range of values is different for different detectors \footnote{For instance, FAST threshold has the meaning of pixel intensity difference and usually varies in the region \([0,40]\). SURF threshold is applied to a Hessian of an image and usually takes on values larger than \(100\).} so use defaults in case of doubt.
\begin{lstlisting}
// computing descriptors
SurfDescriptorExtractor extractor;
Mat descriptors1, descriptors2;
extractor.compute(img1, keypoints1, descriptors1);
extractor.compute(img2, keypoints2, descriptors2);
\end{lstlisting}
We create an instance of descriptor extractor. The most of OpenCV descriptors inherit DescriptorExtractor abstract interface. Then we compute descriptors for each of the keypoints. The output \texttt{Mat} of the \texttt{DescriptorExtractor::compute} method contains a descriptor in a row \(i\) for each \(i\)-th keypoint. Note that the method can modify the keypoints vector by removing the keypoints such that a descriptor for them is not defined (usually these are the keypoints near image border). The method makes sure that the ouptut keypoints and descriptors are consistent with each other (so that the number of keypoints is equal to the descriptors row count).
\begin{lstlisting}
// matching descriptors
BruteForceMatcher<L2<float> > matcher;
vector<DMatch> matches;
matcher.match(descriptors1, descriptors2, matches);
\end{lstlisting}
Now that we have descriptors for both images, we can match them. First, we create a matcher that for each descriptor from image 2 does exhaustive search for the nearest descriptor in image 1 using Eucledian metric. Manhattan distance is also implemented as well as a Hamming distance for Brief descriptor. The output vector \texttt{matches} contains pairs of corresponding points indices.
\begin{lstlisting}
// drawing the results
namedWindow("matches", 1);
Mat img_matches;
drawMatches(img1, keypoints1, img2, keypoints2, matches, img_matches);
imshow("matches", img_matches);
waitKey(0);
\end{lstlisting}
The final part of the sample is about visualizing the matching results.
\fi

10
doc/user_guide/user_guide.rst Normal file
View File

@ -0,0 +1,10 @@
#################
OpenCV User Guide
#################
.. toctree::
:maxdepth: 2
ug_mat.rst
ug_features2d.rst
ug_highgui.rst

89
doc/user_guide/user_highgui.tex
View File

@ -1,89 +0,0 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% C++ %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\ifCpp
\section{Using Kinect sensor.}
Kinect sensor is supported through \texttt{VideoCapture} class. Depth map, rgb image and some other formats of Kinect
output can be retrieved by using familiar interface of \texttt{VideoCapture}.\par
In order to use Kinect with OpenCV you should do the following preliminary steps:\newline
1) Install OpenNI library and PrimeSensor Module for OpenNI from here \url{http://www.openni.org/downloadfiles}.
The installation should be done to default folders listed in the instructions of these products:
\begin{lstlisting}
OpenNI:
Linux & MacOSX:
Libs into: /usr/lib
Includes into: /usr/include/ni
Windows:
Libs into: c:/Program Files/OpenNI/Lib
Includes into: c:/Program Files/OpenNI/Include
PrimeSensor Module:
Linux & MacOSX:
Bins into: /usr/bin
Windows:
Bins into: c:/Program Files/Prime Sense/Sensor/Bin
\end{lstlisting}
If one or both products were installed to the other folders, the user should change corresponding CMake variables
(\texttt{OPENNI\_LIB\_DIR}, \texttt{OPENNI\_INCLUDE\_DIR} or/and
\texttt{OPENNI\_PRIME\_SENSOR\_MODULE\_BIN\_DIR}).\newline
2) Configure OpenCV with OpenNI support by setting \texttt{WITH\_OPENNI} flag in CMake. If OpenNI
is found in default install folders OpenCV will be built with OpenNI library regardless of whether
PrimeSensor Module is found or not. If PrimeSensor Module was not found you will get a warning
in CMake log. Without PrimeSensor module OpenCV will be successfully compiled with OpenNI library,
but \texttt{VideoCapture} object will not grab data from Kinect sensor. \par
3) Build OpenCV.\par
VideoCapture can retrieve the following Kinect data:
\begin{lstlisting}
a.) data given from depth generator:
OPENNI_DEPTH_MAP - depth values in mm (CV_16UC1)
OPENNI_POINT_CLOUD_MAP - XYZ in meters (CV_32FC3)
OPENNI_DISPARITY_MAP - disparity in pixels (CV_8UC1)
OPENNI_DISPARITY_MAP_32F - disparity in pixels (CV_32FC1)
OPENNI_VALID_DEPTH_MASK - mask of valid pixels (not ocluded,
not shaded etc.) (CV_8UC1)
b.) data given from RGB image generator:
OPENNI_BGR_IMAGE - color image (CV_8UC3)
OPENNI_GRAY_IMAGE - gray image (CV_8UC1)
\end{lstlisting}
In order to get depth map from Kinect use \texttt{VideoCapture::operator >>}, e. g.
\begin{lstlisting}
VideoCapture capture(0); // or CV_CAP_OPENNI
for(;;)
{
Mat depthMap;
capture >> depthMap;
if( waitKey( 30 ) >= 0 )
break;
}
\end{lstlisting}
For getting several Kinect maps use \texttt{VideoCapture::grab + VideoCapture::retrieve}, e.g.
\begin{lstlisting}
VideoCapture capture(0); // or CV_CAP_OPENNI
for(;;)
{
Mat depthMap;
Mat rgbImage
capture.grab();
capture.retrieve( depthMap, OPENNI_DEPTH_MAP );
capture.retrieve( bgrImage, OPENNI_BGR_IMAGE );
if( waitKey( 30 ) >= 0 )
break;
}
\end{lstlisting}
For more information please refer to a kinect example of usage \texttt{kinect\_maps.cpp} in \texttt{sample} folder.
\fi

141
doc/user_guide/user_mat.tex
View File

@ -1,141 +0,0 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% C++ %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\ifCpp
\section{Input/Output}
\subsection{Images}
Load an image from a file:
\begin{lstlisting}
Mat img = imread(filename);
\end{lstlisting}
If you read a jpg file, a 3 channel image is created by default. If you need a grayscale image, use:
\begin{lstlisting}
Mat img = imread(filename, 0);
\end{lstlisting}
Save an image to a file:
\begin{lstlisting}
Mat img = imwrite(filename);
\end{lstlisting}
\subsection{XML/YAML}
\section{Basic operations with images}
\subsection{Accessing pixel intensity values}
In order to get pixel intensity value, you have to know the type of an image and the number of channels. Here is an example for a single channel grey scale image (type 8UC1) and pixel coordinates x and y:
\begin{lstlisting}
Scalar intensity = img.at<uchar>(x, y);
\end{lstlisting}
\texttt{intensity.val[0]} contains a value from 0 to 255.
Now let us consider a 3 channel image with \texttt{bgr} color ordering (the default format returned by imread):
\begin{lstlisting}
Vec3b intensity = img.at<Vec3b>(x, y);
uchar blue = intensity.val[0];
uchar green = intensity.val[1];
uchar red = intensity.val[2];
\end{lstlisting}
You can use the same method for floating-point images (for example, you can get such an image by running Sobel on a 3 channel image):
\begin{lstlisting}
Vec3f intensity = img.at<Vec3f>(x, y);
float blue = intensity.val[0];
float green = intensity.val[1];
float red = intensity.val[2];
\end{lstlisting}
The same method can be used to change pixel intensities:
\begin{lstlisting}
img.at<uchar>(x, y) = 128;
\end{lstlisting}
There are functions in OpenCV, especially from calib3d module, such as \texttt{projectPoints}, that take an array of 2D or 3D points in the form of \texttt{Mat}. Matrix should contain exactly one column, each row corresponds to a point, matrix type should be 32FC2 or 32FC3 correspondingly. Such a matrix can be easily constructed from std::vector:
\begin{lstlisting}
vector<Point2f> points;
//... fill the array
Mat pointsMat = Mat(points);
\end{lstlisting}
One can access a point in this matrix using the same method \texttt{Mat::at}:
\begin{lstlisting}
Point2f point = pointsMat.at<Point2f>(i, 0);
\end{lstlisting}
\subsection{Memory management and reference counting}
\texttt{Mat} is a structure that keeps matrix/image characteristics (rows and columns number, data type etc) and a pointer to data. So nothing prevents us from having several instances of \texttt{Mat} corresponding to the same data. A \texttt{Mat} keeps a reference count that tells if data has to be deallocated when a particular instance of \texttt{Mat} is destroyed. Here is an example of creating two matrices without copying data:
\begin{lstlisting}
std::vector<Point3f> points;
// .. fill the array
Mat pointsMat = Mat(points).reshape(1);
\end{lstlisting}
As a result we get a 32FC1 matrix with 3 columns instead of 32FC3 matrix with 1 column. \texttt{pointsMat} uses data from \texttt{points} and will not deallocate the memory when destroyed. In this particular instance, however, developer has to make sure that lifetime of \texttt{points} is longer than of \texttt{pointsMat}.
If we need to copy the data, this is done using, for example, \texttt{Mat::copyTo} or \texttt{Mat::clone}:
\begin{lstlisting}
Mat img = imread("image.jpg");
Mat img1 = img.clone();
\end{lstlisting}
To the contrary with C API where an output image had to be created by developer, an empty output \texttt{Mat} can be supplied to each function. Each implementation calls \texttt{Mat::create} for a destination matrix. This method allocates data for a matrix if it is empty. If it is not empty and has the correct size and type, the method does nothing. If, however, size or type are different from input arguments, the data is deallocated (and lost) and a new data is allocated. For example:
\begin{lstlisting}
Mat img = imread("image.jpg");
Mat sobelx;
Sobel(img, sobelx, CV_32F, 1, 0);
\end{lstlisting}
\subsection{Primitive operations}
There is a number of convenient operators defined on a matrix. For example, here is how we can make a black image from an existing greyscale image \texttt{img}:
\begin{lstlisting}
img = Scalar(0);
\end{lstlisting}
Selecting a region of interest:
\begin{lstlisting}
Rect r(10, 10, 100, 100);
Mat smallImg = img(r);
\end{lstlisting}
A convertion from \texttt{Mat} to C API data structures:
\begin{lstlisting}
Mat img = imread("image.jpg");
IplImage img1 = img;
CvMat m = img;
\end{lstlisting}
Note that there is no data copying here.
Conversion from color to grey scale:
\begin{lstlisting}
Mat img = imread("image.jpg"); // loading a 8UC3 image
Mat grey;
cvtColor(img, grey, CV_BGR2GRAY);
\end{lstlisting}
Change image type from 8UC1 to 32FC1:
\begin{lstlisting}
convertTo(src, dst, CV_32F);
\end{lstlisting}
\subsection{Visualizing images}
It is very useful to see indermediate results of your algorithm during development process. OpenCV provides a convenient way of visualizing images. A 8U image can be shown using:
\begin{lstlisting}
Mat img = imread("image.jpg");
namedWindow("image", CV_WINDOW_AUTOSIZE);
imshow("image", img);
waitKey();
\end{lstlisting}
A call to waitKey() starts a message passing cycle that waits for a key stroke in the \texttt{"image"} window. A 32F image needs to be converted to 8U type. For example:
\begin{lstlisting}
Mat img = imread("image.jpg");
Mat grey;
cvtColor(img, grey, CV_BGR2GREY);
Mat sobelx;
Sobel(grey, sobelx, CV_32F, 1, 0);
double minVal, maxVal;
minMaxLoc(sobelx, &minVal, &maxVal); //find minimum and maximum intensities
Mat draw;
sobelx.convertTo(draw, CV_8U, 255.0/(maxVal - minVal), -minVal);
namedWindow("image", CV_WINDOW_AUTOSIZE);
imshow("image", draw);
waitKey();
\end{lstlisting}
\fi

68
doc/verbdef.sty
View File

@ -1,68 +0,0 @@
% verbdef.sty v0.2 -- Robin Fairbairns 2000/10/06
\ProvidesPackage{verbdef}[2000/10/06 v0.2 define verbatim csnames]
% This package provides a single command \verbdef
%
% Usage: \verbdef\test|verbatim text|
% \verbdef*\testar{with visible spaces}
%
% \test (or \testar) above will be defined as robust commands that
% expand to typeset their `verbatim text' argument in the usual
% verbatim font (using the visible space symbol in the * case)
%
% The verbatim text argument may be delimited in the same was as the
% argument of a \verb command (see definition of \test above) or using
% braces (see definition of \testar command above)
%
% Note: if the command you're defining with \verbdef is to be used in
% a \section-type command, or a \caption, it's going to appear in the
% table of contents, or list of whatevers; in this case you must
% define the command *before* the \tableofcontents command (or
% whatever). I recommend defining the commands in the preamble of
% your document.
% This program may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.1
% of this license or (at your option) any later version.
% The latest version of this license is in
% http://www.latex-project.org/lppl.txt
% and version 1.1 or later is part of all distributions of LaTeX
% version 1999/06/01 or later.
%
% This program consists of the file verbdef.sty
\newif\ifverbdef@nostar
\def\verbdef{\verbdef@nostarfalse
\@ifstar\@sverbdef\@verbdef}
\def\@verbdef{\verbdef@nostartrue\@sverbdef}
% set up robustness of the command to be defined, set conditions for
% reading verbatim text
\def\@sverbdef#1{\edef\verbdef@tempa{\expandafter\@gobble\string#1}%
\edef#1{\noexpand\protect
\expandafter\noexpand\csname\verbdef@tempa\space\endcsname}%
\begingroup
\verb@eol@error
\let\do\@makeother \dospecials
\toks@{\verbatim@font\@noligs}%
\ifverbdef@nostar
\@vobeyspaces
\toks@\expandafter{\the\toks@\frenchspacing}%
\fi
\@verb@def}
%
\def\@verb@def#1{%
\ifnum`#1=`\{\relax
\catcode`\}\active
\lccode`\~`\}%
\else
\catcode`#1\active
\lccode`\~`#1%
\fi
\lowercase{%
\def\@tempa##1~{%
\expandafter\xdef\csname\verbdef@tempa\space\endcsname{%
{\the\toks@##1}}}}%
\afterassignment\endgroup
\@tempa}

23
index.rst Normal file
View File

@ -0,0 +1,23 @@
.. opencvstd documentation master file, created by
sphinx-quickstart on Mon Feb 14 00:30:43 2011.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to opencv documentation!
================================
.. toctree::
:maxdepth: 2
modules/refman.rst
doc/opencv1/c/c_index.rst
doc/opencv1/py/py_index.rst
doc/user_guide/user_guide.rst
doc/tutorials/tutorials.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

30
modules/index.rst
View File

@ -1,30 +0,0 @@
.. opencvstd documentation master file, created by
sphinx-quickstart on Mon Feb 14 00:30:43 2011.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to opencvstd's documentation!
=====================================
Contents:
.. highlight:: cpp
.. toctree::
:maxdepth: 2
core/doc/intro.rst
core/doc/core.rst
imgproc/doc/imgproc.rst
highgui/doc/highgui.rst
video/doc/video.rst
calib3d/doc/calib3d.rst
features2d/doc/features2d.rst
objdetect/doc/objdetect.rst
ml/doc/ml.rst
gpu/doc/gpu.rst
Indices and tables
==================
* :ref:`genindex` * :ref:`modindex` * :ref:`search`

17
modules/refman.rst Normal file
View File

@ -0,0 +1,17 @@
############################
OpenCV 2.x C++ API Reference
############################
.. toctree::
:maxdepth: 2
core/doc/intro.rst
core/doc/core.rst
imgproc/doc/imgproc.rst
highgui/doc/highgui.rst
video/doc/video.rst
calib3d/doc/calib3d.rst
features2d/doc/features2d.rst
objdetect/doc/objdetect.rst
ml/doc/ml.rst
gpu/doc/gpu.rst