一、缘由
在解读 ORB-SLAM2 源码之前，本人先介绍一下 ORB-SLAM2 中或者 C++命明的一些规范，通过该篇博客主要可以掌握以下知识:
1、方便阅读作者的源码，从变量或者成员的命名，就能知道其大概意思。
2、方便我们后续编写代码，比如引用类成员时，应该使用 . 还是——>，我们从命名上即可知道
3、提高我们编写C++代码的素养，同时学习怎么规范，高效的去编写代码
二、示例
在这里呢，我先举一些例子。比如在 ORB-SLAM2 源码中，我们可以看到类似如下得变量:
System.h文件:
eSensor mSensor;
ORBVocabulary* mpVocabulary;
bool mbActivateLocalizationMode;
ORBextractor.h文件:
bool bNoMore;
std::vector mvImagePyramid;
int nlevels;
std::vector mvScaleFactor;
除了上面得这些变量，还有很多，本人就不一一列举了。在初步接触这些代码时，特别是在不太明白C++命名规范的情况下，我相信看到上面的这些变量应该是比较蒙蔽的，那么下面就对其进行一定的讲解，这样我们以后就能看其名知其意了。
三、命名规范
以小写字母m（member的首字母）开头的变量表示类的成员变量。比如：
int mSensor;
int mTrackingState;
std::mutex mMutexMode;
对于某些复杂的数据类型，第2个甚至第3个字母也有一定的意义，比如：
mp开头的变量表示指针（pointer）型类成员变量；
Tracking* mpTracker;
LocalMapping* mpLocalMapper;
LoopClosing* mpLoopCloser;
Viewer* mpViewer;
mb开头的变量表示布尔（bool）型类成员变量；
bool mbOnlyTracking;
bool mbOnlyTracking;
std::vector<int> mvIniLastMatches;
std::vector<cv::Point3f> mvIniP3D;
mpt开头的变量表示指针（pointer）型类成员变量，并且它是一个线程（thread）;
std::thread* mptLocalMapping;
std::thread* mptLoopClosing;
std::thread* mptViewer;
ml开头的变量表示列表（list）型类成员变量；
mlp开头的变量表示列表（list）型类成员变量，并且它的元素类型是指针（pointer）；
mlb开头的变量表示列表（list）型类成员变量，并且它的元素类型是布尔型（bool）；
list<double> mlFrameTimes;
list<bool> mlbLost;
list<cv::Mat> mlRelativeFramePoses;
list<KeyFrame*> mlpReferences;
我相信通过上面的介绍，大家应该还是比较容易的知道一个变量的属性了，我们能够简单区分一个变量的属性，会为我们阅读或者编写代码节约时间，比如在索引一个类对象的成员时，根据命名我们就能知道应该使用 . 还是–> 进行引用。
四、源码总体框架
下面以RGB-D摄像头为例子，通过前面的博客，我们已经知道运行 RGB-D 示例的指令如下:
cd /my_work/01.ORB-SLAM2源码解析/ORB_SLAM2
./Examples/RGB-D/rgbd_tum Vocabulary/ORBvoc.txt Examples/RGB-D/TUM1.yaml /my_work/01.ORB-SLAM2源码解析/Datasets/rgbd_dataset_freiburg1_xyz /my_work/01.ORB-SLAM2源码解析/Datasets/rgbd_dataset_freiburg1_xyz/associations.txt
从这里我们可以知道，main 函数处于 ./Examples/RGB-D/rgbd_tum.cc 文件中，下是本人复制的简要代码以及注释:
int main(int argc, char **argv){
LoadImages(strAssociationFilename, vstrImageFilenamesRGB, vstrImageFilenamesD, vTimestamps);
ORB_SLAM2::System SLAM(argv[1],argv[2],ORB_SLAM2::System::RGBD,true);
for(int ni=0; ni<nImages; ni++)
imRGB = cv::imread(string(argv[3])+"/"+vstrImageFilenamesRGB[ni],CV_LOAD_IMAGE_UNCHANGED);
imD = cv::imread(string(argv[3])+"/"+vstrImageFilenamesD[ni],CV_LOAD_IMAGE_UNCHANGED);
SLAM.TrackRGBD(imRGB,imD,tframe);
SLAM.Shutdown();
}
是的，你没有看错，其系统架构就是这么简单，就仅仅如下几个过程而已:
1、加载图像数据，配置文件
2、启动系统，然后for循环进行追踪
3、系统停止
虽然说看起来十分简单，但是其内部的代码是非常复杂的，其中 ORB_SLAM2::System 这个类是十分庞大的，但是大家也不用太担心，因为从上面我们可以看到一个引子那就是 SLAM.TrackRGBD(imRGB,imD,tframe)。这个也是我们后续需要研究的核心部分。
五、结语
通过该篇博客，我们简单的了解一下C++的编程规范以及 ORB-SLAM2 的整体框架，并且找到了其中的线索引子。那么我们之后就可以顺着下去分析。
本文内容来自计算机视觉life ORB-SLAM2 课程课件
Original: https://blog.csdn.net/weixin_43013761/article/details/123153360
Author: 江南才尽，年少无知！
Title: (01)ORB-SLAM2源码无死角解析-(02)C++命名规范_总体框架解读
原创文章受到原创版权保护。转载请注明出处：https://www.johngo689.com/597834/
转载文章受原作者版权保护。转载请注明原作者出处！