Skip to content

Commit e311050

Browse files
committed
fix(docs): linguistic review (#549)
Signed-off-by: Patrick Schedlbauer <patrick.schedlbauer@parson-europe.com>
1 parent 6ae2ed5 commit e311050

File tree

5 files changed

+8
-7
lines changed

5 files changed

+8
-7
lines changed

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 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.
3+
Ground-truth messages describe the simulated environment containing all simulated objects in the global coordinate system at consecutive time instances.
4+
It is based on data available to the simulation environment.
5+
Typically, ground-truth messages are contained in sensor view messages.

doc/architecture/reference_points_coordinate_systems.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,5 @@ The origin is the mounting position of the physical sensor or a virtual mounting
1616

1717
Object coordinate system::
1818
Local object coordinate system.
19-
The origin of the corresponding coordinate systems is not necessarily identical to the center of the object's bounding box.
19+
The origin of the corresponding coordinate system is not necessarily identical to the center of the object's bounding box.
20+
If the origin of the corresponding coordinate system is not identical to the center of the object's bounding box, the object documentation will provide the actual definition.

doc/releases/versioning.adoc

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

3-
The version number is defined in `InterfaceVersion::version_number` in `osi_version.proto` as the fields default value.
3+
The version number is defined in `InterfaceVersion::version_number` in `osi_version.proto` as the field's default value.
44

55
OSI uses https://semver.org/[Semantic Versioning].
66

doc/usecases/modeling_traffic_participant.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The following figure shows a very simple use case.
1414
image::{images_open_simulation_interface}/osi-traffic-participant-use-case-1.png[1100]
1515

1616
The traffic participant bases its behavior only on an idealized view of the area around it.
17-
If they exist, the traffic participants dynamics are included in the model.
17+
If they exist, the traffic participant's dynamics are included in the model.
1818

1919
The following figure shows a traffic participant with separately modeled behavior and dynamics.
2020

doc/usecases/transforming_coordinate_systems.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ It demonstrates how world coordinate system, vehicle coordinate system, and sens
1313

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

1818
``GroundTruth::moving_object::base::orientation``::
1919
This field defines the orientation of the vehicle's reference point in world coordinates.

0 commit comments

Comments
 (0)