Commit CCB review results for doc migration

pmai · pmai · commit 978687a5b39d · 2021-08-18T12:54:04.000+02:00
Signed-off-by: Pierre R. Mai &lt;pmai@pmsf.de&gt;
diff --git a/doc/architecture/sensor_model.adoc b/doc/architecture/sensor_model.adoc
@@ -1,6 +1,5 @@
 = Sensor model
 
 Sensor models consume sensor-view messages and produce sensor-data messages.
-Those models can be based on physics or phenomenological.
 
 Sensor-model output does not represent raw data but detected features or classified objects.
diff --git a/doc/architecture/sensor_view.adoc b/doc/architecture/sensor_view.adoc
@@ -5,5 +5,5 @@ Sensor-view messages are derived from ground-truth messages.
 All information regarding the environment is given with respect to the virtual sensor coordinate system, with two exceptions:
 
 * Physical technology-specific data, given with respect to the physical sensor coordinate system specified in the corresponding physical sensor’s mounting position.
-  Example: https://opensimulationinterface.github.io/open-simulation-interface/structosi3_1_1CameraSensorView.html#ac58456a34babf78792ea2608eb963f36[`image_data` of `osi3::CameraSensorView`]
+  Example of technology-specific data: https://opensimulationinterface.github.io/open-simulation-interface/structosi3_1_1CameraSensorView.html#ac58456a34babf78792ea2608eb963f36[`image_data` of `osi3::CameraSensorView`]
 * Ground truth, given in the global coordinate system.
diff --git a/doc/architecture/sensor_view_configuration.adoc b/doc/architecture/sensor_view_configuration.adoc
@@ -12,6 +12,6 @@ Sensor-view-configuration data is not intended to provide parameters to a sensor
 Sensor-view-configuration data can also be provided by the sensor model to the environment simulation.
 In this case, the data describes the input configuration that is requested by the sensor model.
 In response, the environment simulation will configure the input and provide a new message which describes the actual configuration.
-The configuration requested by the sensor model may differ from the configuration provided by the simulation environment.
+The configuration requested by the sensor model may differ from the configuration provided by the environment simulation.
 This happens when the environment simulation does not support a requested configuration or when the requested configuration is ambiguous.
-The message describing the configuration requested by the sensor model differs from the message describing the configuration provided by the simulation environment.
+The message describing the configuration requested by the sensor model differs from the message describing the configuration provided by the environment simulation.
diff --git a/doc/architecture/trace_file_naming.adoc b/doc/architecture/trace_file_naming.adoc
@@ -6,7 +6,7 @@ Names of OSI trace files should have the following format:
 
 [source]
 ----
-<type>_<osi-version>_<protobuf-version>_<frame-number>_<custom-trace-name>.osi
+<timestamp>_<type>_<osi-version>_<protobuf-version>_<number-of-frames>_<custom-trace-name>.osi
 ----
 
 **Types**
@@ -20,12 +20,22 @@ Trace file contains sensor-view messages.
 `gt`::
 Trace file contains ground-truth messages.
 
+`tu`::
+Trace file contains traffic-update messages.
+
+`tc`::
+Trace file contains traffic-command messages.
+
+
 **Example**
 
 Given an OSI trace file with the following information:
 
 [cols="1,1"]
 |===
+|Timestamp (ISO 8601)
+|20210818T150542Z
+
 |Type
 |SensorView
 
@@ -38,13 +48,13 @@ Given an OSI trace file with the following information:
 |Number of frames
 |1523
 
-|Scenario name
+|Custom Trace Name
 |highway
 |===
 
-The recommend file name is: 
+The recommended file name is: 
 
 [source]
 ----
-sv_312_300_1523_highway.osi
+20210818T150542Z_sv_312_300_1523_highway.osi
 ----
diff --git a/doc/releases/versioning.adoc b/doc/releases/versioning.adoc
@@ -1,4 +1,4 @@
-= Versioning
+= Versioning and Compatibility
 
 The version number is defined in `InterfaceVersion::version_number` in `osi_version.proto` as the field’s default value.
 
diff --git a/doc/usecases/transforming_coordinate_systems.adoc b/doc/usecases/transforming_coordinate_systems.adoc
@@ -1,7 +1,11 @@
-= Transforming coordinate systems
+= Coordinate Transformations
 
-Transforming coordinates for a specific vehicle or sensor is a common task when running simulations.
-OSI uses DIN ISO 8855:2013-11 for coordinate systems and transformations between coordinate systems.
+== Vehicle and Sensor Coordinate Systems
+
+Transforming coordinates from the world coordinate system for a specific vehicle and its sensors is a common task when running simulations.
+
+This section provides an overview of the involved messages, fields and their relationship for this task.
+It demonstrates how world coordinate system, vehicle coordinate system, and sensor coordinate system are related for a specific (ego-)vehicle.
 
 //TODO: Should we add one or more sentences about the mathematical operations involved?
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-= Versioning`
	`1`	`+= Versioning and Compatibility`
`2`	`2`
`3`	`3`	The version number is defined in `InterfaceVersion::version_number` in `osi_version.proto` as the field’s default value.
`4`	`4`