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

further docs cleanup

Browse Source
This commit is contained in:
Vadim Pisarevsky
2011-03-08 22:22:24 +00:00
parent 23416e3db5
commit 73f589e8a5
23 changed files with 1175 additions and 1097 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
modules/highgui/doc/qt_new_functions.rst
View File

@@ -57,6 +57,8 @@ The following code is an example used to generate the figure. ::
.. index:: setWindowProperty
.. _setWindowProperty:
setWindowProperty
---------------------
.. c:function:: void setWindowProperty(const string& name, int prop_id, double prop_value)
@@ -115,6 +117,8 @@ The function `` getWindowProperty`` return window's properties.
.. index:: fontQt
.. _fontQt:
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)

43
modules/highgui/doc/reading_and_writing_images_and_video.rst
View File

@@ -5,6 +5,8 @@ Reading and Writing Images and Video
.. index:: imdecode
.. _imdecode:
imdecode
------------
.. c:function:: Mat imdecode( const Mat\& buf, int flags )
@@ -23,6 +25,8 @@ See
.. index:: imencode
.. _imencode:
imencode
------------
.. c:function:: bool imencode( const string\& ext, const Mat\& img, vector<uchar>\& buf, const vector<int>\& params=vector<int>())
@@ -43,6 +47,8 @@ See
.. index:: imread
.. _imread:
imread
----------
.. c:function:: Mat imread( const string\& filename, int flags=1 )
@@ -61,34 +67,19 @@ imread
The function ``imread`` loads an image from the specified file and returns it. If the image can not be read (because of missing file, improper permissions, unsupported or invalid format), the function returns empty matrix ( ``Mat::data==NULL`` ).Currently, the following file formats are supported:
*
Windows bitmaps - ``*.bmp, *.dib`` (always supported)
* Windows bitmaps - ``*.bmp, *.dib`` (always supported)
*
JPEG files - ``*.jpeg, *.jpg, *.jpe`` (see
**Note2**
)
* JPEG files - ``*.jpeg, *.jpg, *.jpe`` (see **Note2**)
*
JPEG 2000 files - ``*.jp2`` (see
**Note2**
)
* JPEG 2000 files - ``*.jp2`` (see **Note2**)
*
Portable Network Graphics - ``*.png`` (see
**Note2**
)
* Portable Network Graphics - ``*.png`` (see **Note2**)
*
Portable image format - ``*.pbm, *.pgm, *.ppm`` (always supported)
* Portable image format - ``*.pbm, *.pgm, *.ppm`` (always supported)
*
Sun rasters - ``*.sr, *.ras`` (always supported)
* Sun rasters - ``*.sr, *.ras`` (always supported)
*
TIFF files - ``*.tiff, *.tif`` (see
**Note2**
)
* TIFF files - ``*.tiff, *.tif`` (see **Note2**)
**Note1**
: The function determines type of the image by the content, not by the file extension.
@@ -100,6 +91,8 @@ On Linux, BSD flavors and other Unix-like open-source operating systems OpenCV l
.. index:: imwrite
.. _imwrite:
imwrite
-----------
.. c:function:: bool imwrite( const string\& filename, const Mat\& img, const vector<int>\& params=vector<int>())
@@ -211,6 +204,8 @@ The class provides C++ video capturing API. Here is how the class can be used: :
.. index:: VideoCapture::VideoCapture
.. _VideoCapture::VideoCapture:
VideoCapture::VideoCapture
------------------------------
.. c:function:: VideoCapture::VideoCapture()
@@ -227,6 +222,8 @@ VideoCapture constructors.
.. index:: VideoCapture::get
.. _VideoCapture::get:
VideoCapture::get
---------------------
.. c:function:: double VideoCapture::get(int property_id)
@@ -275,6 +272,8 @@ Note that when querying a property which is unsupported by the backend used by t
.. index:: VideoCapture::set
.. _VideoCapture::set:
VideoCapture::set
---------------------
.. c:function:: bool VideoCapture::set(int property_id, double value)

26
modules/highgui/doc/user_interface.rst
View File

@@ -5,9 +5,11 @@ User Interface
.. index:: createTrackbar
.. _createTrackbar:
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))
.. c:function:: int createTrackbar( const string& trackbarname, const string& winname, int* value, int count, TrackbarCallback onChange CV_DEFAULT(0), void* userdata CV_DEFAULT(0))
Creates a trackbar and attaches it to the specified window
@@ -43,7 +45,7 @@ By clicking on the label of each trackbar, it is possible to edit the trackbar's
getTrackbarPos
------------------
.. c:function:: int getTrackbarPos( const string\& trackbarname, const string\& winname )
.. c:function:: int getTrackbarPos( const string& trackbarname, const string& winname )
Returns the trackbar position.
@@ -61,9 +63,11 @@ qt-specific details:
.. index:: imshow
.. _imshow:
imshow
----------
.. c:function:: void imshow( const string\& winname, const Mat\& image )
.. c:function:: void imshow( const string& winname, const Mat& image )
Displays the image in the specified window
@@ -84,9 +88,11 @@ The function ``imshow`` displays the image in the specified window. If the windo
.. index:: namedWindow
.. _namedWindow:
namedWindow
---------------
.. c:function:: void namedWindow( const string\& winname, int flags )
.. c:function:: void namedWindow( const string& winname, int flags )
Creates a window.
@@ -104,27 +110,29 @@ qt-specific details:
* **flags** Flags of the window. Currently the supported flags are:
* **CV_WINDOW_NORMAL or CV_WINDOW_AUTOSIZE:** ``CV_WINDOW_NORMAL`` let the user resize the window, whereas ``CV_WINDOW_AUTOSIZE`` adjusts automatically the window's size to fit the displayed image (see :ref:`ShowImage` ), and the user can not change the window size manually.
* **CV_WINDOW_NORMAL or CV_WINDOW_AUTOSIZE:** ``CV_WINDOW_NORMAL`` let the user resize the window, whereas ``CV_WINDOW_AUTOSIZE`` adjusts automatically the window's size to fit the displayed image (see :ref:`imshow` ), and the user can not change the window size manually.
* **CV_WINDOW_FREERATIO or CV_WINDOW_KEEPRATIO:** ``CV_WINDOW_FREERATIO`` adjust the image without respect the its ration, whereas ``CV_WINDOW_KEEPRATIO`` keep the image's ratio.
* **CV_GUI_NORMAL or CV_GUI_EXPANDED:** ``CV_GUI_NORMAL`` is the old way to draw the window without statusbar and toolbar, whereas ``CV_GUI_EXPANDED`` is the new enhance GUI.
This parameter is optional. The default flags set for a new window are ``CV_WINDOW_AUTOSIZE`` , ``CV_WINDOW_KEEPRATIO`` , and ``CV_GUI_EXPANDED`` .
This parameter is optional. The default flags set for a new window are ``CV_WINDOW_AUTOSIZE`` , ``CV_WINDOW_KEEPRATIO`` , and ``CV_GUI_EXPANDED`` .
However, if you want to modify the flags, you can combine them using OR operator, ie:
::
namedWindow( ``myWindow'', ``CV_WINDOW_NORMAL`` textbar ``CV_GUI_NORMAL`` );
namedWindow( ``myWindow'', ``CV_WINDOW_NORMAL`` textbar ``CV_GUI_NORMAL`` );
..
.. index:: setTrackbarPos
.. _setTrackbarPos:
setTrackbarPos
------------------
.. c:function:: void setTrackbarPos( const string\& trackbarname, const string\& winname, int pos )
.. c:function:: void setTrackbarPos( const string& trackbarname, const string& winname, int pos )
Sets the trackbar position.
@@ -144,6 +152,8 @@ qt-specific details:
.. index:: waitKey
.. _waitKey:
waitKey
-----------
.. c:function:: int waitKey(int delay=0)