WikiStart
Version 77 (Andrey Kamaev, 2016-03-01 07:24 pm) → Version 78/122 (Kirill Kornyakov, 2016-03-01 07:24 pm)
h1. OpenCV Wiki
!http://opencv.org/wp-content/themes/opencv/images/logo.png!
OpenCV (Open Source Computer Vision) is a library of programming functions for the realtime computer vision. OpenCV is released under the liberal "BSD license":http://opensource.org/licenses/bsd-license.php and hence it's free for both academic and commercial use. It has C++, C, Python and Java (Android) interfaces and supports Windows, Linux, Android and Mac OS. The library has more than 2500 optimized algorithms. Adopted all around the world, OpenCV has more than 47 thousand people of user community and estimated number of downloads exceeding 5 million. Usage ranges from interactive art, to mines inspection, stitching maps on the web or through advanced robotics.
* "News":http://opencv.org/category/news
* "Wiki map":http://code.opencv.org/projects/opencv/wiki/index
h2. News
*10-Dec-2012* New book "Mastering OpenCV":http://www.packtpub.com/cool-projects-with-opencv/book is published including free "source-code":https://github.com/MasteringOpenCV/code.
*03-Nov-2012* [[ChangeLog#243|OpenCV 2.4.3]] is out. We closed another "few issues":http://code.opencv.org/projects/opencv/issues?query_id=35 and fixed several build problems (e.g. related to Xcode 4.5 & iOS6)
*25-Oct-2012* Try out OpenCV 2.4.3 release candidate. The final 2.4.3 is expected within ~2 weeks
*25-Jul-2012* Our SVN repository is no longer available since we migrated to git. You can find new links just below, and here is [[Working_with_OpenCV_git_repository|instruction]].
*04-Jul-2012* [[ChangeLog#242|OpenCV 2.4.2]] is out.
*04-Jul-2012* Welcome to our new sites http://opencv.org and http://answers.opencv.org!
h2. Resources
* Homepage: OpenCV website: http://opencv.org
* OpenCV documentation:
** Web: http://docs.opencv.org
** [[OpenCVBooks|Books]]: "Learning OpenCV":http://www.amazon.com/Learning-OpenCV-Computer-Vision-Library/dp/0596516134, the "OpenCV 2 Cookbook":http://www.packtpub.com/opencv-2-computer-vision-application-programming-cookbook/book and "Mastering OpenCV":http://www.packtpub.com/cool-projects-with-opencv/book including "source-code":https://github.com/MasteringOpenCV/code.
** PDF: "Reference Manual":http://docs.opencv.org/opencv2refman.pdf, "Tutorials":http://docs.opencv.org/opencv_tutorials.pdf, "User Guide":http://docs.opencv.org/opencv_user.pdf, "Cheatsheet":http://docs.opencv.org/trunk/opencv_cheatsheet.pdf
* Q&A forum OpenCV user group (questions, support): http://answers.opencv.org
http://tech.groups.yahoo.com/group/OpenCV.
Repositories:
* Documentation: http://opencv.org/documentation.html, including "books":http://opencv.org/books.html
* Source Codes. To get the *source code*, point your git client to *git://code.opencv.org/opencv.git* or to our public mirror *git://github.com/itseez/opencv.git*. Here is [[Working_with_OpenCV_git_repository|instruction]].
The main OpenCV repository was converted transferred to git and compactified. History is available by the following link git://code.opencv.org/opencv.git. Repository history now begins with the famous âatomic bombâ commit, that dates back to May the 11th, 2010.
** To get the source code, point your git client to git://github.com/itseez/opencv.git. Here is [[Working_with_OpenCV_git_repository|instruction]].
<pre>
git clone git://github.com/itseez/opencv.git
</pre>
** The rest of the history plus matches between git commits and SVN revisions are stored at a separate "OpenCV Attic" OpenCV Attic repository: git://code.opencv.org/opencv_attic.git.
** There is also a mirror of our repository on GitHub: https://github.com/itseez/opencv. We are going to organize the process of adopting pull requests a bit later.
Also OpenCV Extra was put to a separate repository: repo: git://code.opencv.org/opencv_extra.git.
h2. Issue Tracker
Please note that OpenCV project, as any open-source project, welcomes contributions from users. Either you have implemented some new functionality, or you're able to localize and fix a bug by yourself, please make create a pull request at the GitHub. It will be "automatically tested":http://pullrequest.opencv.org patch and reviewed by peers. share it with community. You should use _Patch_ tracker (issue type) for such contributions. Check your code for compliance with [[CodingStyleGuide|OpenCV Code Style Guide]] and please explain how your contribution might piece of code could help other computer vision developers.
h3. Creating new tickets
You first need to register at http://code.opencv.org. If you had an account on OpenCV Trac system you should use your login with 'trac' password. You can change the password "here":http://code.opencv.org/my/account after the first login. Then:
* Click the "Issues":http://code.opencv.org/projects/opencv/issues tab or the "Search" box to look for existing tickets - probably your problem is already known or even fixed in the OpenCV development branches. master. If that this is the case, please comment the ticket with your "+1". It will help us to select hot issues for the next iteration.
* If you can't find your problem on tracker, please click the "New issue":http://code.opencv.org/projects/opencv/issues/new tab to create a new ticket.
** _Bug_ tracker (issue type) is and _Feature_ trackers are used for bug reports. Please note, that OpenCV team is always busy with other urgent or high-priority issues, so you're invited to debug the issue by yourself.
** _Bugfix_ reports and feature requests respectively. *But you should use _Patch_ tracker is used in cases when you've debugged the issue. Congrats, you are the man! This is quite common when people contribute their patches for the open-source software. But please note, that if you really want to see your patch included to have resolved the library, better to work on a pull request. This will greatly simplify reviewing issue already and testing process, see http://pullrequest.opencv.org.
** _Feature_ is used for feature requests. Please always provide motivation for your request. Even better, when you're ready want to work on share the task and just need some mentoring. In the latter case please inform us that you're ready to help, and just need guidance.
** _Patch_ tracker should be used for contributions. As with the _Bugfix_ tracker, please prefer to make a pull request on the GitHub, so OpenCV devs may review and test submitted code. code.*
h3. Reporting bugs
* First of all ask about the issue at the Q&A forum: http://answers.opencv.org. Then try to debug it in your own environment, because it may take forever to just reproduce the issue on other workstation. If you succeed, submit the fix as a pull request, and your fix may be included to the very next OpenCV release! But if you can't debug it, please do as follows...
* Please, specify your platform (Windows 32/64bit, Linux x86/x64/ppc/..., MacOSX 32/64bit/ppc); compiler version; OpenCV version/revision; whether IPP, OpenMP, MMX, SSE ... have been enabled or not, and any other information that let us reproduce the environment, identify and localize the problem.
* A sample code reproducing the problem helps us the most. Please check source:samples - for the preferred style (small code size, cross-platform). There is *no need* to provide any project files or makefiles, if it is a short single-file sample, we could build it and run in a minute. If we can reproduce the problem, we can fix it quickly.
* If your application is complex, and the problem happens somewhere in the middle, often it is still possible to create a short standalone sample:
** First, capture and store the data that you pass to the function using FileStorage.
** Then copy the function call and put the corresponding reading from FileStorage in front of it.
If we can reproduce the problem, we can fix it quickly.
h2. Topic Pages
* [[New functionality discussion]]
* [[TODOs]]
* [[Meeting_notes|Developer meeting notes]]
* [[CARMA platform, compilation and testing]]
!http://opencv.org/wp-content/themes/opencv/images/logo.png!
OpenCV (Open Source Computer Vision) is a library of programming functions for the realtime computer vision. OpenCV is released under the liberal "BSD license":http://opensource.org/licenses/bsd-license.php and hence it's free for both academic and commercial use. It has C++, C, Python and Java (Android) interfaces and supports Windows, Linux, Android and Mac OS. The library has more than 2500 optimized algorithms. Adopted all around the world, OpenCV has more than 47 thousand people of user community and estimated number of downloads exceeding 5 million. Usage ranges from interactive art, to mines inspection, stitching maps on the web or through advanced robotics.
* "News":http://opencv.org/category/news
* "Wiki map":http://code.opencv.org/projects/opencv/wiki/index
h2. News
*10-Dec-2012* New book "Mastering OpenCV":http://www.packtpub.com/cool-projects-with-opencv/book is published including free "source-code":https://github.com/MasteringOpenCV/code.
*03-Nov-2012* [[ChangeLog#243|OpenCV 2.4.3]] is out. We closed another "few issues":http://code.opencv.org/projects/opencv/issues?query_id=35 and fixed several build problems (e.g. related to Xcode 4.5 & iOS6)
*25-Oct-2012* Try out OpenCV 2.4.3 release candidate. The final 2.4.3 is expected within ~2 weeks
*25-Jul-2012* Our SVN repository is no longer available since we migrated to git. You can find new links just below, and here is [[Working_with_OpenCV_git_repository|instruction]].
*04-Jul-2012* [[ChangeLog#242|OpenCV 2.4.2]] is out.
*04-Jul-2012* Welcome to our new sites http://opencv.org and http://answers.opencv.org!
h2. Resources
* Homepage: OpenCV website: http://opencv.org
* OpenCV documentation:
** Web: http://docs.opencv.org
** [[OpenCVBooks|Books]]: "Learning OpenCV":http://www.amazon.com/Learning-OpenCV-Computer-Vision-Library/dp/0596516134, the "OpenCV 2 Cookbook":http://www.packtpub.com/opencv-2-computer-vision-application-programming-cookbook/book and "Mastering OpenCV":http://www.packtpub.com/cool-projects-with-opencv/book including "source-code":https://github.com/MasteringOpenCV/code.
** PDF: "Reference Manual":http://docs.opencv.org/opencv2refman.pdf, "Tutorials":http://docs.opencv.org/opencv_tutorials.pdf, "User Guide":http://docs.opencv.org/opencv_user.pdf, "Cheatsheet":http://docs.opencv.org/trunk/opencv_cheatsheet.pdf
* Q&A forum OpenCV user group (questions, support): http://answers.opencv.org
http://tech.groups.yahoo.com/group/OpenCV.
Repositories:
* Documentation: http://opencv.org/documentation.html, including "books":http://opencv.org/books.html
* Source Codes. To get the *source code*, point your git client to *git://code.opencv.org/opencv.git* or to our public mirror *git://github.com/itseez/opencv.git*. Here is [[Working_with_OpenCV_git_repository|instruction]].
The main OpenCV repository was converted transferred to git and compactified. History is available by the following link git://code.opencv.org/opencv.git. Repository history now begins with the famous âatomic bombâ commit, that dates back to May the 11th, 2010.
** To get the source code, point your git client to git://github.com/itseez/opencv.git. Here is [[Working_with_OpenCV_git_repository|instruction]].
<pre>
git clone git://github.com/itseez/opencv.git
</pre>
** The rest of the history plus matches between git commits and SVN revisions are stored at a separate "OpenCV Attic" OpenCV Attic repository: git://code.opencv.org/opencv_attic.git.
** There is also a mirror of our repository on GitHub: https://github.com/itseez/opencv. We are going to organize the process of adopting pull requests a bit later.
Also OpenCV Extra was put to a separate repository: repo: git://code.opencv.org/opencv_extra.git.
h2. Issue Tracker
Please note that OpenCV project, as any open-source project, welcomes contributions from users. Either you have implemented some new functionality, or you're able to localize and fix a bug by yourself, please make create a pull request at the GitHub. It will be "automatically tested":http://pullrequest.opencv.org patch and reviewed by peers. share it with community. You should use _Patch_ tracker (issue type) for such contributions. Check your code for compliance with [[CodingStyleGuide|OpenCV Code Style Guide]] and please explain how your contribution might piece of code could help other computer vision developers.
h3. Creating new tickets
You first need to register at http://code.opencv.org. If you had an account on OpenCV Trac system you should use your login with 'trac' password. You can change the password "here":http://code.opencv.org/my/account after the first login. Then:
* Click the "Issues":http://code.opencv.org/projects/opencv/issues tab or the "Search" box to look for existing tickets - probably your problem is already known or even fixed in the OpenCV development branches. master. If that this is the case, please comment the ticket with your "+1". It will help us to select hot issues for the next iteration.
* If you can't find your problem on tracker, please click the "New issue":http://code.opencv.org/projects/opencv/issues/new tab to create a new ticket.
** _Bug_ tracker (issue type) is and _Feature_ trackers are used for bug reports. Please note, that OpenCV team is always busy with other urgent or high-priority issues, so you're invited to debug the issue by yourself.
** _Bugfix_ reports and feature requests respectively. *But you should use _Patch_ tracker is used in cases when you've debugged the issue. Congrats, you are the man! This is quite common when people contribute their patches for the open-source software. But please note, that if you really want to see your patch included to have resolved the library, better to work on a pull request. This will greatly simplify reviewing issue already and testing process, see http://pullrequest.opencv.org.
** _Feature_ is used for feature requests. Please always provide motivation for your request. Even better, when you're ready want to work on share the task and just need some mentoring. In the latter case please inform us that you're ready to help, and just need guidance.
** _Patch_ tracker should be used for contributions. As with the _Bugfix_ tracker, please prefer to make a pull request on the GitHub, so OpenCV devs may review and test submitted code. code.*
h3. Reporting bugs
* First of all ask about the issue at the Q&A forum: http://answers.opencv.org. Then try to debug it in your own environment, because it may take forever to just reproduce the issue on other workstation. If you succeed, submit the fix as a pull request, and your fix may be included to the very next OpenCV release! But if you can't debug it, please do as follows...
* Please, specify your platform (Windows 32/64bit, Linux x86/x64/ppc/..., MacOSX 32/64bit/ppc); compiler version; OpenCV version/revision; whether IPP, OpenMP, MMX, SSE ... have been enabled or not, and any other information that let us reproduce the environment, identify and localize the problem.
* A sample code reproducing the problem helps us the most. Please check source:samples - for the preferred style (small code size, cross-platform). There is *no need* to provide any project files or makefiles, if it is a short single-file sample, we could build it and run in a minute. If we can reproduce the problem, we can fix it quickly.
* If your application is complex, and the problem happens somewhere in the middle, often it is still possible to create a short standalone sample:
** First, capture and store the data that you pass to the function using FileStorage.
** Then copy the function call and put the corresponding reading from FileStorage in front of it.
If we can reproduce the problem, we can fix it quickly.
h2. Topic Pages
* [[New functionality discussion]]
* [[TODOs]]
* [[Meeting_notes|Developer meeting notes]]
* [[CARMA platform, compilation and testing]]