ly041021/odom_dataset

里程计 ROSBag 数据集

1. Dataset Overview

这是一个第一版 ROSBag 里程计数据集仓库。它只做三件事：保存原始 ROS1 bag、维护基础 metadata、生成 Hugging Face 友好的 Parquet 索引。

当前仓库包含 17 个 session，总时长约 2077.404 秒，也就是 34 分 37.4 秒。metadata/topics.parquet 当前包含 262 条 topic 统计记录。

第一版不做 train、val、test 切分。不导出 RGB、depth、infra、lidar 点云文件。不组织训练集目录。原始 bag 才是数据源，Parquet 只是索引。

2. Repository Structure

raw/sessions/<session_id>/bag.bag
raw/sessions/<session_id>/bag.bag.sha256
raw/sessions/<session_id>/metadata.yaml
raw/sessions/<session_id>/topic_summary.yaml
metadata/sessions.parquet
metadata/topics.parquet
calibration/robot_v1_template/
quality/reports/
scripts/
examples/
tests/

dataset/bags/ 是本地原始来源目录，已被 .gitignore 忽略，不作为仓库数据入口提交。仓库正式数据入口是 raw/sessions/。

注意：GitHub LFS 单文件限制为 2GiB，本数据集多数 bag 超过这个限制。因此 GitHub 版本只提交 metadata、topic summary、Parquet 索引和小型文本文件；raw/sessions/*/bag.bag 保留在本地，或上传到支持大对象的数据托管平台。不要把 GitHub 当作这批原始 bag 的完整数据仓库。

3. Raw ROSBag Policy

原始 ROSBag 是不可变数据。不要覆盖旧 bag，不要手动修改 bag 内容，不要把新采集直接塞进旧 session。

新增采集必须创建新的 session：

raw/sessions/<new_session_id>/

这条规则很重要。数据集最怕的不是目录多，而是旧数据被悄悄改掉。

4. ROS Topics

IMU:

• /mavros/imu/data
• /mavros/imu/data_raw
• /livox/imu

ToF:

• /nlink_tofsensem_cascade

LiDAR:

• /livox/lidar

Odometry:

• /fusion_odometry/current_point_odom
• /fusion_odometry/lazy_point_odom
• /ekf_quat/ekf_odom

Camera:

• /camera/color/image_raw
• /camera/color/camera_info
• /camera/depth/image_rect_raw
• /camera/depth/camera_info
• /camera/infra1/image_rect_raw
• /camera/infra1/camera_info
• /camera/infra2/image_rect_raw
• /camera/infra2/camera_info

TF:

• /tf
• /tf_static

5. Session Naming

输入 bag 文件名格式：

odom_dataset_YYYYMMDD_HHMMSS.bag

自动生成的 session ID 格式：

YYYY-MM-DD_HHMMSS_odom_runXXX

示例：

odom_dataset_20260513_024746.bag -> 2026-05-13_024746_odom_run001

6. Time Convention

metadata 和 Parquet 中的时间戳统一使用纳秒，单位是 ns。

时长统计使用每个 bag 的：

end_time_ns - start_time_ns

多个 session 的总时长是各 session 时长相加，中间没有数据的空档不计入。

7. Calibration

标定模板位于：

calibration/robot_v1_template/

这些文件是模板，不是严格实测标定。做定量评估或训练前，应该替换成真实机器人标定。

8. Metadata Schema

schema 文档在：

metadata/schema.md

每个 session 的 metadata 位于：

raw/sessions/<session_id>/metadata.yaml

每个 session 的 topic 统计位于：

raw/sessions/<session_id>/topic_summary.yaml

9. Parquet Tables

metadata/sessions.parquet 是 session 级索引。

metadata/topics.parquet 是 topic 级索引。

Parquet 是快速检索入口，不是原始数据替代品。真正的数据仍然是 raw/sessions/<session_id>/bag.bag。在本地工作区这个文件存在；在 GitHub 镜像中它不会被提交，因为 GitHub LFS 拒绝超过 2GiB 的对象。

10. How to Import Existing Bags

先预览导入计划：

python scripts/import_raw_bags.py \
  --input-dir dataset/bags \
  --mode hardlink \
  --repo-root . \
  --dry-run

正式导入：

python scripts/import_raw_bags.py \
  --input-dir dataset/bags \
  --mode hardlink \
  --repo-root .

当前仓库使用 hardlink 导入，是为了保留 dataset/bags 的路径，同时避免再额外复制一份 76G 的 bag 数据。不要手动编辑 hardlink 指向的 bag 内容。

11. How to Add a New Bag

python scripts/add_session.py \
  --bag /path/to/odom_dataset_20260513_024746.bag \
  --session-id 2026-05-13_024746_odom_run001 \
  --calibration-id robot_v1_template \
  --quality-status unchecked \
  --mode hardlink \
  --repo-root .

如果目标 session 已存在，脚本会报错并拒绝覆盖。这是故意的。

12. How to Scan Topics

单个 session：

python scripts/scan_bag_topics.py \
  --session-dir raw/sessions/2026-05-13_024746_odom_run001 \
  --write-metadata

全部 session：

make scan-all

如果本机是 ROS2，但 bag 是 ROS1，使用本地 Docker 环境扫描：

.local_docker/ros1_noetic/run.sh 'make PYTHON=python3 scan-all'

.local_docker/ 是本地工具目录，已在 .git/info/exclude 中排除，不会提交到仓库。

13. How to Validate the Dataset

python scripts/validate_dataset.py --repo-root .

或在 ROS1 Docker 环境中：

.local_docker/ros1_noetic/run.sh 'make PYTHON=python3 validate'

校验会检查 session 文件、sha256、metadata、calibration 引用、Parquet 文件和 Git LFS 配置。

14. How to Use with Git LFS

初始化 Git LFS：

bash scripts/init_git_lfs.sh

确认 LFS 文件：

git lfs ls-files

.parquet 等索引文件由 Git LFS 管理。README.md、.yaml、.py、.sh、.json 这些文本文件不走 LFS。

*.bag 仍在 .gitattributes 中配置为 LFS 类型，但当前 GitHub 远端不能接收这些 bag，因为单个文件超过 2GiB。不要强行 git add -f raw/sessions/*/bag.bag 后推送到 GitHub。

15. Git Remotes and Branches

本仓库使用两个远端、两条用途不同的分支。不要混用。

远端：

origin -> GitHub: https://github.com/Ly041021/odom_dataset.git
hf     -> Hugging Face Dataset: https://huggingface.co/datasets/ly041021/odom_dataset

分支：

main    -> GitHub metadata-only 镜像，不提交 raw/sessions/*/bag.bag
hf-main -> Hugging Face 完整数据分支，提交 raw/sessions/*/bag.bag

检查远端和分支：

git remote -v
git branch -vv

禁止使用：

git push --all

这会把不该推的分支一起推上去。GitHub 会因为超 2GiB bag 失败，HF 也可能收到你不想公开的历史。

16. Daily Update Workflow

日常维护先激活环境：

conda activate odom_dataset

检查当前状态：

git status
git branch --show-current
git lfs ls-files

如果只是改 README、脚本、metadata schema、quality report：

git switch main
git status
git add README.md scripts metadata quality dataset.yaml Makefile .gitignore
git commit -m "update documentation and metadata tooling"
git push origin main

然后把同样的文档改动同步到 HF 分支。注意：不要直接切换 hf-main，否则 Git LFS 可能尝试重新写出几十 GB 的 bag。使用 GIT_LFS_SKIP_SMUDGE=1：

GIT_LFS_SKIP_SMUDGE=1 git switch hf-main
git merge main
git push hf hf-main:main
git switch main

如果 merge 触发大文件 checkout 或磁盘不足，先不要硬来。用下面的只推文档方式：

git switch main
git push origin main
git show main:README.md > /tmp/README.md
GIT_LFS_SKIP_SMUDGE=1 git switch hf-main
cp /tmp/README.md README.md
git add README.md
git commit -m "sync readme from github branch"
git push hf hf-main:main
git switch main

17. How to Push to GitHub

GitHub 只作为代码和 metadata 镜像，不托管大 bag。

推送前检查：

git switch main
git status
git lfs ls-files
make validate

确认 git lfs ls-files 只包含 Parquet 等小索引文件，不应该出现 raw/sessions/*/bag.bag。

推送：

git push origin main

如果 GitHub 报 Size must be less than or equal to 2147483648，说明你又把 bag 加进 GitHub 历史了。正确修法是回到 metadata-only 分支，不是继续重试。

18. How to Push to Hugging Face

Hugging Face 托管完整数据，包括 17 个 bag.bag。

首次配置：

conda activate odom_dataset
hf auth login
git remote add hf https://huggingface.co/datasets/ly041021/odom_dataset
hf lfs-enable-largefiles .

如果 hf 远端已存在，不要重复添加：

git remote -v

推送完整数据：

GIT_LFS_SKIP_SMUDGE=1 git switch hf-main
git push hf hf-main:main

如果 HF 提示 You need to configure your repository to enable upload of files > 5GB：

hf lfs-enable-largefiles .
git push hf hf-main:main

如果 HF 提示 README YAML metadata 错误，先检查 README 顶部 front matter。configs 必须是数组格式：

configs:
  - config_name: sessions
    data_files: metadata/sessions.parquet
  - config_name: topics
    data_files: metadata/topics.parquet

如果 LFS 已上传完成，但 Git 引用被拒绝为 fetch first，先 fetch 再推：

git fetch hf main
git push --force-with-lease hf hf-main:main

只在你明确知道远端 main 应该被本地 hf-main 覆盖时，才使用上面的 --force-with-lease。

19. Add New ROSBag Sessions

新增 bag 放在本地来源目录，例如：

dataset/bags/odom_dataset_YYYYMMDD_HHMMSS.bag

先预览：

python scripts/import_raw_bags.py \
  --input-dir dataset/bags \
  --mode hardlink \
  --repo-root . \
  --dry-run

正式导入：

python scripts/import_raw_bags.py \
  --input-dir dataset/bags \
  --mode hardlink \
  --repo-root .

扫描 topic：

.local_docker/ros1_noetic/run.sh 'make PYTHON=python3 scan-all'

生成索引并校验：

make build-index
make validate

更新 GitHub metadata-only 分支：

git switch main
git add metadata raw/sessions quality README.md
git commit -m "update metadata for new rosbag sessions"
git push origin main

更新 HF 完整数据分支：

GIT_LFS_SKIP_SMUDGE=1 git switch hf-main
git add raw/sessions metadata quality README.md
git commit -m "add new raw rosbag sessions"
git push hf hf-main:main
git switch main

注意：main 的 .gitignore 会忽略 raw/sessions/*/bag.bag，所以 GitHub 不会上传 bag；hf-main 应该保留 bag 的 LFS 跟踪。

如果切换 hf-main 后发现 raw/sessions/*/bag.bag 变成了 LFS 指针文件，不要提交。先回到 main，再用本地 dataset/bags 重新建立 hardlink。

20. Local ROS1 Docker

本机是 ROS2，但 bag 是 ROS1。使用本地 Docker 解析 ROS1 bag。

构建镜像：

.local_docker/ros1_noetic/build.sh

验证 ROS1 rosbag：

.local_docker/ros1_noetic/run.sh 'python3 -c "import rosbag; print(rosbag.__file__)"'

扫描全部 session：

.local_docker/ros1_noetic/run.sh 'make PYTHON=python3 scan-all'

.local_docker/ 只存在本地，并通过 .git/info/exclude 排除，不提交到 GitHub 或 HF。

21. Token and Credential Safety

如果终端曾经回显过 Hugging Face token，应该撤销旧 token 并重新生成。

重新登录：

conda activate odom_dataset
hf auth login
git config --global credential.helper store

检查当前登录：

hf auth whoami
hf auth list

不要把 token 写进 README、脚本、YAML 或 shell history 里。

22. Disk Space Notes

本仓库本地有三类大数据：

dataset/bags/                 本地原始来源 bag
raw/sessions/*/bag.bag         session 入口，通常是 hardlink
.git/lfs/objects/              Git LFS 本地缓存

检查空间：

du -sh dataset/bags raw/sessions .git/lfs .git/objects
df -h .

如果 .git/lfs/objects 占用过大，并且确认 LFS 对象已经成功上传到 HF，可以清理本地 LFS 缓存：

rm -rf .git/lfs/objects
mkdir -p .git/lfs/objects

如果 raw/sessions 突然从几百 KB 变成几十 GB，说明 hardlink 可能被破坏。重新建立 hardlink：

for meta in raw/sessions/*/metadata.yaml; do
  session_dir="$(dirname "$meta")"
  filename="$(awk '/^[[:space:]]*filename:/ {print $2; exit}' "$meta")"
  source="dataset/bags/$filename"
  target="$session_dir/bag.bag"
  rm -f "$target"
  ln "$source" "$target"
done

23. Future Work

第二版可以再做：

• train/val/test 切分
• frames.parquet
• odometry.parquet
• RGB、depth、infra 图像导出
• lidar 点云导出
• 训练集目录组织

如果以后导出图片和点云，不要把几十万个文件放进一个目录。按 session、时间段或 frame range 分片。

24. Known Limitations

第一版只保证 raw bag 存储和基础索引。它不解码图像，不导出点云，不生成训练样本。

topic 扫描依赖 ROS1 rosbag。如果本机只有 ROS2，请使用本地 ROS1 Docker 环境。

当前 calibration/robot_v1_template/ 是模板标定，不应当直接当作真实标定用于严肃评估。

25. Citation

@dataset{odometry_rosbag_dataset,
  title = {Odometry ROSBag Dataset},
  year = {2026},
  note = {Raw ROSBag storage dataset with metadata indexes}
}