Update the changelog
[opencv] / apps / StereoDemo / readme.txt
1 This is a stereo demo.\r
2 It is a console-based application that uses cvcam for video capture and\r
3 highgui for visualization.\r
4 \r
5 Below are the application requirements and instructions on using the application:\r
6 \r
7 To run the demo you will need two USB cameras that are compatible with DirectShow\r
8 and can work in pair. Creative WebCam is an example of such a camera, 3Com is not\r
9 (currently). Two different cameras might be also OK.\r
10 \r
11 Also, you will need to register ProxyTrans.ax and SyncFilter.ax DirectShow filters\r
12 from opencv\bin folder using regsvr32.exe utility or\r
13 opencv\bin\RegisterAll.bat batch command file.\r
14 \r
15 When the application starts, three windows displaying cameras, appear,\r
16 "camera 1" shows left camera's view, "camera 2" shows right camera's view.\r
17 If they are swapped, press 't' to swap them back.\r
18 \r
19 First, you need to calibrate cameras. Use checkerboard etalon.\r
20 Default size of checker board (7x10 squares) is hard-coded into the demo code -\r
21 change it in main.cpp, line 26 if you have different board size, or\r
22 pass the size in command line, e.g. if you have 10x15 board, run the demo\r
23 as "StereoDemo 10 15".\r
24 To start calibration (and to interrupt calibration), press 'g'.\r
25 When camera is calibrated, disparity map starts displaying automatically.\r
26 Press 'r' to toggle disparity map  displaying.\r
27 Press 's' to save camera parameters.\r
28 Press 'l' to load previously stored camera parameters.\r
29 Press ESC to quit the program.\r
30 \r
31 For other options see online help that is displayed using 'h' command.\r
32 \r
33 !!!CAUTION!!! Although Creative WebCams work well together, their driverts\r
34 may cause the system hangup upon the application exit. So, it is recommented\r
35 to close all the running applications and save the currently open documents\r
36 before the application execution.\r
37 \r