Skip to content

Commit ac9ecd2

Browse files
committed
fix(docs): Implement review comments (#549)
Signed-off-by: Maximilian Rosin <maximilian.rosin@parson-europe.com>
1 parent 87fc614 commit ac9ecd2

16 files changed

+70
-30
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 data and produce sensor-view data.
4-
Environmental effect models may, for example, include the following:
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:
55

66
* Shadows and occlusions
77
* Weather effects

doc/architecture/formatting_scripts.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ This script takes the following parameters:
1212
String containing the path to the file with serialized data.
1313

1414
`--type`, `-t`::
15-
Optional string containing the name of the type used to serialize data.
16-
Allowed values are `'SensorView'`, `'GroundTruth'`, and `'SensorData'`.
15+
Optional string describing the message type used to serialize data.
16+
Allowed values are `'SensorView'`, `'GroundTruth'`, or `'SensorData'`.
1717
The default value is `'SensorView'`.
1818

1919
`--output`, `-o`::
@@ -22,7 +22,7 @@ The default value is `'converted.osi'`.
2222

2323
`--compress`, `-c`::
2424
Optional boolean controlling whether to compress the output to a lzma file.
25-
Allowed values are `True`, and `False`.
25+
Allowed values are `True`, or `False`.
2626
The default value is `False`.
2727

2828
**osi2read.py**
@@ -35,14 +35,14 @@ String containing the path to the file with serialized data.
3535

3636
`--type`, `-t`::
3737
Optional string containing the name of the type used to serialize data.
38-
Allowed values are `'SensorView'`, `'GroundTruth'`, and `'SensorData'`.
38+
Allowed values are `'SensorView'`, `'GroundTruth'`, or `'SensorData'`.
3939
The default value is `'SensorView'`.
4040

4141
`--output`, `-o`::
4242
Optional string containing the name of the output file.
4343
The default value is `'converted.txth'`.
4444

4545
`--format`, `-f`::
46-
Optional string containing the format type of the trace.
47-
Allowed values are `'separated'`, and `None`.
46+
Optional string containing the format type of the trace file.
47+
Allowed values are `'separated'`, or `None`.
4848
The default value is `None`.

doc/architecture/ground_truth.adoc

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

3-
Ground truth describes the simulated environment around all simulated objects in the global coordinate system.
4-
It is based on data available to the simulation environment and published to external subscribers.
5-
Depending on the external subscriber, ground-truth data may be individually restricted to reduce the data to be exchanged.
3+
Ground-truth messages describe the simulated environment around all simulated objects in the global coordinate system at consecutive time instances.
4+
It is based on data available to the simulation environment and is published to external subscribers.
5+
Depending on the external subscriber, ground-truth messages may be individually restricted to reduce the data to be exchanged.
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Logical model
22

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

5-
An example of a logical model is a sensor-fusion model, which fuses the output of multiple sensor models.
6-
Another use case is the injection of faults after the sensor model.
5+
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.
6+
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 imitates the output of real sensors.
4-
It can be generated from ground-truth data, sensor-view data, feature data or from sensor data.
3+
Sensor-data messages imitate the output of real sensors.
4+
It can be generated from ground-truth messages, sensor-view messages, feature-data messages or from sensor-data messages.
55
Except 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 & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Sensor model
22

3-
Sensor models consume sensor-view data and produce sensor-data data.
3+
Sensor models consume sensor-view messages and produce sensor-data messages.
44
Those models can be based on physics or phenomenological.
55

66
Sensor-model output does not represent raw data, but detected features or classified objects.

doc/architecture/sensor_view.adoc

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

33
Sensor view imitates the input of sensors.
4-
Sensor-view data is derived from ground-truth data.
4+
Sensor-view messages are derived from ground-truth 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.
8-
* Ground-truth data, given in the global coordinate system.
8+
* Ground truth, given in the global coordinate system.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
= Traffic command
22

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

doc/architecture/traffic_participant.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The following figure shows a more advanced use case for traffic participants.
2323
.Traffic participant using other OSI interfaces internally
2424
image::{images_open_simulation_interface}/osi-traffic-participant-advanced.png[1100]
2525

26-
With every simulation step, an OSI traffic participant model receives ground truth data from the environment around itself, the sensor view.
26+
With every simulation step, an OSI traffic participant model receives ground-truth data from the environment around itself, the sensor view.
2727
A traffic participant can output its own perceivable state, the traffic update.
2828
Traffic commands influence the behavior of the traffic participant model.
2929
They allow event-based communication towards the traffic participant, that is, at certain simulation steps.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
= Traffic update
22

3-
Traffic updates are provided by traffic participants.
3+
Traffic-update messages are provided by traffic participants.
44
They provide updates of the position, state and future trajectory of a traffic participant back to the simulation environment.

0 commit comments

Comments
 (0)