Skip to content

Commit 00d77bd

Browse files
authored
Update README.md
1 parent 3340504 commit 00d77bd

File tree

1 file changed

+13
-50
lines changed

1 file changed

+13
-50
lines changed

README.md

Lines changed: 13 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
OverlapNet is modified Siamese Network that predicts the overlap and relative yaw angle of a pair of range images generated by 3D LiDAR scans.
88

9-
Developed by [Xieyuanli Chen](https://www.ipb.uni-bonn.de/people/xieyuanli-chen/) and [Thomas Läbe](https://www.ipb.uni-bonn.de/people/thomas-laebe/).
9+
Developed by [Xieyuanli Chen](http://www.ipb.uni-bonn.de/people/xieyuanli-chen/) and [Thomas Läbe](https://www.ipb.uni-bonn.de/people/thomas-laebe/).
1010

1111
This pytorch-implemention (delta_head_only) is developed by [Junyi Ma](https://github.com/BIT-MJY)
1212

@@ -18,7 +18,9 @@ If you use our implementation in your academic work, please cite the correspondi
1818
author = {X. Chen and T. L\"abe and A. Milioto and T. R\"ohling and O. Vysotska and A. Haag and J. Behley and C. Stachniss},
1919
title = {{OverlapNet: Loop Closing for LiDAR-based SLAM}},
2020
booktitle = {Proceedings of Robotics: Science and Systems (RSS)},
21-
year = {2020}
21+
year = {2020},
22+
codeurl = {https://github.com/PRBonn/OverlapNet/},
23+
videourl = {https://www.youtube.com/watch?v=YTfliBco6aw},
2224
}
2325

2426
The extended journal version of OverlapNet is [here](http://www.ipb.uni-bonn.de/pdfs/chen2021auro.pdf):
@@ -33,54 +35,6 @@ The extended journal version of OverlapNet is [here](http://www.ipb.uni-bonn.de/
3335
}
3436

3537

36-
37-
<<<<<<< HEAD
38-
### Demos
39-
40-
##### Demo 1: generate different types of data from the LiDAR scan
41-
To try demo 1, you could directly run the script with one command line:
42-
43-
```bash
44-
python3 demo/demo1_gen_data.py
45-
```
46-
47-
The generated data are stored in `/data/preprocess_data`, and you will get a visualization like this:
48-
![](pics/demo1.png)
49-
50-
For generating range and normal images, we have also a much faster implementation in C (with python interface) available
51-
in our repo https://github.com/PRBonn/overlap_localization (look at `src/prepare_training`).
52-
53-
##### Demo 2: Inferring overlap and relative yaw angle between two LiDAR scans
54-
To run demo 2, you need to first download the pre-trained [model](https://www.ipb.uni-bonn.de/html/projects/overlap_net/model_geo.weight).
55-
56-
Then, you should
57-
- either copy it into the default location folder `data` or
58-
- you need to modify the `pretrained_weightsfilename` in the config file `/config/network.yml` accordingly.
59-
60-
Run the second demo script with one command line:
61-
62-
```bash
63-
python3 demo/demo2_infer.py
64-
```
65-
You will get a visualization like this:
66-
67-
![](pics/demo2.png)
68-
69-
70-
##### Demo 3: Loop closure detection
71-
To run demo 3, you need to first download several data:
72-
- pre-trained [model](https://www.ipb.uni-bonn.de/html/projects/overlap_net/model_geo.weight),
73-
- KITTI odometry [data](https://www.ipb.uni-bonn.de/html/projects/overlap_net/kitti_07.zip), where we also provide the covariance information generated from the SLAM,
74-
- pre-processed [data](https://www.ipb.uni-bonn.de/html/projects/overlap_net/preprocess_07.zip).
75-
76-
If you follow the recommended [data structure](#data-structure) below, you extract the downloaded data into the folder `data`.
77-
78-
Otherwise, you need to specify the paths of data in both `config/network.yml` and `config/demo.yml` accordingly,
79-
80-
and then run the third demo script with one command line:
81-
=======
82-
>>>>>>> 2895d50a954918fc301b84c3e11d811ff67d7e25
83-
8438
#### Training
8539
```bash
8640
cd tools
@@ -135,3 +89,12 @@ Copyright 2020, Xieyuanli Chen, Thomas Läbe, Cyrill Stachniss, Photogrammetry a
13589
This project is free software made available under the MIT License. For details see the LICENSE file.
13690

13791

92+
93+
94+
## License
95+
96+
Copyright 2020, Xieyuanli Chen, Thomas Läbe, Cyrill Stachniss, Photogrammetry and Robotics Lab, University of Bonn.
97+
98+
This project is free software made available under the MIT License. For details see the LICENSE file.
99+
100+

0 commit comments

Comments
 (0)