From 41ceeef0593a816e411c86ddf66ebb7ef90f1b47 Mon Sep 17 00:00:00 2001 From: Thomas Sedlmayer Date: Wed, 20 Mar 2024 11:14:42 +0100 Subject: [PATCH 1/2] Fix documentation on FeatureData messages - Edit architecture overview concerning FeatureData/top level messages - Remove FeatureData specific adoc - Move contents to sensor_data.adoc Signed-off-by: Thomas Sedlmayer --- doc/architecture/architecture_overview.adoc | 2 +- doc/architecture/feature_data.adoc | 9 --------- doc/architecture/sensor_data.adoc | 4 ++++ doc/open-simulation-interface_user_guide.adoc | 2 -- 4 files changed, 5 insertions(+), 12 deletions(-) delete mode 100644 doc/architecture/feature_data.adoc diff --git a/doc/architecture/architecture_overview.adoc b/doc/architecture/architecture_overview.adoc index 9d8a20228..b82f173aa 100644 --- a/doc/architecture/architecture_overview.adoc +++ b/doc/architecture/architecture_overview.adoc @@ -7,7 +7,7 @@ endif::[] OSI contains an object-based environment description that uses the message format of the https://github.com/protocolbuffers/protobuf/wiki[Protocol Buffer] library. Google developed and maintains the Protocol Buffer library. OSI defines top-level messages that are used to exchange data between separate models. -Top-level messages define the `GroundTruth` interface, the `SensorData` interface, and – since OSI version 3.0.0 – the interfaces `SensorView`, `SensorViewConfiguration`, and `FeatureData`. +Top-level messages define the `GroundTruth` interface, the `SensorData` interface, and – since OSI version 3.0.0 – the interfaces `SensorView` and `SensorViewConfiguration`. Further top-level messages that were added in later versions of OSI are `TrafficCommand`, `TrafficUpdate`, `MotionRequest`, and `StreamingUpdate`. The following figure shows the interfaces and models involved in modeling a sensor. diff --git a/doc/architecture/feature_data.adoc b/doc/architecture/feature_data.adoc deleted file mode 100644 index f6ebf271f..000000000 --- a/doc/architecture/feature_data.adoc +++ /dev/null @@ -1,9 +0,0 @@ -ifndef::include-only-once[] -:root-path: ../ -include::{root-path}_config.adoc[] -endif::[] -= Feature data - -`FeatureData` messages contain detected features in the reference frame of a sensor. -`FeatureData` messages are generated from `GroundTruth` messages. -They serve, for example, as an input to sensor models simulating object detection or feature fusion models. diff --git a/doc/architecture/sensor_data.adoc b/doc/architecture/sensor_data.adoc index f06383960..b44f0eeaa 100644 --- a/doc/architecture/sensor_data.adoc +++ b/doc/architecture/sensor_data.adoc @@ -9,3 +9,7 @@ They can be generated from `GroundTruth` messages, `SensorView` messages, `Featu With the exception of feature data, all information regarding the environment is given with respect to the virtual sensor coordinate system. Feature data is given with respect to the physical sensor coordinate system. Sensor data can be used as input for an automated driving function, a sensor model simulating limited perception, or a sensor fusion model. + +`SensorData` messages include `FeatureData` messages which contain detected features in the reference frame of a sensor. +`FeatureData` messages are generated from `GroundTruth` messages. +They serve, for example, as an input to sensor models simulating object detection or feature fusion models. diff --git a/doc/open-simulation-interface_user_guide.adoc b/doc/open-simulation-interface_user_guide.adoc index b9864441e..f45cc65c2 100644 --- a/doc/open-simulation-interface_user_guide.adoc +++ b/doc/open-simulation-interface_user_guide.adoc @@ -15,8 +15,6 @@ include::./architecture/architecture_overview.adoc[leveloffset=+2] include::./architecture/ground_truth.adoc[leveloffset=+3] -include::./architecture/feature_data.adoc[leveloffset=+3] - include::./architecture/sensor_view.adoc[leveloffset=+3] include::./architecture/sensor_view_configuration.adoc[leveloffset=+3] From f7b5409c29b7887be09ab1fc216c36b01fc26c4d Mon Sep 17 00:00:00 2001 From: "Pierre R. Mai" Date: Mon, 25 Mar 2024 11:48:39 +0100 Subject: [PATCH 2/2] Adjust formatting Signed-off-by: Pierre R. Mai --- doc/architecture/architecture_overview.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/architecture/architecture_overview.adoc b/doc/architecture/architecture_overview.adoc index b82f173aa..7a9e98828 100644 --- a/doc/architecture/architecture_overview.adoc +++ b/doc/architecture/architecture_overview.adoc @@ -7,7 +7,8 @@ endif::[] OSI contains an object-based environment description that uses the message format of the https://github.com/protocolbuffers/protobuf/wiki[Protocol Buffer] library. Google developed and maintains the Protocol Buffer library. OSI defines top-level messages that are used to exchange data between separate models. -Top-level messages define the `GroundTruth` interface, the `SensorData` interface, and – since OSI version 3.0.0 – the interfaces `SensorView` and `SensorViewConfiguration`. Further top-level messages that were added in later versions of OSI are `TrafficCommand`, `TrafficUpdate`, `MotionRequest`, and `StreamingUpdate`. +Top-level messages define the `GroundTruth` interface, the `SensorData` interface, and – since OSI version 3.0.0 – the interfaces `SensorView` and `SensorViewConfiguration`. +Further top-level messages that were added in later versions of OSI are `TrafficCommand`, `TrafficUpdate`, `MotionRequest`, and `StreamingUpdate`. The following figure shows the interfaces and models involved in modeling a sensor.