Skip to content

Commit 5259718

Browse files
authored
Update README.md
1 parent 03bd707 commit 5259718

File tree

1 file changed

+42
-34
lines changed

1 file changed

+42
-34
lines changed

README.md

Lines changed: 42 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,13 @@
1515

1616

1717

18-
# Depth Based Object and Robot Tracking
18+
# Bayesian Object Tracking
1919

2020
The Bayesian Object Tracking organization on github is a collection of packages for
21-
3D tracking of rigid objects (using depth images), as well as full robot arm pose estimation (using depth images and joint encoders). The core libraries for object tracking are ROS independent. However,
21+
3D tracking of rigid objects (using depth images), as well as robot arm tracking (using depth images and joint encoders).
22+
For more details about the research which underlies these packages, please have a look at https://am.is.tuebingen.mpg.de/research_projects/probabilistic-object-tracking-using-a-depth-camera.
23+
24+
The core libraries for object tracking are ROS independent. However,
2225
the tracker integration with sensors is based on the ROS eco-system.
2326

2427
Here, we give instructions on how to install the code and a getting started
@@ -29,63 +32,68 @@ to your needs.
2932

3033

3134
## Requirements
32-
* MS Kinect or Asus XTION depth sensor
33-
* Ubuntu 14.04
35+
* MS Kinect or Asus XTION depth sensor (unless you work with recorded data)
36+
* Ubuntu 14.04 (might work on other versions, but has not been tested)
3437
* c++11 Compiler (gcc-4.7 or later)
3538
* (optional) [CUDA](https://developer.nvidia.com/cuda-downloads) 6.5 or later with CUDA enabled
3639
graphic card
3740

3841
## Dependencies
3942
* [ROS Indigo](http://wiki.ros.org/indigo)
40-
* [Filtering library](https://github.com/filtering-library/fl) (fl)
4143
* [Eigen](http://eigen.tuxfamily.org/) 3.2.1 or later
4244

4345
## Object Tracking
4446
The object tracking can be used without the robot tracking package (dbrt).
4547

4648
### Workspace setup and compilation
4749
```bash
48-
$ cd $HOME
49-
$ mkdir -p projects/tracking/src
50-
$ cd projects/tracking/src
51-
$ git clone git@github.com:filtering-library/fl.git
52-
$ git clone git@github.com:bayesian-object-tracking/dbot.git
53-
$ git clone git@github.com:bayesian-object-tracking/dbot_ros_msgs.git
54-
$ git clone git@github.com:bayesian-object-tracking/dbot_ros.git
55-
$ cd ..
56-
$ catkin_make -DCMAKE_BUILD_TYPE=Release -DDBOT_BUILD_GPU=On
57-
$ source devel/setup.bash
50+
cd $HOME
51+
mkdir -p projects/tracking/src
52+
cd projects/tracking/src
53+
git clone git@github.com:filtering-library/fl.git
54+
git clone git@github.com:bayesian-object-tracking/dbot.git
55+
git clone git@github.com:bayesian-object-tracking/dbot_ros_msgs.git
56+
git clone git@github.com:bayesian-object-tracking/dbot_ros.git
57+
cd ..
58+
catkin_make -DCMAKE_BUILD_TYPE=Release -DDBOT_BUILD_GPU=On
59+
source devel/setup.bash
5860
```
59-
If no CUDA enabled device is available, you can deactivate the GPU implementation via
61+
If no CUDA enabled device is available, you can build without the GPU implementation via
6062
```bash
61-
$ catkin_make -DCMAKE_BUILD_TYPE=Release -DDBOT_BUILD_GPU=Off
63+
catkin_make -DCMAKE_BUILD_TYPE=Release -DDBOT_BUILD_GPU=Off
6264
```
6365

64-
### Example Object Tracking Project
66+
### Install and run example
6567

66-
Checkout the following package in your tracking workspace and compile again.
67-
This package contains a bag file including record depth images and an object
68-
model. To launch the example, do the following:
68+
The getting started repository contains a ROS bagfile (a depth image sequence of an object being moved),
69+
and mesh models of some objects. Additionally it contains launch files, which allow
70+
to run the code easily.
6971

72+
To install, follow these steps:
7073
```bash
71-
cd src
74+
cd projects/tracking/src
7275
git clone https://git-amd.tuebingen.mpg.de/open-source/dbot_getting_started.git
7376
cd ..
7477
catkin_make -DCMAKE_BUILD_TYPE=Release -DDBOT_BUILD_GPU=On
7578
source devel/setup.bash
7679
```
77-
Now you can run the example.
80+
Again, if no CUDA enabled device is available, you can build without the GPU implementation via
81+
```bash
82+
catkin_make -DCMAKE_BUILD_TYPE=Release -DDBOT_BUILD_GPU=Off
83+
```
84+
85+
Now you can run the example:
7886
```bash
7987
roslaunch dbot_example launch_example_gpu.launch
8088
```
81-
or if you did not install cude you launch instead
89+
If you did not install CUDA, you can run instead:
8290
```bash
8391
roslaunch dbot_example launch_example_cpu.launch
8492
```
85-
now, as soon as you launch the example an interactive marker should show up in
86-
rviz. this is for initialization of the tracker, you can move it to align it
87-
with the point cloud, but it should already be approximately aligned. once you
88-
are done, you can click on the object and the tracker should start. You should
93+
As soon as you launch the example, an interactive marker should show up in
94+
rviz. This is for initialization of the tracker, you can move it to align it
95+
with the point cloud, but it should already be approximately aligned. Once you
96+
are done, you can click on the object marker and the tracker should start. You should
8997
do so before the object is being moved in the playback of the bagfile.
9098

9199
### Addition documentation
@@ -114,15 +122,15 @@ first the workspace setup and of the object tracking above. Then checkout
114122
the following package to the workspace
115123

116124
```bash
117-
$ cd $HOME
118-
$ cd projects/tracking/src
119-
$ git clone git@github.com:bayesian-object-tracking/dbrt.git
120-
$ cd ..
121-
$ catkin_make -DCMAKE_BUILD_TYPE=Release -DDBOT_BUILD_GPU=On
125+
cd $HOME
126+
cd projects/tracking/src
127+
git clone git@github.com:bayesian-object-tracking/dbrt.git
128+
cd ..
129+
catkin_make -DCMAKE_BUILD_TYPE=Release -DDBOT_BUILD_GPU=On
122130
```
123131
Again, if no CUDA enabled device is available, you can deactivate the GPU implementation via
124132
```bash
125-
$ catkin_make -DCMAKE_BUILD_TYPE=Release -DDBOT_BUILD_GPU=Off
133+
catkin_make -DCMAKE_BUILD_TYPE=Release -DDBOT_BUILD_GPU=Off
126134
```
127135

128136
### Example Robot Tracking Project using MPI Apollo Robot

0 commit comments

Comments
 (0)