Skip to content

Commit 25d8fdb

Browse files
max-rosinmax-rosin
committed
fix(docs): Resolve merge conflict (#510, #516)
Signed-off-by: Maximilian Rosin <maximilian.rosin@parson-europe.com>
1 parent 29cdc38 commit 25d8fdb

14 files changed

+257
-82
lines changed

‎doc/architecture/feature_data.adoc‎

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

3-
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4-
Et malesuada fames ac turpis egestas.
5-
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6-
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7-
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8-
Amet commodo nulla facilisi nullam vehicula ipsum a.
9-
Nibh nisl condimentum id venenatis a.
10-
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.
3+
Feature data contains detected features in the reference frame of a sensor.
4+
Feature data is generated from ground-truth data.
5+
It serves, for example, as input for sensor models simulating object detection or feature fusion models.

‎doc/architecture/ground_truth.adoc‎

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

3-
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4-
Et malesuada fames ac turpis egestas.
5-
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6-
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7-
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8-
Amet commodo nulla facilisi nullam vehicula ipsum a.
9-
Nibh nisl condimentum id venenatis a.
10-
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.
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.

‎doc/architecture/sensor_data.adoc‎

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

3-
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4-
Et malesuada fames ac turpis egestas.
5-
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6-
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7-
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8-
Amet commodo nulla facilisi nullam vehicula ipsum a. Nibh nisl condimentum id venenatis a.
9-
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.
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.
5+
Except feature data, all information regarding the environment is given with respect to the virtual sensor coordinate system.
6+
Feature data is given with respect to the physical sensor coordinate system.
7+
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_view.adoc‎

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

3-
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4-
Et malesuada fames ac turpis egestas.
5-
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6-
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7-
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8-
Amet commodo nulla facilisi nullam vehicula ipsum a. Nibh nisl condimentum id venenatis a.
9-
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.
3+
Sensor view imitates the input of sensors.
4+
Sensor-view data is derived from ground-truth data.
5+
All information regarding the environment is given with respect to the virtual sensor coordinate system, with two exceptions:
6+
7+
* 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.

‎doc/architecture/sensor_view_configuration.adoc‎

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

3-
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4-
Et malesuada fames ac turpis egestas.
5-
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6-
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7-
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8-
Amet commodo nulla facilisi nullam vehicula ipsum a. Nibh nisl condimentum id venenatis a.
9-
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.
3+
The sensor view configuration configures the sensor view.
4+
There are two sources for sensor-view-configuration data.
5+
6+
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.
8+
Sensor-view-configuration data is not intended to provide parameters to a generic sensor model.
9+
10+
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.
12+
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.

‎doc/architecture/traffic_command.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
= Traffic command
2+
3+
Traffic commands contain control commands from the scenario engine to traffic participant models.

‎doc/architecture/traffic_update.adoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
= Traffic update
2+
3+
Traffic updates are provided by traffic participants.
4+
They provide updates of the position, state and future trajectory of a traffic participant back to the simulation environment.

‎doc/open-simulation-interface_user_guide.adoc‎

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= Open simulation interface
2-
:revnumber: v.v.v
2+
:revnumber: v.v.v
33
:revdate: dd.mm.yyyy
4-
:toc: left
4+
:toc: left
55
:toclevels: 2
66
:sectnums:
77

@@ -15,11 +15,11 @@
1515
// source highlighting
1616
:source-highlighter: rouge
1717
:rouge-style: base16.solarized.light
18-
//
18+
//
1919
// :nofooter:
2020
:last-update-label!:
2121
//embed images into html
22-
:data-uri:
22+
:data-uri:
2323
:mathematical-format: svg
2424
:imagesoutdir: ../images/generated_images
2525

@@ -41,6 +41,10 @@ include::./architecture/sensor_view_configuration.adoc[leveloffset=+3]
4141

4242
include::./architecture/sensor_data.adoc[leveloffset=+3]
4343

44+
include::./architecture/traffic_command.adoc[leveloffset=+3]
45+
46+
include::./architecture/traffic_update.adoc[leveloffset=+3]
47+
4448
=== Model types
4549

4650
include::./architecture/environmental_effect_model.adoc[leveloffset=+3]
@@ -59,59 +63,63 @@ include::./architecture/reference_points_coordinate_systems.adoc[leveloffset=+3]
5963

6064
include::./usecases/transforming_coordinate_systems.adoc[leveloffset=+3]
6165

62-
=== Layering
66+
//=== Layering
6367

64-
include::./architecture/data_layer.adoc[leveloffset=+3]
68+
//include::./architecture/data_layer.adoc[leveloffset=+3]
6569

66-
include::./architecture/packaging_layer.adoc[leveloffset=+3]
70+
//include::./architecture/packaging_layer.adoc[leveloffset=+3]
6771

6872
=== OSI trace files
6973

7074
include::./architecture/trace_file_formats.adoc[leveloffset=+3]
7175

7276
include::./architecture/trace_file_naming.adoc[leveloffset=+3]
7377

74-
=== Files and scripts
78+
// === Files and scripts
7579

76-
include::./architecture/proto-files.adoc[leveloffset=+3]
80+
// include::./architecture/proto-files.adoc[leveloffset=+3]
7781

78-
include::./architecture/test_scripts.adoc[leveloffset=+3]
82+
// include::./architecture/test_scripts.adoc[leveloffset=+3]
7983

8084
include::./architecture/formatting_scripts.adoc[leveloffset=+3]
8185

8286
== Setting up OSI
8387

84-
include::./setup/installing_linux.adoc[leveloffset=+2]
88+
include::./setup/installing_linux_cpp.adoc[leveloffset=+2]
8589

86-
include::./setup/installing_macos.adoc[leveloffset=+2]
90+
include::./setup/installing_linux_python.adoc[leveloffset=+2]
8791

88-
include::./setup/installing_windows.adoc[leveloffset=+2]
92+
include::./setup/installing_windows_cpp.adoc[leveloffset=+2]
93+
94+
include::./setup/installing_windows_python.adoc[leveloffset=+2]
95+
96+
include::./setup/installing_macos.adoc[leveloffset=+2]
8997

90-
include::./setup/using_osi_support_tools.adoc[leveloffset=+2]
98+
//include::./setup/using_osi_support_tools.adoc[leveloffset=+2]
9199

92-
include::./setup/including_osi_dev_projects.adoc[leveloffset=+2]
100+
//include::./setup/including_osi_dev_projects.adoc[leveloffset=+2]
93101

94-
== Example use cases for OSI
102+
//== Example use cases for OSI
95103

96-
include::./usecases/modeling_lidar_sensor.adoc[leveloffset=+2]
104+
//include::./usecases/modeling_lidar_sensor.adoc[leveloffset=+2]
97105

98-
include::./usecases/modeling_camera_electronics.adoc[leveloffset=+2]
106+
//include::./usecases/modeling_camera_electronics.adoc[leveloffset=+2]
99107

100-
include::./usecases/injecting_faults.adoc[leveloffset=+2]
108+
//include::./usecases/injecting_faults.adoc[leveloffset=+2]
101109

102-
include::./usecases/fusing_sensor_outputs.adoc[leveloffset=+2]
110+
//include::./usecases/fusing_sensor_outputs.adoc[leveloffset=+2]
103111

104-
include::./usecases/modeling_traffic_participant.adoc[leveloffset=+2]
112+
//include::./usecases/modeling_traffic_participant.adoc[leveloffset=+2]
105113

106-
include::./usecases/benchmark_integration_gpu_radar.adoc[leveloffset=+2]
114+
//include::./usecases/benchmark_integration_gpu_radar.adoc[leveloffset=+2]
107115

108-
include::./usecases/generating_osi_traces.adoc[leveloffset=+2]
116+
//include::./usecases/generating_osi_traces.adoc[leveloffset=+2]
109117

110118
//include::./usecases/transforming_coordinate_systems.adoc[leveloffset=+2]
111119

112120
== Improving performance
113121

114-
TODO: Define topics and issues regarding performance.
122+
//TODO: Define topics and issues regarding performance.
115123

116124
include::./misc/osi_reference.adoc[leveloffset=+1]
117125

‎doc/setup/installing_linux.adoc‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎doc/setup/installing_linux_cpp.adoc‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
= Installing OSI for C++ on Linux
2+
3+
**Prerequisites**
4+
5+
* You have _cmake_ installed.
6+
* You have installed _protobuf_.
7+
* You must have super user privileges.
8+
9+
**Steps**
10+
11+
. Open a terminal.
12+
. Clone the Open Simulation repository.
13+
+
14+
[source]
15+
----
16+
git clone https://github.com/OpenSimulationInterface/open-simulation-interface.git
17+
----
18+
+
19+
. Change into the repository directory.
20+
+
21+
[source]
22+
----
23+
cd open-simulation-interface
24+
----
25+
+
26+
. Create a new directory for the build.
27+
+
28+
[source]
29+
----
30+
mkdir build
31+
----
32+
+
33+
. Change into the new directory.
34+
+
35+
[source]
36+
----
37+
cd build
38+
----
39+
+
40+
. Run cmake.
41+
To build a 32-bit target under 64-bit linux, add `-DCMAKE_CXX_FLAGS="-m32"` to the cmake command.
42+
In this case, protobuf must be in 32-bit mode too.
43+
+
44+
[source]
45+
----
46+
cmake ..
47+
----
48+
+
49+
. Run make.
50+
+
51+
[source]
52+
----
53+
make
54+
----
55+
+
56+
. Install Open Simulation Interface.
57+
+
58+
[source]
59+
----
60+
sudo make install
61+
----

0 commit comments

Comments
 (0)