Skip to content

Commit 885e1a7

Browse files
paschedpasched
committed
docs: revise message formatting
Signed-off-by: pasched <patrick.schedlbauer@parson-europe.com>
1 parent cd39c16 commit 885e1a7

11 files changed

+31
-32
lines changed

‎doc/architecture/environmental_effect_model.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= Environmental effect model
22

3-
Environmental effect models consume sensor-view messages and produce sensor-view messages.
4-
Environmental effect models may, for example, alter sensor-view messages to include effects and phenomena caused by:
3+
Environmental effect models consume `SensorView` messages and produce `SensorView` messages.
4+
Environmental effect models may, for example, alter `SensorView` messages to include effects and phenomena caused by:
55

66
* Shadows and occlusions
77
* Weather effects

‎doc/architecture/feature_data.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
= Feature data
22

3-
Feature-data messages contain detected features in the reference frame of a sensor.
4-
Feature-data messages are generated from ground-truth messages.
3+
`FeatureData` messages contain detected features in the reference frame of a sensor.
4+
`FeatureData` messages are generated from `GroundTruth` messages.
55
They serve, for example, as an input to sensor models simulating object detection or feature fusion models.

‎doc/architecture/ground_truth.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
= Ground truth
22

3-
Ground-truth messages describe the simulated environment containing all simulated objects in the global coordinate system at consecutive time instances.
3+
`GroundTruth` messages describe the simulated environment containing all simulated objects in the global coordinate system at consecutive time instances.
44
They are based on data available to the simulation environment.
5-
Ground-truth messages are typically contained in sensor view messages.
5+
`GroundTruth messages are typically contained in `Sensorview` messages.

‎doc/architecture/logical_model.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Logical model
22

3-
Logical models consume sensor-data messages and produce sensor-data messages.
3+
Logical models consume `SensorData` messages and produce `SensorData` messages.
44

55
An example of a logical model is a sensor-fusion model, which combines the output of multiple sensor models to produce data with less uncertainty.
66
Another use case is the fault-injection model which, contrary to a sensor-fusion model, may be used to increase uncertainties.

‎doc/architecture/sensor_data.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= Sensor data
22

3-
Sensor-data messages imitate the output of real sensors.
4-
They can be generated from ground-truth messages, sensor-view messages, feature-data messages, or sensor-data messages.
3+
`SensorData` messages imitate the output of real sensors.
4+
They can be generated from `GroundTruth` messages, `SensorView` messages, `FeatureData` messages, or `SensorData` messages.
55
With the exception of feature data, all information regarding the environment is given with respect to the virtual sensor coordinate system.
66
Feature data is given with respect to the physical sensor coordinate system.
77
Sensor data can be used as input for an automated driving function, a sensor model simulating limited perception, or a sensor fusion model.

‎doc/architecture/sensor_model.adoc‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
= Sensor model
22

3-
Sensor models consume sensor-view messages and produce sensor-data messages.
4-
3+
Sensor models consume `SensorView` messages and produce `SensorData` messages.
54
Sensor-model output does not represent raw data but detected features or classified objects.

‎doc/architecture/sensor_view.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= Sensor view
22

33
The sensor view provides the input to OSI sensor models.
4-
Sensor-view messages are derived from ground-truth messages.
4+
`SensorView` messages are derived from 'GroundTruth' messages.
55
All information regarding the environment is given with respect to the virtual sensor coordinate system, with two exceptions:
66

77
* Physical technology-specific data, given with respect to the physical sensor coordinate system specified in the corresponding physical sensor's mounting position.

‎doc/architecture/sensor_view_configuration.adoc‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
1-
= Sensor view configuration
1+
= Sensor-view configuration
22

33
The sensor view is flexibly defined to provide different kinds of sensor models with an appropriate input.
4-
The sensor view configuration defines the configuration of a particular sensor view.
4+
The sensor-view configuration defines the configuration of a particular sensor view.
55

6-
The sensor-view-configuration message is used in the initialization phase of a simulation to negotiate the sensor view configuration for a particular sensor view input.
7-
It is also included as a sub-message in sensor view messages to indicate that the sensor view configuration is valid for a particular sensor view message.
6+
The `SensorViewConfiguration` message is used in the initialization phase of a simulation to negotiate the sensor-view configuration for a particular `SensorView` input.
7+
It is also included as a sub-message in `SensorView` messages to indicate that the sensor-view configuration is valid for a particular `SensorView` message.
88

9-
Sensor-view-configuration data has two main applications:
9+
`SensorViewConfiguration` data has two main applications:
1010

11-
- Enable the environment simulation to provide the necessary input to a sensor model.
12-
- Enable a sensor model to check whether the input matches its requirements.
11+
* Enable the environment simulation to provide the necessary input to a sensor model.
12+
* Enable a sensor model to check whether the input matches its requirements.
1313
If the input does not match the requirements, the sensor model may terminate the simulation.
1414
15-
NOTE: Sensor-view-configuration data is intended for the automatic configuration of the sensor view interface between an environment simulation and sensor model.
15+
NOTE: `SensorViewConfiguration` data is intended for the automatic configuration of the `SensorView` interface between an environment simulation and sensor model.
1616
The data is not intended to be a mechanism for parametrizing a generic sensor model.
1717

18-
During the initialization phase, there are two sources for sensor-view-configuration data:
18+
During the initialization phase, there are two sources for `SensorViewConfiguration` data:
1919

20-
1. Sensor-view configuration data may be provided by the sensor model to the environment simulation.
20+
. `SensorViewConfiguration` data may be provided by the sensor model to the environment simulation.
2121
In this case, the data describes the input configuration that is requested by the sensor model.
2222
If the sensor model does not provide such data, then the environment simulation will fall back to manual configuration of the sensor view.
23-
24-
2. Sensor-view configuration data may be provided by the environment simulation.
23+
+
24+
. `SensorViewConfiguration` data may be provided by the environment simulation.
2525
In response to the request by the sensor model, or based on manual configuration, the environment simulation configures the input and provides a new message that describes the actual configuration.
2626

2727
The configuration requested by the sensor model may differ from the configuration provided by the environment simulation.
@@ -31,4 +31,4 @@ In response to this difference, the sensor model can either accept this differen
3131

3232
The packaging layer defines the specifics of this auto-negotiation mechanism.
3333

34-
After the initialization phase, the environment simulation provides the actual sensor view configuration as part of each sensor view message.
34+
After the initialization phase, the environment simulation provides the actual sensor-view configuration as part of each `SensorView` message.

‎doc/architecture/trace_file_naming.adoc‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,19 @@ The names of OSI trace files should have the following format:
1111
**Types**
1212

1313
`sd`::
14-
Trace file contains sensor-data messages.
14+
Trace file contains `SensorData` messages.
1515

1616
`sv`::
17-
Trace file contains sensor-view messages.
17+
Trace file contains `SensorView` messages.
1818

1919
`gt`::
20-
Trace file contains ground-truth messages.
20+
Trace file contains `GroundTruth` messages.
2121

2222
`tu`::
23-
Trace file contains traffic-update messages.
23+
Trace file contains `TrafficUpdate` messages.
2424

2525
`tc`::
26-
Trace file contains traffic-command messages.
26+
Trace file contains `TrafficCommand` messages.
2727

2828

2929
**Example**

‎doc/architecture/traffic_command.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
= Traffic command
22

3-
Traffic-command messages contain control commands from the scenario engine to traffic participant models.
3+
`TrafficCommand` messages contain control commands from the scenario engine to traffic participant models.

0 commit comments

Comments
 (0)