开源SLAM框架学习——OpenVSLAM源码解析：第二节文件组织结构

本文主要是介绍开源SLAM框架学习——OpenVSLAM源码解析：第二节文件组织结构，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

OpenvSLAM源码解析的博客写完第一篇《开源SLAM框架学习——OpenVSLAM源码解析：第一节安装和初探》之后，没想到过了三个月才写第二篇。主要是最近工作确实很忙，现在正在做一个基于全景相机的视觉定位的项目，但是整个项目就我一个人在做。不过幸运的是，这个项目目前已经获得了一些成果了，往后有时间我会在博客中与大家分享。趁着在跑实验数据的间隙开始我OpenVSLAM源码解析的第二篇。

########################### 我是分割线 ######################

1.主要内容

这一节我主要介绍OpenVSLAM的文件结构，以及每一个文件或者代码的功能。

2.文件结构

图1 OpenVSLAM文件夹结构

3. 文件内容简介

下面我按照上图所示的文件结构顺序，对每一个文件夹进行介绍。

3.1 3rd

该文件夹主要存放三方库文件。

json：该库只有头文件，它主要是用来将文件保存为json格式，该库的github链接nlohmann，这个库本身非常符合现代C++的风格，易用性非常强。OpenVSLAM中使用该库主要是为了方便的进行地图本地化保存和读取，在OpenVSLAM中对于每一个需要序列化的对象，只需要编写一个to_json()的函数，然后就可以使用nlohmann库方便的将该对象反序列化为json的格式。OpenVSLAM中并不是将地图保存位json的格式，而是通过nlohmann库将其转换位message pack的二进制格式保存。

使用这种方式保存地图，虽然方便了数据的管理，但是同时也出现了一个问题，那就是加载和保存地图都需要较长的时间。

popl ：它是一种命令行参数解析工具。该库也是只有头文件，如果你用过Google的gflags的话，那么你应该能立马理解popl是干什么的，它虽然没有gflags的功能多，但是它小巧易用，作为一个小工具还是很不错的。
spdlog：一个基于程序级记录日志信息的c++库。它主要是在程序运行期间记录一些log信息，其功能与Google的glog很像，但是spdlog是一个轻量的、只有头文件的log工具。

3.2 cmake

cmake文件夹下存放的都是.cmake文件，它主要是用来查找相关的库。

3.3 docs

该文件主要用来生成doc文件，也就是生成和和作者提供的网页一样的内容，这个对于我们来说没有必要自己去生成这种网页，直接看作者提供的网页就行。

这里提供一下docs文件夹的编译方法：
首先安装以下两个工具：

pip install sphinx
pip install sphinx_rtd_theme

然后编译：

cd docs
sphinx-build -b html ./ build

此时会在docs文件夹下生成一个build文件夹，里面就是一个一个的网页了。

3.4 example

example文件夹下存放的主要是各种例程，以及配置文件。

euroc/，kitti/，tum_rgbd/，tum_vi/这四个文件夹存储的分别是这四个数据集的配置文件。
util/文件夹存储的是工具型的代码。分别是用来读取对应数据集的图像和时间戳等信息。
xxx.cc：当前文件夹下有很多.cc的文件，它们对应着各种主程序。比方说run_video_slam.cc编译的程序，可以使用输入的视频进行建图，run_image_localization.cc它编译的程序可以是用图像来定位。具体的功能后续需要根据源码进行学习。

3.5 ros

该文件夹提供了OpenVSLAM的ros版本的代码主程序。
openvslam/：提供了ros版本下的建图和定位的两个代码；
publisher/：提供了图像和视频信息的发布节点。

3.6 src

src文件夹是OpenVSLAM的核心，这其中包含了整个slam系统最主要的代码。

3.6.1 openvslam

camera/文件夹主要用来存放各种相机模型的类，其中base是基类，fisheye（鱼眼相机）、perspective（透视相机）、equirectangular（全景相机），都是在base的基础上继承的。这些类中定义了一些专用于当前相机模型的函数，比如去畸变、计算图像的边界等等。
data/文件夹中存放的时候slam数据结构相关的代码。包括bow database、Frame、KeyFrame、Landmark、map database等重要的数据类，这些是支撑起整个slam系统的最重要数据结构。这个文件夹中的内容非常重要，对于我们理解slam系统非常有帮助，在学习的时候一定要把这个文件夹下的数据结构理清楚。
feature/文件夹中存放的主要是一些操作方法相关的代码，包括orb提取器的构造、orb特征点的提取、以及一些描述子的计算都在这个文件夹下。
initialize/文件夹是slam在初始化时对应的比较基础的代码。由于全景相机和普通的透视相机其初始化方法不一样，所以这里为了方便定义了一个基类base，然后在基类的基础上继承出了全景相机的初始化方法和透视相机的初始化方法。
io/文件夹下的代码相对比较简单，主要是保存和加载特征点的代码，以及保存轨迹相关信息的代码。
match/文件夹下保存的是slam匹配相关的代码。所有和匹配相关的代码全都放在这个文件下了。包括前后两帧的帧间匹配，基于bow的词袋加速匹配，投影匹配，双目还原深度等等。
module/：存放的是一些比较完整的模块化的代码。包括有frame的跟踪，完整的初始化流程，回环检测，回环检测之后的BA优化，以及重定位，两视角下的三角化等等比较完整的模块。
optimize/：该文件夹下是各种的优化器，包括全局的BA优化，pose的优化，局部的BA优化。
publish/：主要用来进行frame和地图点的显示相关的操作，在viewer.cc中会用到这里的代码，进行相关内容的绘制与显示。
solve/：是求解器相关的代码，包括本质矩阵（essential）的求解，基础矩阵（fundamental）的求解，单应矩阵（homography）的求解，sim3的求解，以及PnP的求解。
util/：一些工具类。包括产生随机数，图像的转换等等操作。

另外openvslam/文件夹下还包含相机的配置类（config.cc）。另外以下几个模块全部都是很完整的类，它们各自对应slam系统的几个模块，这些模块在slam运行时会运行在每一个独立的线程中：全局优化的类（global_optimization_module.cc），地图管理的类（mapping_module.cc），slam系统类（system.cc），跟踪模块类（tracking_module.cc）。