Skip to content

Commit 6ae2ed5

Browse files
committed
Reorder sensor view configuration, fix single quotes.
Signed-off-by: Pierre R. Mai <pmai@pmsf.de>
1 parent 55d760a commit 6ae2ed5

File tree

3 files changed

+32
-17
lines changed

3 files changed

+32
-17
lines changed

doc/architecture/sensor_view.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ 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

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

3+
The sensor view is flexibly defined to support different kinds of sensor models with appropriate input.
4+
The sensor view configuration defines the configuration of a particular sensor view.
5+
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.
8+
39
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.
411

5-
There are two sources for sensor-view-configuration data:
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.
614

7-
1. Sensor-view-configuration data may be provided by the environment simulation.
8-
+
9-
NOTE: The data is intended for the automatic configuration of an environment simulation. Sensor-view-configuration data is not intended to provide parameters to a sensor model.
15+
During the initialization phase, there are two sources for sensor-view-configuration data:
1016

11-
2. Sensor-view-configuration data may be provided by the sensor model to the environment simulation.
17+
1. Sensor-view-configuration data may be provided by the sensor model to the environment simulation.
1218
+
1319
In this case, the data describes the input configuration that is requested by the sensor model.
14-
In response, the environment simulation configures the input and provides a new message that describes the actual configuration.
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.
21+
22+
2. Sensor-view-configuration data may be provided by the environment simulation.
23+
+
24+
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.
1525
16-
The message describing the configuration requested by the sensor model differs from the message describing the configuration provided by the environment simulation.
1726
The configuration requested by the sensor model may differ from the configuration provided by the environment simulation.
18-
This happens when the environment simulation does not support a requested configuration or when the requested configuration is ambiguous.
27+
This happens when the environment simulation does not support a requested configuration or when the requested configuration is ambiguous.
28+
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+
31+
The specifics of the auto negotiation mechanism are specified in the packaging layer.
32+
33+
After the initialization phase the environment simulation will provide the actual sensor view configuration also as part of each sensor view message.

doc/usecases/transforming_coordinate_systems.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,34 @@
22

33
== Vehicle and Sensor Coordinate Systems
44

5-
Transforming coordinates from the world coordinate system for a specific vehicle and its sensors is a common task when running simulations.
5+
Transforming coordinates from the world coordinate system for a specific vehicle and its sensors is frequently needed when running simulations.
66

7-
This section provides an overview of the involved messages, fields and their relationship for this task.
8-
It demonstrates how world coordinate system, vehicle coordinate system, and sensor coordinate system are related for a specific (ego-)vehicle.
7+
This section provides an overview of the involved messages and fields and their relationship for this task.
8+
It demonstrates how world coordinate system, vehicle coordinate system, and sensor coordinate system are related given a specific (ego-)vehicle.
99

1010
//TODO: Should we add one or more sentences about the mathematical operations involved?
1111

1212
**Corresponding messages**
1313

1414
``GroundTruth::moving_object::base::position``::
15-
Defines the position of the vehicles reference point in world coordinates.
15+
This field defines the position of the vehicle's reference point in world coordinates.
1616
In Open Simulation Interface, the position of an object is defined by the coordinates of the center of the object's bounding box.
1717

1818
``GroundTruth::moving_object::base::orientation``::
19-
Defines the orientation of the vehicles reference point in world coordinates.
19+
This field defines the orientation of the vehicle's reference point in world coordinates.
2020

2121
``GroundTruth::moving_object::vehicle_attributes::bbcenter_to_rear``::
22-
The vector pointing from the vehicles reference point to the middle of the rear axle under neutral load conditions in vehicle coordinates.
22+
This field specifies the vector pointing from the vehicle's reference point to the middle of the rear axle under neutral load conditions in vehicle coordinates.
2323

2424
``SensorData::mounting_position``::
25-
Defines the sensors position and orientation and thereby the origin of the sensor coordinate system.
25+
This field defines the sensor's position and orientation and, thereby, the origin of the sensor coordinate system.
2626
The mounting position is given in the vehicle coordinate system.
2727

2828
**Example**
2929

3030
The following image shows the relationship between the coordinate systems.
3131
The reference point of the vehicle is given by a vector in the world coordinate system.
3232
A vector pointing from the reference position of the vehicle to the center of the rear axle then yields the origin of the vehicle coordinate system.
33-
The mounting positions of the sensors and therefore the origins of the corresponding sensor coordinate systems are then given with respect to the vehicle coordinate system.
33+
The mounting positions of the sensors and, therefore, the origins of the corresponding sensor coordinate systems are given with respect to the vehicle coordinate system.
3434

3535
image::{images_open_simulation_interface}/osi_example_coordinate_systems.png[]

0 commit comments

Comments
 (0)