WikiStart

Version 111 (Gary Bradski, 2016-03-01 07:24 pm)

1 1
h1. OpenCV Wiki
2 88 Gary Bradski
3 88 Gary Bradski
{{>toc}}
4 50 Gary Bradski
5 52 Gary Bradski
!http://opencv.org/wp-content/themes/opencv/images/logo.png!
6 49 Gary Bradski
7 92 Gary Bradski
OpenCV (Open Source Computer Vision) is a library of programming functions for realtime computer vision. It uses a "BSD license":http://opensource.org/licenses/BSD-3-Clause 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, iOS and Mac OS. It has more than 2500 optimized algorithms. Adopted all around the world, OpenCV has more than 7 million downloads growing by nearly 200K/month. Usage ranges from interactive art, to mines inspection, stitching maps on the web on through advanced robotics.
8 1
9 34 Gary Bradski
* "Wiki map":http://code.opencv.org/projects/opencv/wiki/index
10 89 Gary Bradski
* "Roadmap":http://www.code.opencv.org/projects/opencv/roadmap
11 1
12 99 Gary Bradski
13 107 Gary Bradski
h2. GSoC 2015
14 99 Gary Bradski
15 108 Gary Bradski
" !GSoCOpenCV2015.jpg! ":http://code.opencv.org/projects/opencv/wiki/GSoC_2015
16 1
17 109 Gary Bradski
* *[[GSoC 2015|OpenCV Google Summer of Code 2015 Project Page]]*
18 109 Gary Bradski
* "We are an accepted organization in GSoC 2015!":http://www.google-melange.com/gsoc/org2/google/gsoc2015/opencv
19 109 Gary Bradski
20 96 Gary Bradski
21 107 Gary Bradski
"Wiki for Google Summer of Code":https://www.google-melange.com/gsoc/dashboard/google/gsoc2015
22 96 Gary Bradski
23 1
h2. Resources
24 1
25 86 Gary Bradski
h3. General
26 86 Gary Bradski
27 86 Gary Bradski
* "User site":http://opencv.org/, "News":http://opencv.org/category/news and "Help":http://answers.opencv.org.
28 111 Gary Bradski
* *Documentation:* http://opencv.org/documentation.html, including "Books":http://opencv.org/books.html, "Reference manual":http://docs.opencv.org/, "Tutorials":http://docs.opencv.org/doc/tutorials/tutorials.html and "Cheatsheet":http://docs.opencv.org/opencv_cheatsheet.pdf
29 86 Gary Bradski
* "ChangeLog":http://code.opencv.org/projects/opencv/wiki/ChangeLog for the latest releases
30 86 Gary Bradski
31 86 Gary Bradski
h3. Development
32 86 Gary Bradski
33 86 Gary Bradski
* [[How_to_contribute|How to Contribute]]
34 86 Gary Bradski
* Source Codes can be found at "GitHub":https://github.com/Itseez/opencv. The main OpenCV repository was converted to git and compactified. History now begins with the famous “atomic bomb” commit, that dates back to May the 11th, 2010.
35 91 Gary Bradski
** To get the source code, point your git client to @git://github.com/Itseez/opencv.git@. Here are [[Working_with_OpenCV_git_repository|instructions]].
36 78 Gary Bradski
<pre>
37 82 Gary Bradski
git clone git://github.com/Itseez/opencv.git
38 78 Gary Bradski
</pre>
39 80 Gary Bradski
** The rest of the history plus matches between git commits and SVN revisions are stored at a separate "OpenCV Attic" repository: git://code.opencv.org/opencv_attic.git.
40 78 Gary Bradski
** Also OpenCV Extra was put to a separate repository: git://code.opencv.org/opencv_extra.git.
41 86 Gary Bradski
* [[OpenCV Development Process]]
42 86 Gary Bradski
** [[Meeting_notes|Developer meeting notes]]
43 1
44 86 Gary Bradski
h2. Issue Tracking
45 60 Gary Bradski
46 86 Gary Bradski
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 a "pull request":https://github.com/Itseez/opencv/pulls at the GitHub. It will be "automatically tested":http://pullrequest.opencv.org and reviewed by peers. Check your code for compliance with [[CodingStyleGuide|OpenCV Code Style Guide]] and please explain how your contribution might help others.
47 60 Gary Bradski
48 3 Gary Bradski
h3. Creating new tickets
49 78 Gary Bradski
50 1
You first need to register at http://code.opencv.org. Then:
51 78 Gary Bradski
* 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. If that is the case, please comment the ticket with your "+1". It will help us to select hot issues for the next iteration.
52 7 Gary Bradski
53 78 Gary Bradski
* 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.
54 78 Gary Bradski
** _Bug_ tracker (issue type) is 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.
55 86 Gary Bradski
** _Bugfix_ 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 the library, better to work on a [[How_to_contribute|pull request]]. This will greatly simplify reviewing and testing process, see http://pullrequest.opencv.org.
56 86 Gary Bradski
** _Feature_ is used for feature requests. Please always provide motivation for your request. Even better, when you're ready to work on the task and just need some mentoring. In the latter case please inform us (in your ticket) that you're ready to help, and just need guidance.
57 86 Gary Bradski
** _Patch_ tracker should be used for contributions. But please prefer to make a pull request on the GitHub (as with the _Bugfix_ tracker), so OpenCV developers may review and test submitted code.
58 1
59 1
h3. Reporting bugs
60 78 Gary Bradski
61 78 Gary Bradski
* 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...
62 77 Gary Bradski
63 1
* 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.
64 78 Gary Bradski
65 86 Gary Bradski
* A sample code reproducing the problem helps us the most. It would really help if you could implement a unit-test that fails! 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.
66 51 Gary Bradski
67 1
* If your application is complex, and the problem happens somewhere in the middle, often it is still possible to create a short standalone sample: 
68 16 Gary Bradski
** First, capture and store the data that you pass to the function using FileStorage.
69 17 Gary Bradski
** Then copy the function call and put the corresponding reading from FileStorage in front of it.
70 16 Gary Bradski
71 16 Gary Bradski
h2. Topic Pages
72 1
73 105 Gary Bradski
* [[GSoC 2015|Google Summer of Code 2015 (GSoC 2015) Ideas Page]]
74 101 Gary Bradski
* [[Workshops|Workshops]]
75 110 Gary Bradski
* [[Tutorials|Tutorials]]
76 110 Gary Bradski
* [[VisionChallenge|Vision Challenge Sponsored by OpenCV, CVPR 2015!!]]
77 31 Gary Bradski
* [[New functionality discussion]]
78 75 Gary Bradski
* [[CARMA platform, compilation and testing]]