Examples

This project ships examples in both C++ and Python that demonstrate how to read/write OSI trace files and convert between formats. Use them as reference implementations for API usage and expected file formats.

C++ examples

• example_mcap_reader.cpp — MCAP read, metadata inspection, FilenameUtils

• example_mcap_writer.cpp — MCAP write, both metadata overloads, config constants

• example_single_channel_binary_reader.cpp — .osi binary read

• example_single_channel_binary_writer.cpp — .osi binary write

• example_txth_reader.cpp — .txth text read

• example_txth_writer.cpp — .txth text write

• convert_osi2mcap.cpp — convert .osi to .mcap

• convert_gt2sv.cpp — convert GroundTruth to SensorView

Build C++ examples

Examples are built as part of the normal build:

make build cpp

Run C++ examples

Binaries are in build-vcpkg/cpp/examples/ (or build/cpp/examples/ for the base preset).

./build-vcpkg/cpp/examples/example_mcap_reader input.mcap

For more details, see cpp/examples/README.md.

Python examples

• example_mcap_reader.py — MCAP read, metadata inspection

• example_mcap_writer.py — MCAP write, both metadata APIs, config constants

• example_single_channel_binary_reader.py — .osi binary read

• example_single_channel_binary_writer.py — .osi binary write

• example_txth_reader.py — .txth text read

• example_txth_writer.py — .txth text write

• convert_osi2mcap.py — convert .osi to .mcap

Setup Python environment

make setup

Run Python examples

python python/examples/example_mcap_writer.py
python python/examples/example_mcap_reader.py .playground/sv_example.mcap

For more details, see python/examples/README.md.