Rick0514/SimpleSLAM

SimpleSLAM

A lidar-centric simple slam integrated with sensors like imu and wheel odometer, with lots of interfaces for easily re-developing

Modules

dataproxy

data interface compatible with various comm protocols. Adapt to another data is easy, you should inherit Base class DataProxy, which is templated and ensure thread-safty with block queue(see common/utils/SafeDeque.hpp)

frontend

SLAM frontend providing real-time odometry. Our frontend module is not depend on backend. Frontend is testable individually as locating mode(see unit test: test/loc.cpp). Our frontend is lidar-centric, Lidar odometry is the most important part applying the key algorthm of loose-coupled schem.

PCR(PointCloudRegister)

Frontend heavily depends on PCR. PCR abstract common interface of lidar register and adapt with some mature lidar register algorithms. LOAM-like pc register implemented by [1] is reimplemented with Lie-group update schem. More good algorithms like Ndt[2], Vgicp[3] are available.

filter

Filter module serves to provide locally accurate odometry like fusion of dead-reckoning, imu or wheel encoder. Extendtable light-weight header-only Kalman library[4] is included. Current version is just simple fusion of wheel, imu and static model. 2D case performance is totally the same as [5].(see test for comparison: filter/test)

backend

SLAM backend for optimization stuff. Backend depends on frontend, which sends keyframe to it. Then pose graph is constructed and optimize all keyframe pose based on gtsam library[6]. Loop closure detection is also included. I want to treat Loop closure detect as Place Recognition problem for scalerable application. So one Keyframe should be able to convert to generalizable context(or say descriptor). Place Recognition problem is just querying context from context database. If you want to use your own context, inherit ContextBase(see backend/include). For now, context based on 2D-distance and ScanContext[7] is implemented.

unit test

There are lots of unit test to check each modules working properly. Some are listed below:

benchmark/kdtree.cpp some benchmark showing efficiency of kdtree implement by PCL or Nanoflann[8].
benchmark/rospub.cpp showing that the time consumeing of publishing ros message which is not subscribed or is subscibed. They are different.
comp/liorf_scan2map.cpp compare my Lie-group update LOAM register with original Euler-angle update LOAM[9] register
dataproxy.cpp test worker-consumer case with blocked or non-blocked deque.
lcm.cpp test Loop Closure Manager function with visualization.
logger.cpp test logger and progress bar.
thread.cpp test resident thread which means the thread's life extend utils whole program exit.
loc.cpp minimal lidar odometry case, if you has static pointcloud maps, you can test localization performance with mouse relocalization on rviz.

The main entry of the project! It depends on configuration file at config/params.json.

common

The project contains many practical tools at common.

geometry: matrix calculations, angle or pose translation, basic manifolds calculations.
pcp: pointcloud preprocesser.
time: time counter intergrate with spdlog[10].
types: basic types alias used in project.
utils: singleton logger, blocked or non-blocked queue, compatible share ptr between std and boost, file operation etc.

Framework

loose-coupled update schem

m means map frame, o means odom frame, t means time stamp.

Features

Non ROS except dataproxy.
Support parsing rosbag directly, very fast mapping offline without multi-core CPU.
Change pointcloud register method via config file.
Automatically switch to mapping or localization mode.
Support factor graph reload for remapping.
Support designing your own pointcloud descriptor or even visual descriptor.
Save all keyframe and ensure keyframe insertion is sparse.

Config

{
    // mode has lio or lo
    "mode": "lio",
    // speed up pointcloud register
    "cores": 4,
    // use ndt maybe no need to downsample, or sample rate should be small
    "downSampleVoxelGridSize": 0.5, 
    // use for pure location mode for unit test loc.cpp
    "pcd_file": "/home/gy/.robot/data/maps/hqc/hqc.pcd",
    // save map location
    "saveMapDir" : "/home/rick/pcr/test/data/map",
    // rosbag location
    "rosbag": "/media/gy/201E-43FF/binhai_gps0711-0706.bag",
    "tf":{
        // distance from ground use for ScanContext 
        "lidar_height": 2.0
    },

    "dataproxy": {
        // topic name
        "lidar": "/lidar_points",
        "lidar_size": 10,
        "imu": "/imu/data",
        "wheel": "/odom/raw"
    },

    // visualization stuff
    "vis": {
        "enable" : true,
        "align": "/aligned",
        "submap": "/globalmap"
    },
    "backend" : {
        // loop closure parameters
        "lc": {
            "enable" : false,
            "contextDownSampleGridSize" : 0.5,
            "historySubmapRange" : 1,
            "fitnessThreshold" : 0.3
        },
        "context": {
            "scancontext":{
                "numExcludeRecent" : 40,
                "buildTreeGap": 10,
                "numCandidatesFromTree" : 10,
                "searchRatio": 0.1,
                "scDistThres": 0.4
            }
        }
    },
    "frontend" : {
        "pcr" : "loam",     // loam, ndt or vgicp
        // queue size for global odometry or local odometry
        "local_size": 100,
        "global_size": 10
    }
}

Usage

Build

# build under real-time mode
bash build.sh 
# build under rosbag mode
bash build.sh rosbag
# rebuild project
bash build.sh rebuild

# rviz means launch rviz
# rebuild means rebuild whole map, factor graph will be deleted
bash run.sh <rviz> <rebuild>

# if you use rosbag, play it then.