potok/opencv
1
0
Fork 0
mirror of https://github.com/opencv/opencv.git synced 2026-07-30 15:53:03 +04:00
Code Packages Releases Wiki Activity

started work on API & doc synchronization (in particular, Mat& => Input/OutputArray in the descriptions)

Browse Source
This commit is contained in:
Vadim Pisarevsky
2011-06-07 22:51:31 +00:00
parent 927b5c88ea
commit c7a42e9682
52 changed files with 1782 additions and 2048 deletions
Download Patch File Download Diff File Expand all files Collapse all files
modules/highgui/doc/qt_new_functions.rst
+10 -10
View File
@@ -62,7 +62,7 @@ The following code is an example used to generate the figure. ::
setWindowProperty
---------------------
.. c:function:: void setWindowProperty(const string& name, int prop_id, double prop_value)
.. cpp:function:: void setWindowProperty(const string& name, int prop_id, double prop_value)
Changes parameters of a window dynamically.
@@ -96,7 +96,7 @@ The function ``setWindowProperty`` enables changing properties of a window.
getWindowProperty
---------------------
.. c:function:: void getWindowProperty(const char* name, int prop_id)
.. cpp:function:: void getWindowProperty(const string& name, int prop_id)
Provides parameters of a window.
@@ -122,7 +122,7 @@ The function ``getWindowProperty`` returns properties of a window.
fontQt
----------
.. c:function:: CvFont fontQt(const string& nameFont, int pointSize = -1, Scalar color = Scalar::all(0), int weight = CV_FONT_NORMAL, int style = CV_STYLE_NORMAL, int spacing = 0)
.. cpp:function:: CvFont fontQt(const string& nameFont, int pointSize = -1, Scalar color = Scalar::all(0), int weight = CV_FONT_NORMAL, int style = CV_STYLE_NORMAL, int spacing = 0)
Creates the font to draw a text on an image.
@@ -167,7 +167,7 @@ A basic usage of this function is the following: ::
addText
-----------
.. c:function:: void addText(const Mat& img, const string& text, Point location, CvFont *font)
.. cpp:function:: void addText(const Mat& img, const string& text, Point location, CvFont *font)
Creates the font to draw a text on an image.
@@ -192,7 +192,7 @@ using a specific font
displayOverlay
------------------
.. c:function:: void displayOverlay(const string& name, const string& text, int delay)
.. cpp:function:: void displayOverlay(const string& name, const string& text, int delay)
Displays a text on a window image as an overlay for a specified duration.
@@ -208,7 +208,7 @@ The function ``displayOverlay`` displays useful information/tips on top of the w
displayStatusBar
--------------------
.. c:function:: void displayStatusBar(const string& name, const string& text, int delay)
.. cpp:function:: void displayStatusBar(const string& name, const string& text, int delay)
Displays a text on the window statusbar during the specified period of time.
@@ -227,7 +227,7 @@ The function ``displayOverlay`` displays useful information/tips on top of the w
createOpenGLCallback
------------------------
.. c:function:: void createOpenGLCallback( const string& window_name, OpenGLCallback callbackOpenGL, void* userdata CV_DEFAULT(NULL), double angle CV_DEFAULT(-1), double zmin CV_DEFAULT(-1), double zmax CV_DEFAULT(-1)
.. cpp:function:: void createOpenGLCallback( const string& window_name, OpenGLCallback callbackOpenGL, void* userdata CV_DEFAULT(NULL), double angle CV_DEFAULT(-1), double zmin CV_DEFAULT(-1), double zmax CV_DEFAULT(-1)
Creates a callback function called to draw OpenGL on top the the image display by ``windowname``.
@@ -279,7 +279,7 @@ The function ``createOpenGLCallback`` can be used to draw 3D data on the window.
saveWindowParameters
------------------------
.. c:function:: void saveWindowParameters(const string& name)
.. cpp:function:: void saveWindowParameters(const string& name)
Saves parameters of the window ``windowname`` .
@@ -293,7 +293,7 @@ The function ``saveWindowParameters`` saves size, location, flags, trackbars va
loadWindowParameters
------------------------
.. c:function:: void loadWindowParameters(const string& name)
.. cpp:function:: void loadWindowParameters(const string& name)
Loads parameters of the window ``windowname`` .
@@ -307,7 +307,7 @@ The function ``loadWindowParameters`` loads size, location, flags, trackbars val
createButton
----------------
.. c:function:: createButton( const string& button_name CV_DEFAULT(NULL),ButtonCallback on_change CV_DEFAULT(NULL), void* userdata CV_DEFAULT(NULL), int button_type CV_DEFAULT(CV_PUSH_BUTTON), int initial_button_state CV_DEFAULT(0))
.. cpp:function:: createButton( const string& button_name CV_DEFAULT(NULL),ButtonCallback on_change CV_DEFAULT(NULL), void* userdata CV_DEFAULT(NULL), int button_type CV_DEFAULT(CV_PUSH_BUTTON), int initial_button_state CV_DEFAULT(0))
Creates a callback function called to draw OpenGL on top of the image display by ``windowname`` .
modules/highgui/doc/reading_and_writing_images_and_video.rst
+9 -9
View File
@@ -9,7 +9,7 @@ Reading and Writing Images and Video
imdecode
------------
.. c:function:: Mat imdecode( const Mat\& buf, int flags )
.. cpp:function:: Mat imdecode( InputArray buf, int flags )
Reads an image from a buffer in memory.
@@ -29,7 +29,7 @@ See
imencode
------------
.. c:function:: bool imencode( const string\& ext, const Mat\& img, vector<uchar>\& buf, const vector<int>\& params=vector<int>())
.. cpp:function:: bool imencode( const string& ext, InputArray img, vector<uchar>& buf, const vector<int>& params=vector<int>())
Encode an image into a memory buffer.
@@ -51,7 +51,7 @@ See
imread
----------
.. c:function:: Mat imread( const string\& filename, int flags=1 )
.. cpp:function:: Mat imread( const string& filename, int flags=1 )
Loads an image from a file.
@@ -95,7 +95,7 @@ The function ``imread`` loads an image from the specified file and returns it. I
imwrite
-----------
.. c:function:: bool imwrite( const string\& filename, const Mat\& img, const vector<int>\& params=vector<int>())
.. cpp:function:: bool imwrite( const string& filename, InputArray img, const vector<int>& params=vector<int>())
Saves an image to a specified file.
@@ -208,11 +208,11 @@ The class provides C++ video capturing API. Here is how the class can be used: :
VideoCapture::VideoCapture
------------------------------
.. c:function:: VideoCapture::VideoCapture()
.. cpp:function:: VideoCapture::VideoCapture()
.. c:function:: VideoCapture::VideoCapture(const string& filename)
.. cpp:function:: VideoCapture::VideoCapture(const string& filename)
.. c:function:: VideoCapture::VideoCapture(int device)
.. cpp:function:: VideoCapture::VideoCapture(int device)
VideoCapture constructors.
@@ -226,7 +226,7 @@ VideoCapture constructors.
VideoCapture::get
---------------------
.. c:function:: double VideoCapture::get(int property_id)
.. cpp:function:: double VideoCapture::get(int property_id)
:param property_id: Property identifier. It can be one of the following:
@@ -277,7 +277,7 @@ VideoCapture::get
VideoCapture::set
---------------------
.. c:function:: bool VideoCapture::set(int property_id, double value)
.. cpp:function:: bool VideoCapture::set(int property_id, double value)
Sets a property in the VideoCapture backend.
modules/highgui/doc/user_interface.rst
+6 -6
View File
@@ -9,7 +9,7 @@ User Interface
createTrackbar
------------------
.. c:function:: int createTrackbar( const string& trackbarname, const string& winname, int* value, int count, TrackbarCallback onChange CV_DEFAULT(0), void* userdata CV_DEFAULT(0))
.. cpp:function:: int createTrackbar( const string& trackbarname, const string& winname, int* value, int count, TrackbarCallback onChange=0, void* userdata=0)
Creates a trackbar and attaches it to the specified window.
@@ -45,7 +45,7 @@ Clicking the label of each trackbar enables editing the trackbar values manually
getTrackbarPos
------------------
.. c:function:: int getTrackbarPos( const string& trackbarname, const string& winname )
.. cpp:function:: int getTrackbarPos( const string& trackbarname, const string& winname )
Returns the trackbar position.
@@ -67,7 +67,7 @@ Qt-specific details:
imshow
----------
.. c:function:: void imshow( const string& winname, const Mat& image )
.. cpp:function:: void imshow( const string& winname, InputArray image )
Displays an image in the specified window.
@@ -92,7 +92,7 @@ The function ``imshow`` displays an image in the specified window. If the window
namedWindow
---------------
.. c:function:: void namedWindow( const string& winname, int flags )
.. cpp:function:: void namedWindow( const string& winname, int flags )
Creates a window.
@@ -132,7 +132,7 @@ Qt-specific details:
setTrackbarPos
------------------
.. c:function:: void setTrackbarPos( const string& trackbarname, const string& winname, int pos )
.. cpp:function:: void setTrackbarPos( const string& trackbarname, const string& winname, int pos )
Sets the trackbar position.
@@ -156,7 +156,7 @@ Qt-specific details:
waitKey
-----------
.. c:function:: int waitKey(int delay=0)
.. cpp:function:: int waitKey(int delay=0)
Waits for a pressed key.
modules/highgui/include/opencv2/highgui/highgui.hpp
+9 -9
View File
@@ -56,7 +56,7 @@ namespace cv
enum { WINDOW_AUTOSIZE=1 };
CV_EXPORTS_W void namedWindow( const string& winname, int flags CV_DEFAULT(WINDOW_AUTOSIZE) );
CV_EXPORTS_W void namedWindow( const string& winname, int flags=WINDOW_AUTOSIZE );
CV_EXPORTS_W void destroyWindow( const string& winname );
CV_EXPORTS_W int startWindowThread();
@@ -66,16 +66,16 @@ CV_EXPORTS_W double getWindowProperty(const string& winname, int prop_id);//YV
//Only for Qt
//------------------------
CV_EXPORTS CvFont fontQt(const string& nameFont, int pointSize CV_DEFAULT(-1),
Scalar color CV_DEFAULT(Scalar::all(0)), int weight CV_DEFAULT(CV_FONT_NORMAL),
int style CV_DEFAULT(CV_STYLE_NORMAL), int spacing CV_DEFAULT(0));
CV_EXPORTS CvFont fontQt(const string& nameFont, int pointSize=-1,
Scalar color=Scalar::all(0), int weight=CV_FONT_NORMAL,
int style=CV_STYLE_NORMAL, int spacing=0);
CV_EXPORTS void addText( const Mat& img, const string& text, Point org, CvFont font);
CV_EXPORTS void displayOverlay(const string& winname, const string& text, int delayms);
CV_EXPORTS void displayStatusBar(const string& winname, const string& text, int delayms);
typedef void (CV_CDECL *OpenGLCallback)(void* userdata);
CV_EXPORTS void createOpenGLCallback(const string& winname, CvOpenGLCallback callbackOpenGL, void* userdata CV_DEFAULT(0));
CV_EXPORTS void createOpenGLCallback(const string& winname, CvOpenGLCallback callbackOpenGL, void* userdata=0);
CV_EXPORTS void saveWindowParameters(const string& windowName);
CV_EXPORTS void loadWindowParameters(const string& windowName);
@@ -84,8 +84,8 @@ CV_EXPORTS void stopLoop();
typedef void (CV_CDECL *ButtonCallback)(int state, void* userdata);
CV_EXPORTS int createButton( const string& bar_name, ButtonCallback on_change,
void* userdata CV_DEFAULT(NULL), int type CV_DEFAULT(CV_PUSH_BUTTON),
bool initial_button_state CV_DEFAULT(0));
void* userdata=NULL, int type=CV_PUSH_BUTTON,
bool initial_button_state=0);
//-------------------------
CV_EXPORTS_W void imshow( const string& winname, InputArray mat );
@@ -94,8 +94,8 @@ typedef void (CV_CDECL *TrackbarCallback)(int pos, void* userdata);
CV_EXPORTS int createTrackbar( const string& trackbarname, const string& winname,
int* value, int count,
TrackbarCallback onChange CV_DEFAULT(0),
void* userdata CV_DEFAULT(0));
TrackbarCallback onChange=0,
void* userdata=0);
CV_EXPORTS_W int getTrackbarPos( const string& trackbarname, const string& winname );
CV_EXPORTS_W void setTrackbarPos( const string& trackbarname, const string& winname, int pos );