source: pacpussensors/trunk/Vislab/mainpage.dox@ 149

Last change on this file since 149 was 136, checked in by ldecherf, 7 years ago

Doc

File size: 1.6 KB
Line 
1
2/*! \mainpage Index Page
3 *
4 * \section intro_sec Introduction
5 *
6 * The pacpus component is composed of many classes :
7 * - DiskWriter
8 * - Display
9 * - VislabCamera
10 * - VislabComponent
11 * - VislabImageProcessor
12 *
13 * The DiskWriter class permit to record the video, it records all pictures taken by the camera
14 * The Display class permit to see the video, this class creates the windows to display the videos
15 * The VislabCamera class has for actions to start, stop and poweroff the camera
16 * The VislabComponent class is the base of the pacpus component; this class instantiate the elements. It execute the callbacks, start and stop the transmission of the camera
17 * The VislabImageProcessor class
18 *
19 * With this pacpus component we can record a video with two specificities :
20 * - The classic video
21 * - The disparity video
22 *
23 * \section How to use the camera
24 *
25 * - Connect the power and the RJ45 cable
26 * - Configure the IP address of your computer with 192.168.0.xx
27 * - Finally in the terminal, run pacpussensors with the plugin Vislab
28 * - The XML file to use have to look like this :
29 ~~~~~~~~~~~~~~~~~~~~~
30 * <?xml version="1.0" encoding="ISO-8859-1"?>
31 *
32 * <pacpus>
33 *
34 * <components>
35 *
36 * <component name="Vislab" type="VislabComponent" ui="0" />
37 *
38 * </components>
39 *
40 * <connections>
41 * </connections>
42 *
43 * <plugins prefix="" postfix="" extension="so">
44 * // extension="so" on linux, extension="dll" on windows
45 *
46 * <plugin lib="VislabComponent" />
47 *
48 * </plugins>
49 *
50 * <parameters>
51 * </parameters>
52 *
53 * </pacpus>
54 ~~~~~~~~~~~~~~~~~~~~~
55 */
Note: See TracBrowser for help on using the repository browser.