diff --git a/doc/architecture/formatting_script.adoc b/doc/architecture/formatting_script.adoc deleted file mode 100644 index d8beec595..000000000 --- a/doc/architecture/formatting_script.adoc +++ /dev/null @@ -1,29 +0,0 @@ -ifndef::include-only-once[] -:root-path: ../ -include::{root-path}_config.adoc[] -endif::[] -= Trace-file formatting script - -The OSI repository contains a Python script for converting trace files from one format to another. -The formatting script is stored in `open-simulation-interface/osi3trace/`. - -**osi2read.py** - -`osi2read.py` converts trace files to human-readable `.txth` trace files. -This script takes the following parameters: - -`--data`, `-d`:: -String containing the path to the file with serialized data. - -`--type`, `-t`:: -Optional string describing the message type used to serialize data. -`'SensorView'`, `'GroundTruth'`, or `'SensorData'` are permitted values. -The default value is `'SensorView'`. - -`--output`, `-o`:: -Optional string containing the name of the output file. -The default value is `None`, in which case the output file name is set to the name of the input file, with the file extension being replaced by `.txth`. - -**Related topics** - -* <> \ No newline at end of file diff --git a/doc/architecture/trace_file_naming.adoc b/doc/architecture/trace_file_binary_and_human_readable_formats.adoc similarity index 73% rename from doc/architecture/trace_file_naming.adoc rename to doc/architecture/trace_file_binary_and_human_readable_formats.adoc index 1c73ed90c..32135ca8c 100644 --- a/doc/architecture/trace_file_naming.adoc +++ b/doc/architecture/trace_file_binary_and_human_readable_formats.adoc @@ -2,11 +2,16 @@ ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] -= OSI trace file naming conventions += Native binary and Human-readable Formats -**Name format** +== Binary .osi Format +Messages are separated by a four-byte, little-endian, unsigned integer specifying the length of each message. -The names of OSI trace files should have the following format: +== Human-readable .txth Format +Messages are stored as plain text, separated by newlines. + +== Naming Convention +Binary .osi and human-readable .txth files should follow this naming convention: ---- _____.osi @@ -76,3 +81,5 @@ The recommended file name is: ---- 20210818T150542Z_sv_312_300_1523_highway.osi ---- + +NOTE: This naming convention does not apply to .mcap files. \ No newline at end of file diff --git a/doc/architecture/trace_file_example.adoc b/doc/architecture/trace_file_example.adoc deleted file mode 100644 index 9de8dd43b..000000000 --- a/doc/architecture/trace_file_example.adoc +++ /dev/null @@ -1,78 +0,0 @@ -ifndef::include-only-once[] -:root-path: ../ -include::{root-path}_config.adoc[] -endif::[] -[#top-osi_trace_file_example] -= OSI trace file example - -[source, python] ----- -# generate_osi_messages.py -from osi3.osi_sensorview_pb2 import SensorView -import struct - -NANO_INCREMENT = 10000000 -MOVING_OBJECT_LENGTH = 5 -MOVING_OBJECT_WIDTH = 2 -MOVING_OBJECT_HEIGHT = 1 - -def main(): - """Initialize SensorView""" - f = open("sv_330_361_1000_movingobject.osi", "ab") - sensorview = SensorView() - - sv_ground_truth = sensorview.global_ground_truth - sv_ground_truth.version.version_major = 3 - sv_ground_truth.version.version_minor = 5 - sv_ground_truth.version.version_patch = 0 - - sv_ground_truth.timestamp.seconds = 0 - sv_ground_truth.timestamp.nanos = 0 - - moving_object = sv_ground_truth.moving_object.add() - moving_object.id.value = 42 - - # Generate 1000 OSI messages for a duration of 10 seconds - for i in range(1000): - - # Increment the time - if sv_ground_truth.timestamp.nanos > 1000000000: - sv_ground_truth.timestamp.seconds += 1 - sv_ground_truth.timestamp.nanos = 0 - sv_ground_truth.timestamp.nanos += NANO_INCREMENT - - moving_object.vehicle_classification.type = 2 - - moving_object.base.dimension.length = MOVING_OBJECT_LENGTH - moving_object.base.dimension.width = MOVING_OBJECT_WIDTH - moving_object.base.dimension.height = MOVING_OBJECT_HEIGHT - - moving_object.base.position.x += 0.5 - moving_object.base.position.y = 0.0 - moving_object.base.position.z = 0.0 - - moving_object.base.orientation.roll = 0.0 - moving_object.base.orientation.pitch = 0.0 - moving_object.base.orientation.yaw = 0.0 - - """Serialize""" - bytes_buffer = sensorview.SerializeToString() - f.write(struct.pack("