Skip to content

Commit 77a6121

Browse files
max-rosinStefan Cyliax
authored andcommitted
fix(docs): implement review comments (#549)
Signed-off-by: Maximilian Rosin <maximilian.rosin@parson-europe.com>
1 parent 743f6f4 commit 77a6121

File tree

4 files changed

+15
-9
lines changed

4 files changed

+15
-9
lines changed

doc/architecture/reference_points_coordinate_systems.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,14 @@ OSI uses three coordinate systems:
66
World coordinate system::
77
Coordinate system for all entities which are part of ground truth.
88
The world coordinate system is an inertial x/y/z-coordinate system.
9+
The origin is the global reference point, which is determined by the environment simulation.
10+
This reference point may be derived from map data or other considerations.
11+
World coordinates can be mapped to a geographic coordinate system via `osi3::GroundTruth::proj_string`.
912

1013
Sensor coordinate system::
1114
Coordinate system for all entities which are part of sensor data.
12-
The origin is the mounting position of the physical sensor or a virtual mounting position, depending on the technology.
15+
The origin is the mounting position of the physical sensor or a virtual mounting position, depending on the OSI message.
1316

1417
Object coordinate system::
15-
Coordinate system for local object coordinates.
18+
Local object coordinate system.
1619
The origin of the corresponding coordinate systems is not necessarily identical to the center of the object's bounding box.

doc/architecture/sensor_view.adoc

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

3-
Sensor view imitates the input of sensors.
3+
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

77
* Physical technology-specific data, given with respect to the physical sensor coordinate system specified in the corresponding physical sensor’s mounting position.
8+
Example: https://opensimulationinterface.github.io/open-simulation-interface/structosi3_1_1CameraSensorView.html#ac58456a34babf78792ea2608eb963f36[`image_data` of `osi3::CameraSensorView`]
89
* Ground truth, given in the global coordinate system.
Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
= Sensor view configuration
22

33
The sensor view configuration configures the sensor view.
4+
Sensor-view-configuration data enables the environment simulation to supply the necessary input to a sensor model.
5+
46
There are two sources for sensor-view-configuration data.
57

68
Sensor-view-configuration data can be provided by the environment simulation.
7-
In this case, the data is intended for the automatic configuration of an environment simulation in order to supply the necessary input to a sensor model.
9+
Note that the data is intended for the automatic configuration of an environment simulation.
810
Sensor-view-configuration data is not intended to provide parameters to a sensor model.
911

1012
Sensor-view-configuration data can also be provided by the sensor model to the environment simulation.
11-
In this case, the data describes the input configuration that is desired by the sensor model.
13+
In this case, the data describes the input configuration that is requested by the sensor model.
1214
In response, the environment simulation will configure the input and provide a new message which describes the actual configuration.
13-
The configuration requested by the sensor model may differ from the actual configuration.
14-
This happens when the environment simulation does not support a given requested configuration or when the requested configuration allowed is ambiguous.
15-
The message describing the requested configuration differs from the message describing the actual configuration.
15+
The configuration requested by the sensor model may differ from the configuration provided by the simulation environment.
16+
This happens when the environment simulation does not support a requested configuration or when the requested configuration is ambiguous.
17+
The message describing the configuration requested by the sensor model differs from the message describing the configuration provided by the simulation environment.

doc/setup/installing_linux_cpp.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ cd build
3838
----
3939
+
4040
. Run cmake.
41-
To build a 32-bit target under 64-bit linux, add `-DCMAKE_CXX_FLAGS="-m32"` to the cmake command.
41+
To build a 32-bit target under 64-bit Linux, add `-DCMAKE_CXX_FLAGS="-m32"` to the cmake command.
4242
In this case, protobuf must be in 32-bit mode too.
4343
+
4444
[source]

0 commit comments

Comments
 (0)