Skip to content

Commit 851db08

Browse files
authored
Update README.md
1 parent 0df83dd commit 851db08

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For a closed-source version of ORB-SLAM3 for commercial purposes, please contact
3838

3939
If you use ORB-SLAM3 in an academic work, please cite:
4040

41-
@article{ORBSLAM3_2020,
41+
@article{ORBSLAM3_TRO,
4242
title={{ORB-SLAM3}: An Accurate Open-Source Library for Visual, Visual-Inertial
4343
and Multi-Map {SLAM}},
4444
author={Campos, Carlos AND Elvira, Richard AND G\´omez, Juan J. AND Montiel,
@@ -95,7 +95,23 @@ chmod +x build.sh
9595

9696
This will create **libORB_SLAM3.so** at *lib* folder and the executables in *Examples* folder.
9797

98-
# 4. EuRoC Examples
98+
# 4. Running ORB-SLAM3 with your camera
99+
100+
Directory `Examples` contains several demo programs and calibration files to run ORB-SLAM3 in all sensor configurations with Intel Realsense cameras T265 and D435i. The steps needed to use your own camera are:
101+
102+
1. Calibrate your camera following `Calibration_Tutorial.pdf` and write your calibration file `your_camera.yaml`
103+
104+
2. Modify one of the provided demos to suit your specific camera model, and build it
105+
106+
3. Connect the camera to your computer using USB3 or the appropriate interface
107+
108+
4. Run ORB-SLAM3. For example, for our D435i camera, we would execute:
109+
110+
```
111+
./Examples/Stereo-Inertial/stereo_inertial_realsense_D435i Vocabulary/ORBvoc.txt ./Examples/Stereo-Inertial/RealSense_D435i.yaml
112+
```
113+
114+
# 5. EuRoC Examples
99115
[EuRoC dataset](http://projects.asl.ethz.ch/datasets/doku.php?id=kmavvisualinertialdatasets) was recorded with two pinhole cameras and an inertial sensor. We provide an example script to launch EuRoC sequences in all the sensor configurations.
100116

101117
1. Download a sequence (ASL format) from http://projects.asl.ethz.ch/datasets/doku.php?id=kmavvisualinertialdatasets
@@ -115,7 +131,7 @@ Execute the following script to process sequences and compute the RMS ATE:
115131
./euroc_eval_examples
116132
```
117133

118-
# 5. TUM-VI Examples
134+
# 6. TUM-VI Examples
119135
[TUM-VI dataset](https://vision.in.tum.de/data/datasets/visual-inertial-dataset) was recorded with two fisheye cameras and an inertial sensor.
120136

121137
1. Download a sequence from https://vision.in.tum.de/data/datasets/visual-inertial-dataset and uncompress it.
@@ -135,7 +151,7 @@ Execute the following script to process sequences and compute the RMS ATE:
135151
./tum_vi_eval_examples
136152
```
137153

138-
# 6. ROS Examples
154+
# 7. ROS Examples
139155

140156
### Building the nodes for mono, mono-inertial, stereo, stereo-inertial and RGB-D
141157
Tested with ROS Melodic and ubuntu 18.04.
@@ -212,8 +228,8 @@ Once ORB-SLAM3 has loaded the vocabulary, press space in the rosbag tab.
212228
rosrun rosbag fastrebag.py dataset-room1_512_16.bag dataset-room1_512_16_small_chunks.bag
213229
```
214230

215-
# 7. Running time analysis
231+
# 8. Running time analysis
216232
A flag in `include\Config.h` activates time measurements. It is necessary to uncomment the line `#define REGISTER_TIMES` to obtain the time stats of one execution which is shown at the terminal and stored in a text file(`ExecTimeMean.txt`).
217233

218-
# 8. Calibration
234+
# 9. Calibration
219235
You can find a tutorial for visual-inertial calibration and a detailed description of the contents of valid configuration files at `Calibration_Tutorial.pdf`

0 commit comments

Comments
 (0)