Skip to content

Commit baef9ba

Browse files
committed
doc review (#549)
Signed-off-by: Patrick Schedlbauer <patrick.schedlbauer@parson-europe.com>
1 parent c539b64 commit baef9ba

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

doc/architecture/sensor_view.adoc

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

3-
Sensor view provides the input to OSI sensor models.
3+
The sensor view provides the input to OSI sensor models.
44
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

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

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

6-
This 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 all sensor view messages to indicate the sensor view configuration valid for this particular sensor view message.
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.
88

9-
Sensor-view-configuration data enables the environment simulation to supply the necessary input to a sensor model.
10-
It further enables a sensor model to check whether the input supplied matches its requirements and expectations and to terminate a simulation if this is not the case.
9+
Sensor-view-configuration data has two main applications:
1110

12-
NOTE: The data is intended for the automatic configuration of the sensor view interface between environment simulation and sensor model.
13-
Sensor-view-configuration data is not intended as a mechanism to parametrize a generic sensor model.
11+
- It enables the environment simulation to provide the necessary input to a sensor model.
12+
- It enables a sensor model to check whether the input matches its requirements.
13+
If the input does not match the requirements, the sensor model may terminate the simulation.
14+
15+
NOTE: Sensor-view-configuration data is intended for the automatic configuration of the sensor view interface between environment simulation and sensor model.
16+
The data is not intended as a mechanism to parametrize a generic sensor model.
1417

1518
During the initialization phase, there are two sources for sensor-view-configuration data:
1619

1720
1. Sensor-view-configuration data may be provided by the sensor model to the environment simulation.
18-
+
1921
In this case, the data describes the input configuration that is requested by the sensor model.
20-
If no such data is provided by a sensor model, then the environment simulation will fall back to manual configuration of the sensor view.
22+
If no such data is provided by the sensor model, then the environment simulation will fall back to manual configuration of the sensor view.
2123
2224
2. Sensor-view-configuration data may be provided by the environment simulation.
23-
+
2425
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.
2526
2627
The configuration requested by the sensor model may differ from the configuration provided by the environment simulation.
2728
This happens when the environment simulation does not support a requested configuration or when the requested configuration is ambiguous.
2829

29-
In response to this difference the sensor model can either accept this difference and adapt to it, or it can terminate the simulation to indicate that it is not able to accept the difference.
30+
In response to this difference, the sensor model can either accept this difference and adapt to it, or it can terminate the simulation to indicate that it is not able to accept the difference.
3031

31-
The specifics of the auto negotiation mechanism are specified in the packaging layer.
32+
The packaging layer defines the specifics of this auto-negotiation mechanism.
3233

33-
After the initialization phase the environment simulation will provide the actual sensor view configuration also 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 sensor view message.

0 commit comments

Comments
 (0)