Skip to content

Commit b76ee21

Browse files
authored
docs: document --delete-unmatched option and update merge mode behavior (#90)
Add --delete-unmatched to the Options table. Update merge mode description to reflect that single-file groups are now processed instead of skipped.
1 parent 059b257 commit b76ee21

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ If the input path is a directory, all bag files (`.mcap`, `.db3`, `.sqlite3`) in
8888
| `--overwrite` | Overwrite existing output files. By default, conversion is skipped if the output file already exists. |
8989
| `--merge` | Merge bag files from distributed log modules and convert in a single pass. Accepts multiple input directories. The last positional argument is the output directory. |
9090
| `--delete` | Delete source bag files after successful processing. In merge mode, deletes the original input bag files after each group is successfully merged and converted. |
91+
| `--delete-unmatched` | In merge mode, delete source bag files for groups with only a single file (no merge partner) after successful conversion. Can be combined with `--delete`. |
9192

9293
The `--base-frame` option transforms all output PointCloud2 messages to the specified coordinate frame using TF data (`tf2_msgs/msg/TFMessage`) from the input bag. The `--tf-mode` option controls how TF data is handled:
9394

@@ -110,7 +111,7 @@ Input files must follow the naming pattern:
110111
- `module_id`: Log module / ECU identifier (no underscores)
111112
- `rest`: Remaining part (e.g., timestamp), can contain underscores
112113

113-
Files with the same `sensing_system_id` and `rest` are grouped and merged into a single output bag. The output filename drops `module_id`: `<sensing_system_id>_<rest>.<ext>`. Messages are interleaved in timestamp order. Files that do not match the pattern or groups with only a single file are skipped.
114+
Files with the same `sensing_system_id` and `rest` are grouped and merged into a single output bag. The output filename drops `module_id`: `<sensing_system_id>_<rest>.<ext>`. Messages are interleaved in timestamp order. Groups with only a single file (no merge partner) are still processed — their LiDAR packets are decoded to PointCloud2 as normal. Files that do not match the naming pattern are skipped.
114115

115116
All conversion options (e.g., `--point-type`, `--base-frame`) are applied during the merge. Use `--delete` to remove the original input bag files after each group is successfully processed.
116117

0 commit comments

Comments
 (0)