Skip to content

Commit a540602

Browse files
committed
Add table of contents to README
1 parent 7db2848 commit a540602

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,33 @@ Get PDF [here](https://arxiv.org/abs/2311.13976).
4141

4242
The authors gratefully acknowledge funding by the Federal Office of Bundeswehr Equipment, Information Technology and In-Service Support (BAAINBw).
4343

44+
## Overview
45+
- [Examples](#examples)
46+
- [Run it yourself](#run-it-yourself)
47+
- [1. Download Sensor Data](#1-download-sensor-data)
48+
- [1.1. SemanticKitti](#11-semantickitti)
49+
- [1.2. Rosbag of our test vehicle VW Touareg](#12-rosbag-of-our-test-vehicle-vw-touareg)
50+
- [2. Setup Environment](#2-setup-environment)
51+
- [2.1. Option: Docker + GUI (VNC)](#21-option-docker--gui-vnc)
52+
- [2.2. Option: Locally on Ubuntu 20.04 (Focal) and ROS Noetic](#22-option-locally-on-ubuntu-2004-focal-and-ros-noetic)
53+
- [3. Run Continuous Clustering](#3-run-continuous-clustering)
54+
- [Evaluation on SemanticKITTI Dataset](#evaluation-on-semantickitti-dataset)
55+
- [1. Evaluation Results](#1-evaluation-results)
56+
- [1.1. Clustering](#11-clustering)
57+
- [1.2. Ground Point Segmentation](#12-ground-point-segmentation)
58+
- [2. Get Ground Truth Labels](#2-get-ground-truth-labels)
59+
- [2.1. Option: Download pre-generated labels](#21-option-download-pre-generated-labels-fastest)
60+
- [2.2. Option: Generate with GUI & ROS setup](#22-option-generate-with-gui--ros-setup-assumes-prepared-ros-setup-see-above-useful-for-debugging-etc)
61+
- [2.3. Option: Generate without GUI or ROS within Minimal Docker Container](#23-option-generate-without-gui-or-ros-within-minimal-docker-container)
62+
- [3. Run Evaluation](#3-run-evaluation)
63+
- [3.1. Option: Evaluate with GUI & ROS setup](#31-option-evaluate-with-gui--ros-setup-assumes-prepared-ros-setup-useful-for-debugging)
64+
- [3.2. Option: Evaluate without GUI or ROS within Minimal Docker Container](#32-option-evaluate-without-gui-or-ros-within-minimal-docker-container)
65+
- [Info about our LiDAR Drivers](#info-about-our-lidar-drivers)
66+
- [Velodyne](#velodyne)
67+
- [Ouster](#ouster)
68+
- [Tips for Rviz Visualization](#tips-for-rviz-visualization)
69+
- [TODOs](#todos)
70+
4471
# Examples:
4572

4673
## Works with uncommon mounting positions
@@ -116,7 +143,7 @@ Available bags:
116143

117144
## 2. Setup Environment
118145

119-
### 2.1. Option: Docker + GUI (VNC):
146+
### 2.1. Option: Docker + GUI (VNC)
120147

121148
This option is the fastest to set up. However, due to missing hardware acceleration in the VNC Docker container for RVIZ
122149
the rosbag is played at 1/10 speed.
@@ -206,7 +233,7 @@ point segmentation.
206233
| 9 | 18.45 / 6.25 | 39.62 / 11.86 |
207234
| 10 | 20.10 / 8.70 | 34.33 / 12.37 |
208235

209-
### 1.2. Ground Point Segmentation:
236+
### 1.2. Ground Point Segmentation
210237

211238
| Sequence | Recall μ ↑ / σ ↓ | Precision μ ↑ / σ ↓ | F1-Score μ ↑ / σ ↓ | Accuracy μ ↑ / σ ↓ |
212239
| :---: | :---: | :---: | :---: | :---: |
@@ -299,7 +326,7 @@ docker run --rm -v ${KITTI_SEQUENCES_PATH}:/mnt/kitti_sequences --name build_no_
299326
docker stop build_no_ros
300327
```
301328

302-
# Tips for Rviz Visualization:
329+
# Tips for Rviz Visualization
303330

304331
TODO
305332

0 commit comments

Comments
 (0)