Some Rules

Since OnePiece is expected to be friendly to beginners, it is necessary to make the code structure as clear as possible. Here are some rules that OnePiece followed when it was written.

First of all, except for examples, all classes, functions, etc., are included in the fucking_cool namespace. OnePiece is divided into several modules, and each module has its own namespace, which are camera (camera), geometry (geometry), visual odometry (odometry), loop closure detection (lcdetection), point cloud Registration (registration), optimization (optimization), generative model (integration), visualization (visualization), algorithm (algorithm) and other useful tools (tool).

Directory and file names are all composed of uppercase letters and lowercase letters (OnePiece), names of namespaces are composed of lowercase letters and underline (fucking_cool), function and class names are all composed of uppercase and lowercase letters (OnePiece), and the name of a specific object is composed of lowercase and underlined letters (fucking_cool) (basically this is the case, some functions may break the rules due to the negligence). For some special values ​​or parameters defined in advance, use all uppercase and undersline (MAX_VALUE).

Code indentation refers to python syntax.

The author writes poorly comments. But related papers will be given in the related_paper folder.

In examples, the author gives several examples, which will also be introduced in the following content. Just ignore the codes in examples that are not introduced.