LIO SLAM: FAST-LIO2#
FAST-LIO2 is a computationally efficient, tightly-coupled LiDAR-Inertial Odometry system built on an iterated Kalman filter and an incremental ikd-Tree map, without explicit feature extraction.
Paper: FAST-LIO2: Fast Direct LiDAR-inertial Odometry (IEEE T-RO / RA-L 2022)
Upstream: hku-mars/FAST_LIO (
ROS2branch)
In Robotics AI Suite, the upstream tree is a pristine git submodule and Intel changes ship as patches on top, so FAST-LIO2 can be evaluated as an alternative LIO backend without forking the reference navigation stack.
[!IMPORTANT] FAST_LIO’s LICENSE file is GPLv2. Its
package.xmlincorrectly declares<license>BSD</license>— that is upstream metadata, not the actual terms; treat this package as GPLv2 for compliance purposes. For commercial use, contact the upstream authors for an alternative license before shipping it in a product.
Changes to 3rd party source#
This work is based on the open-source
FAST_LIO repository (ROS2
branch), pinned in .gitmodules at the upstream
commit the patch below applies to.
Patch |
Change |
|---|---|
0001-Add-profiling-instrumentation-new-LiDAR-configs-and-.patch |
New Avia configs; |
0002-Reformat-laserMapping.cpp-to-match-the-project-s-rea.patch |
Reformats |
0003-Fix-IMU-buffer-locking-and-duplicate-init-in-laserMa.patch |
Widens the |
Profiling: built behind the ENABLE_PROFILING CMake option (off by
default, matching upstream). When enabled, a lock-free ring buffer plus a
dedicated writer thread records per-stage EKF timing (using
CLOCK_MONOTONIC, immune to PTP clock steps) to
FAST_LIO/Log/fast_lio_profiling.csv.
Environment setup (Ubuntu 24.04 / ROS 2 Jazzy)#
# 1. Fetch the pristine upstream submodule (--recursive also pulls in
# FAST_LIO's own nested ikd-Tree submodule, required by its CMakeLists.txt)
git submodule update --init --recursive robotics-ai-suite/pipelines/fast-lio2-demo/FAST_LIO
cd robotics-ai-suite/pipelines/fast-lio2-demo/scripts
# 2. One-time host dependencies (needs sudo; safe to re-run)
./install_deps.sh
# 3. Apply the Intel patches from the table above
./apply_patches.sh
# 4. Build fast_lio with colcon
./build.sh
All paths, the ROS distro, and the dataset sequence used below are centralized in scripts/env.sh — edit that one file to retarget a different workspace/sequence; nothing else needs to change.
Validate without hardware: UrbanLoco dataset replay#
No robot or sensor is required to verify the build and measure accuracy:
the ulhk_4 session (HK-Data20190117, ~5:21) from the public
UrbanLoco dataset (PolyU IPN-Lab,
ICRA 2020) is replayed through fastlio_mapping and compared against its
NovAtel SPAN-CPT ground truth.
UrbanLoco has no scriptable download: its listed Google Drive links require
a manual “can’t scan for viruses” confirmation step and, in practice, are
often unreachable at all from a corporate network even with an account.
fetch_ulhk.sh does not attempt an automated download — it only checks
whether the file is already present, and otherwise prints the Dropbox and
Baidu Netdisk links from the dataset’s own GitHub README (same shared
folder for every Hong Kong sequence) plus the exact path to place the file
at:
./fetch_ulhk.sh # checks whether the file is already there; otherwise prints download links + target path
./convert_ulhk_to_bag.sh # one-time conversion of the (ROS1) downloaded bag into a standard ROS 2 bag
./run_ulhk.sh # launch fastlio_mapping + `ros2 bag play` the converted bag, records the trajectory
./evaluate_rmse.sh # evo_ape RMSE vs. ground truth, printed next to the documented baseline
# or, once install_deps.sh has been run once and the file has been downloaded by hand:
./reproduce_all.sh # apply patches -> build -> check dataset -> convert -> run -> evaluate, in one command
UrbanLoco’s public download is a ROS1 bag, not a plug-and-play ROS2 one;
convert_ulhk_to_bag.sh uses the rosbags library’s rosbags-convert to
produce a standard ROS 2 bag under BAG_DIR
(scripts/env.sh). It skips
this step on subsequent runs if that bag already exists and its topics look
right (pass FORCE_CONVERT=true to redo it anyway) — so a colleague who has
already converted this exact sequence once can just reuse that bag directly
instead of re-downloading or re-converting it. run_ulhk.sh then replays
it with the standard ros2 bag play, like every other RAI-suite SLAM demo.
No FAST_LIO source or config change was needed to support this dataset: the
pristine upstream config/velodyne.yaml already has the right LiDAR/IMU
parameters for UrbanLoco’s Velodyne HDL-32E + external-IMU rig (scan_line: 32, scan_rate: 10, timestamp_unit: 2, blind: 2.0, extrinsic_T: [0,0,0.28], identity extrinsic_R — the same values the sibling
point-lio-demo pipeline’s own velodyne_urbanloco.yaml uses for the same
physical rig). Only the topic names and pcd_save_en differ from that
file’s defaults; run_ulhk.sh overrides both at the ros2 run level via
-p.
During replay, fastlio_mapping’s own log will repeat
Failed to find match for field 'time'. once per LiDAR scan for the whole
run — this is expected and harmless, not a sign of a broken pipeline.
It’s a PCL-level warning (see FAST_LIO/README.md’s note B) that the
incoming PointCloud2 has no per-point timestamp field; UrbanLoco’s 2019
Velodyne recording predates that convention, so FAST-LIO2 falls back to
estimating each point’s capture time from scan geometry instead (still
correct, just an internal fallback path). This is specific to this public
dataset’s age — a real Velodyne (or other) LiDAR driver on live hardware
does populate that field, so production/live-sensor runs of this pipeline
won’t print this at all.
For ulhk_4, the documented baseline is 2.57 m RMSE (FAST-LIO2 paper,
arXiv 2107.06829, Table IV — constant across all four non-feature map sizes
tested there; Point-LIO’s own paper reports 2.17 m on this same sequence,
printed alongside for context only). Intel’s own reproduce_all.sh run on
the PTL board (see “Reference: running on Intel PTL” below) measured
1.327 m, comfortably inside the tolerance band. The check is one-sided:
it passes as long as the freshly measured RMSE does not exceed that
baseline by more than RMSE_TOLERANCE_PCT (20% by default) — a measured
RMSE lower than the baseline always passes, since the check exists to
catch regressions,
not to flag outperforming the paper’s own number.
Rviz visualization#
run_ulhk.sh gates rviz2 behind the USE_RVIZ variable in
scripts/env.sh, off by default so the flow stays headless
over SSH:
USE_RVIZ=true ./run_ulhk.sh # or: USE_RVIZ=true ./reproduce_all.sh
Run this directly on the target machine’s own logged-in Ubuntu desktop session (e.g. on the PTL board’s display, not over plain SSH) — rviz2’s point-cloud rendering needs a real GPU display, so X11-forwarding it over SSH is impractical.
Reference: running on Intel PTL#
run_ulhk.sh ships a reference core-pinning + frequency-locking setup for
Intel PTL (validated on Core Ultra X7 358H: 4 P-cores cpu0-3 up to 4700
MHz, 8 E-cores cpu4-11 up to 3500 MHz, 4 LP-E-cores cpu12-15 up to 3300
MHz). Core numbering is specific to this SKU — re-check lscpu -e before
reusing these defaults on a different PTL SKU or platform.
Task |
Pinned to |
Why |
|---|---|---|
|
LP-E cores |
Keeps the timing-critical LIO thread on isolated cores the general scheduler and rest of the OS don’t touch. |
|
P-core |
Replaying the pre-converted bag is bursty I/O + decode work; a dedicated P-core keeps it from stealing cycles from the algorithm cores. |
|
P-core |
Point-cloud rendering is bursty GUI work best kept off the algorithm’s isolated cores; a P-core has the headroom for it. |
run_ulhk.sh wraps the algorithm and ros2 bag play with taskset -c and,
best-effort, sudo -n chrt -f -a -p 85 <pid> SCHED_FIFO priority-85 —
applied to the process after it’s already launched as the invoking
(non-root) user, not chained into the launch itself — whenever the matching
CPUSET_* variable in scripts/env.sh is non-empty (the
default). rviz2 gets taskset pinning only, no realtime priority. If
sudo -n isn’t usable (no passwordless sudoers entry for chrt), the
script warns and continues unprioritized rather than failing the run. To
disable pinning for a given task, blank out its variable in env.sh (e.g.
CPUSET_ALGO="").
Every process run_ulhk.sh launches — including the RT-prioritized ones —
stays owned by the invoking user throughout, never root: chrt -p <pid>
only changes an already-running process’s scheduling class via sudo’s
privilege, it never re-execs or changes that process’s own UID. This
matters beyond file ownership — it’s required for correctness when
USE_DDS_SHM=true (see below): a RouDi shared-memory daemon started by the
invoking user rejects registration from a root-owned client (iceoryx’s
Unix-domain registration socket creation fails across that UID boundary),
which otherwise surfaces as a fatal Timeout registering at RouDi. Is RouDi running? and aborts the process.
For apples-to-apples benchmarking, lock every core’s governor and min/max frequency (and, as a stronger hardware-level backstop, the HWP MSR request) before measuring:
sudo ./limit_ptl_cores.sh
This requires root and prints a per-core summary of the governor/min/max
frequency actually applied. Its targets (FREQ_P_CORES/FREQ_E_CORES/
FREQ_LPE_CORES, FREQ_*_MAX/FREQ_*_MIN, CPU_MODE_P/CPU_MODE_E) are
also in env.sh.
Manual reproduction (no scripts)#
Everything above is what scripts/*.sh automate. This section spells out the
same steps by hand — for anyone who’d rather not run scripts, or who’s
forking this pipeline and wants to see exactly what each step does before
changing it. Every path/value below is one of scripts/env.sh’s own
defaults; run these commands from inside pipelines/fast-lio2-demo (all
relative paths are relative to that directory, matching env.sh’s own
DEMO_DIR).
1. Host dependencies#
sudo apt-get install -y \
libpcl-dev libeigen3-dev \
ros-jazzy-pcl-ros ros-jazzy-pcl-conversions ros-jazzy-common-interfaces \
ros-jazzy-tf2 ros-jazzy-rosbag2 ros-jazzy-rosbag2-storage-default-plugins
fast_lio’s CMakeLists.txt/package.xml unconditionally depend on
livox_ros_driver2 (see “Limitations / non-goals” below), which in turn
needs Livox-SDK2 built from source — GCC ≥13’s libstdc++ stopped pulling in
<cstdint> transitively, so v1.3.1’s headers need it force-included:
git clone --depth 1 -b v1.3.1 https://github.com/Livox-SDK/Livox-SDK2.git /tmp/livox-sdk2
cmake -S /tmp/livox-sdk2 -B /tmp/livox-sdk2/build -DCMAKE_CXX_FLAGS="-include cstdint"
cmake --build /tmp/livox-sdk2/build -j"$(nproc)"
sudo cmake --install /tmp/livox-sdk2/build
2. Apply the Intel patches#
cd FAST_LIO
git am --keep-cr ../patches/0001-Add-profiling-instrumentation-new-LiDAR-configs-and-.patch
git am --keep-cr ../patches/0002-Reformat-laserMapping.cpp-to-match-the-project-s-rea.patch
git am --keep-cr ../patches/0003-Fix-IMU-buffer-locking-and-duplicate-init-in-laserMa.patch
cd ..
(git am fails on a dirty or already-patched tree — apply_patches.sh’s
extra safety is only needed if you’re re-running this against an edited
.patch file.)
3. Build with colcon#
mkdir -p ~/fast_lio2_ws/src
ln -sfn "$(pwd)/FAST_LIO" ~/fast_lio2_ws/src/fast_lio
source /opt/ros/jazzy/setup.bash
git clone --depth 1 -b 1.2.6 https://github.com/Livox-SDK/livox_ros_driver2.git ~/fast_lio2_ws/src/livox_ros_driver2
cp ~/fast_lio2_ws/src/livox_ros_driver2/package_ROS2.xml ~/fast_lio2_ws/src/livox_ros_driver2/package.xml
cd ~/fast_lio2_ws
colcon build --cmake-args -DROS_EDITION=ROS2 -DDISTRO_ROS=jazzy --packages-select livox_ros_driver2
source install/setup.bash
colcon build --packages-select fast_lio # add --cmake-args -DENABLE_PROFILING=ON for the latency CSV
cd -
4. Fetch the UrbanLoco dataset (ulhk_4, session HK-Data20190117) — manual download#
UrbanLoco has no scriptable download. Download the HK-Data20190117 entry
from section “2. Hong Kong Dataset” of the
UrbanLoco GitHub README via
either mirror it lists (Google Drive is frequently unreachable from
corporate networks even with an account, so these are the reliable ones):
Baidu Netdisk (百度网盘): https://pan.baidu.com/s/1-5d8xM1tzfsSSueTiU6-MQ?pwd=sufc
(same shared folder for every Hong Kong sequence — open the
HK-Data20190117 entry inside it). Place the downloaded ROS1 bag at:
mkdir -p datasets/ulhk_4
mv ~/Downloads/HK-Data20190117.bag datasets/ulhk_4/HK-Data20190117.bag
5. Convert to a ROS 2 bag#
UrbanLoco’s public download is a ROS1 bag, not a rosbag2 one — this is a
one-time conversion via the rosbags library:
pip install --user --break-system-packages rosbags
source /opt/ros/jazzy/setup.bash
~/.local/bin/rosbags-convert \
--src datasets/ulhk_4/HK-Data20190117.bag \
--dst datasets/ulhk_4/ulhk_bag
6. Run fastlio_mapping against the bag#
Two terminals. Terminal A — the algorithm:
source /opt/ros/jazzy/setup.bash
source ~/fast_lio2_ws/install/setup.bash
export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
export ROS_DOMAIN_ID=199
ros2 run fast_lio fastlio_mapping --ros-args \
--params-file ~/fast_lio2_ws/install/fast_lio/share/fast_lio/config/velodyne.yaml \
-p common.lid_topic:=/velodyne_points_0 \
-p common.imu_topic:=/imu/data \
-p pcd_save.pcd_save_en:=false \
-p use_sim_time:=false
Note this uses the pristine upstream velodyne.yaml (not a new/patched
config) — see “Validate without hardware” above for why its defaults
already fit this dataset’s sensor rig.
Terminal B — bag playback + trajectory recording (start once Terminal A is up and printing):
source /opt/ros/jazzy/setup.bash
export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
export ROS_DOMAIN_ID=199
python3 scripts/record_odometry_tum.py --topic /Odometry --out datasets/ulhk_4/results/ulhk_4_est_tum.txt &
ros2 bag play datasets/ulhk_4/ulhk_bag
ros2 bag play runs at the recorded (real-time) rate — the full ulhk_4
sequence is ~5:21; there’s no fast-forward, but it’s short enough that this
rarely matters. Once it exits, wait a couple of seconds for the last
odometry messages to land, then stop the recorder (kill %1 in Terminal B)
and fastlio_mapping (Ctrl-C in Terminal A — a clean SIGTERM, not
kill -9, so its destructor flushes any open CSV writer). The
core-pinning/SCHED_FIFO wrapping run_ulhk.sh applies on PTL (taskset/chrt)
is an optional performance extra, not required for a correctness repro —
see “Reference: running on Intel PTL” above if you want that too.
Optional — the CycloneDDS+iceoryx shared-memory transport, by hand
(equivalent to scripts/setup_dds_shm.sh start — run that script instead if
you don’t need to customize this):
sudo apt-get install -y \
ros-jazzy-cyclonedds ros-jazzy-rmw-cyclonedds-cpp \
ros-jazzy-iceoryx-posh ros-jazzy-iceoryx-hoofs ros-jazzy-iceoryx-binding-c
MY_IP=$(ip route get 1.1.1.1 | awk '/src/{for(i=1;i<=NF;i++) if ($i=="src") print $(i+1)}')
mkdir -p scripts/generated
cat > scripts/generated/cyclonedds_shm.xml <<EOF
<CycloneDDS><Domain><General>
<AllowMulticast>true</AllowMulticast>
</General><Discovery><Peers><Peer Address="$MY_IP"/></Peers></Discovery>
<SharedMemory>
<Enable>true</Enable>
<LogLevel>warn</LogLevel>
</SharedMemory>
</Domain></CycloneDDS>
EOF
AllowMulticast must be true, not false — false plus a unicast Peer
pointing at your own IP reliably breaks same-host node discovery on some
machines (confirmed on Orin).
cat > scripts/generated/roudi_config.toml <<'EOF'
[general]
version = 1
[[segment]]
[[segment.mempool]]
size = 128
count = 10000
[[segment.mempool]]
size = 1024
count = 5000
[[segment.mempool]]
size = 16384
count = 1000
[[segment.mempool]]
size = 131072
count = 200
[[segment.mempool]]
size = 524288
count = 50
[[segment.mempool]]
size = 1048576
count = 30
[[segment.mempool]]
size = 4194304
count = 100
EOF
source /opt/ros/jazzy/setup.bash
iox-roudi -c scripts/generated/roudi_config.toml --monitoring-mode off &
sleep 2
pgrep -x iox-roudi && echo "RouDi is up"
The mempool sizes above are sized for full PointCloud2 scans — RouDi’s own
stock example config is too small and silently drops SHM segments instead of
erroring. --monitoring-mode off is required: RouDi’s default liveness
monitor evicts any participant that misses a ~1.5s heartbeat, which
CPU-isolation/governor/SCHED_FIFO changes can trigger even on a healthy
process.
Then, in every shell that needs to see the algorithm node (Terminal A,
Terminal B, and any rviz2/ros2 node list shell), export one more variable
before sourcing the ROS setup files:
export CYCLONEDDS_URI="file://$(pwd)/scripts/generated/cyclonedds_shm.xml"
Verify with ros2 node list (should show /laser_mapping within ~1s of
launching fastlio_mapping). When done: stop fastlio_mapping/ros2 bag play, then pkill -x iox-roudi.
7. Evaluate RMSE#
python3 scripts/extract_ulhk_gt.py \
--bag-dir datasets/ulhk_4/ulhk_bag \
--topic /novatel_data/inspvax \
--out datasets/ulhk_4/results/ulhk_4_gt_tum.txt
pip install --user --break-system-packages evo # if not already installed
evo_ape tum datasets/ulhk_4/results/ulhk_4_gt_tum.txt datasets/ulhk_4/results/ulhk_4_est_tum.txt -a
Compare the printed RMSE against the documented ulhk_4 baseline of
2.57 m (FAST-LIO2 paper, arXiv 2107.06829, Table IV) — a fresh
measurement up to 20% above that baseline is an expected pass, since the
check exists to catch regressions rather than to require beating the
paper’s own number.
Limitations / non-goals#
Validated here: functional LIO operation and pose-tracking accuracy (RMSE) against the public UrbanLoco baseline, on a Velodyne-class LiDAR.
fast_lio’s build unconditionally depends onlivox_ros_driver2(and transitively Livox-SDK2), even though this pipeline only ever runs the Velodyne/UrbanLoco path — confirmed inCMakeLists.txt/package.xml, not a choice made by this integration.UrbanLoco has no scriptable download (see “Validate without hardware” above) —
fetch_ulhk.shonly checks for the file and prints where to get it by hand; there is no automated-download fallback like the old NCLT flow’s plainwgethad.The ground-truth parsing in scripts/extract_ulhk_gt.py reads NovAtel INSPVAX messages directly out of the bag’s sqlite3
.db3file by fixed CDR byte offset rather than deserializing through thenovatel_oem7_msgsmessage definitions, so no extra ROS package needs to be installed just to read ground truth.Only
ulhk_4has a confirmed session name and documented baseline;ulhk_5/ulhk_6are structural placeholders inscripts/env.shfor future extension, not yet populated.The converted
ulhk_4bag’sPointCloud2has no per-pointtimefield (see “Validate without hardware” above for whyfastlio_mappinglogs “Failed to find match for field ‘time’” once per scan because of this). This is non-fatal — FAST-LIO2 falls back to a scan-rate-based per-point time estimate — and the measured RMSE already reflects this; it is not a config bug to fix.UrbanLoco’s license (Creative Commons Attribution-NonCommercial-ShareAlike 4.0, non-commercial/academic use) should be checked on the dataset’s own GitHub page before redistributing any downloaded data.
GPLv2 licensing (see callout above) applies to the upstream code as-is; this integration does not change that.