Skip to content

Fix documentation on FeatureData messages #792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 25, 2024
Merged

Fix documentation on FeatureData messages #792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41ceeef
Fix documentation on FeatureData messages
thomassedlmayer Mar 20, 2024
f7b5409
Adjust formatting
pmai Mar 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion doc/architecture/architecture_overview.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ endif::[]
OSI contains an object-based environment description that uses the message format of the https://github.com/protocolbuffers/protobuf/wiki[Protocol Buffer] library.
Google developed and maintains the Protocol Buffer library.
OSI defines top-level messages that are used to exchange data between separate models.
Top-level messages define the `GroundTruth` interface, the `SensorData` interface, and – since OSI version 3.0.0 – the interfaces `SensorView`, `SensorViewConfiguration`, and `FeatureData`.
Top-level messages define the `GroundTruth` interface, the `SensorData` interface, and – since OSI version 3.0.0 – the interfaces `SensorView` and `SensorViewConfiguration`.
Further top-level messages that were added in later versions of OSI are `TrafficCommand`, `TrafficUpdate`, `MotionRequest`, and `StreamingUpdate`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thomassedlmayer Don't we have TrafficCommandUpdate as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The TrafficCommandUpdate is not mentioned anywhere in the documentation. It is even missing in Figure 3 on the architecture overview page. If it is supposed to be a top-level message, this should probably be included with additional documentation.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TrafficParticipant: https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/sensor-model/spec/model_types.html

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for finding that little sentence in the OSMP docs! ;) Didn't expect it there.
To keep it consistent, this message should also have an additional page in section 2.2.2 with proper documentation. It would also make sense to integrate it into Figure 2 and 3.


The following figure shows the interfaces and models involved in modeling a sensor.

Expand Down
9 changes: 0 additions & 9 deletions doc/architecture/feature_data.adoc
View file
Open in desktop

This file was deleted.

4 changes: 4 additions & 0 deletions doc/architecture/sensor_data.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,7 @@ They can be generated from `GroundTruth` messages, `SensorView` messages, `Featu
With the exception of feature data, all information regarding the environment is given with respect to the virtual sensor coordinate system.
Feature data is given with respect to the physical sensor coordinate system.
Sensor data can be used as input for an automated driving function, a sensor model simulating limited perception, or a sensor fusion model.

`SensorData` messages include `FeatureData` messages which contain detected features in the reference frame of a sensor.
`FeatureData` messages are generated from `GroundTruth` messages.
They serve, for example, as an input to sensor models simulating object detection or feature fusion models.
2 changes: 0 additions & 2 deletions doc/open-simulation-interface_user_guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ include::./architecture/architecture_overview.adoc[leveloffset=+2]

include::./architecture/ground_truth.adoc[leveloffset=+3]

include::./architecture/feature_data.adoc[leveloffset=+3]

include::./architecture/sensor_view.adoc[leveloffset=+3]

include::./architecture/sensor_view_configuration.adoc[leveloffset=+3]
Expand Down