一些规则

既然想要对初学者友好,代码结构尽量清晰是很有必要的。这里说明一些OnePiece在编写时候遵循的规则。

首先,除了示例,所有的类,函数等,都被包含在one_piece命名空间里。而OnePiece分成各个模块,每个模块也有各自的命名空间,分别是相机(camera),几何(geometry),视觉里程计(odometry),闭环检测(lcdetection),点云注册(registration),优化(optimization),生成模型(integration),可视化(visualization),算法(algorithm)以及其他工具(tool)。

目录以及文件名称都是大写加小写的方式(OnePiece),命名空间都是小写加下划线(one_piece),函数以及类名都是大写加小写(OnePiece),而某个特定的对象是小写加下划线的方式(one_piece)(基本都是这样,有些函数可能由于作者疏忽而可能会有破坏规则的情况)。对于提前定义的一些特殊值或者参数用全部大写加下划线的方式(MAX_VALUE)。

代码缩进参考python的语法。

作者的注释写的很差。但是相关的文章会在related_paper文件夹中给出。

examples中,作者给出了若干个示例,也会在后面的内容中介绍。没有介绍的部分,可能就是临时创建的项目未来得及删掉罢了,可以直接忽略。