From 3b290dcbccde905ef6470d034b35c3f75d4c178c Mon Sep 17 00:00:00 2001 From: Maximilian Rosin Date: Thu, 3 Jun 2021 16:28:13 +0200 Subject: [PATCH] Describe using OSI visualizer (#62) Signed-off-by: Maximilian Rosin --- .../{Connection.png => connection.png} | Bin doc/_images/{Demo.png => demo.png} | Bin .../{FieldOfView.png => field_of_view.png} | Bin doc/_images/{PlayBack.png => playback.png} | Bin ...aveOSIMessage.png => save_osi_message.png} | Bin doc/osi-visualizer_user_guide.adoc | 3 +- doc/use/comparing_messages.adoc | 21 ++++--- doc/use/configuring_view.adoc | 18 +++--- doc/use/playing_large_files.adoc | 11 ---- doc/use/playing_messages.adoc | 39 +++++++++--- doc/use/receiving_network.adoc | 30 ++++++--- doc/use/running_visualizer.adoc | 33 ++++++---- doc/use/running_visualizer_docker.adoc | 58 ++++++++++++++---- doc/use/saving_messages.adoc | 28 ++++++--- doc/use/showing_field_of_view.adoc | 29 ++++++--- 15 files changed, 181 insertions(+), 89 deletions(-) rename doc/_images/{Connection.png => connection.png} (100%) rename doc/_images/{Demo.png => demo.png} (100%) rename doc/_images/{FieldOfView.png => field_of_view.png} (100%) rename doc/_images/{PlayBack.png => playback.png} (100%) rename doc/_images/{SaveOSIMessage.png => save_osi_message.png} (100%) delete mode 100644 doc/use/playing_large_files.adoc diff --git a/doc/_images/Connection.png b/doc/_images/connection.png similarity index 100% rename from doc/_images/Connection.png rename to doc/_images/connection.png diff --git a/doc/_images/Demo.png b/doc/_images/demo.png similarity index 100% rename from doc/_images/Demo.png rename to doc/_images/demo.png diff --git a/doc/_images/FieldOfView.png b/doc/_images/field_of_view.png similarity index 100% rename from doc/_images/FieldOfView.png rename to doc/_images/field_of_view.png diff --git a/doc/_images/PlayBack.png b/doc/_images/playback.png similarity index 100% rename from doc/_images/PlayBack.png rename to doc/_images/playback.png diff --git a/doc/_images/SaveOSIMessage.png b/doc/_images/save_osi_message.png similarity index 100% rename from doc/_images/SaveOSIMessage.png rename to doc/_images/save_osi_message.png diff --git a/doc/osi-visualizer_user_guide.adoc b/doc/osi-visualizer_user_guide.adoc index 769acc5..197285c 100644 --- a/doc/osi-visualizer_user_guide.adoc +++ b/doc/osi-visualizer_user_guide.adoc @@ -7,6 +7,7 @@ :topicdir: topics :reusedir: reuse +:imagesdir: _images // header & footer for html // html themes @@ -49,5 +50,3 @@ include::./use/saving_messages.adoc[leveloffset=+2] include::./use/comparing_messages.adoc[leveloffset=+2] include::./use/configuring_view.adoc[leveloffset=+2] - -include::./use/playing_large_files.adoc[leveloffset=+2] diff --git a/doc/use/comparing_messages.adoc b/doc/use/comparing_messages.adoc index 1ac04a5..fc6f8e6 100644 --- a/doc/use/comparing_messages.adoc +++ b/doc/use/comparing_messages.adoc @@ -1,11 +1,14 @@ = Comparing OSI message files -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -Et malesuada fames ac turpis egestas. -Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi. -Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis. -Sed augue lacus viverra vitae congue eu. -Velit ut tortor pretium viverra suspendisse. -Amet commodo nulla facilisi nullam vehicula ipsum a. -Nibh nisl condimentum id venenatis a. -Diam vel quam elementum pulvinar etiam non quam lacus suspendisse. \ No newline at end of file +OSI Visualizer comprises a standalone tool to compare two OSI trace files. + +**Prerequisites** + +* OSI Visualizer is running. + +**Steps** + +. Open the **File** menu. +. Select **Python Compare**. +. Enter the full paths to the two OSI trace files. +. To export the result, click **Compare**. diff --git a/doc/use/configuring_view.adoc b/doc/use/configuring_view.adoc index 46376d4..1953bfe 100644 --- a/doc/use/configuring_view.adoc +++ b/doc/use/configuring_view.adoc @@ -1,11 +1,11 @@ = Configuring the view -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -Et malesuada fames ac turpis egestas. -Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi. -Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis. -Sed augue lacus viverra vitae congue eu. -Velit ut tortor pretium viverra suspendisse. -Amet commodo nulla facilisi nullam vehicula ipsum a. -Nibh nisl condimentum id venenatis a. -Diam vel quam elementum pulvinar etiam non quam lacus suspendisse. \ No newline at end of file +You can configure the view of the OSI Visualizer in the **View** menu + +**Prerequisites** + +**Steps** + +* Activate **Combine Channels** to play both channels simultaneously. +* Activate **Show Grid** to show the grid in the canvas. +* Activate **Show Object** details to display the position, velocity and acceleration of an object selected in the **Objecs Overview** tree \ No newline at end of file diff --git a/doc/use/playing_large_files.adoc b/doc/use/playing_large_files.adoc deleted file mode 100644 index 770603f..0000000 --- a/doc/use/playing_large_files.adoc +++ /dev/null @@ -1,11 +0,0 @@ -= Playing back large OSI files - -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -Et malesuada fames ac turpis egestas. -Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi. -Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis. -Sed augue lacus viverra vitae congue eu. -Velit ut tortor pretium viverra suspendisse. -Amet commodo nulla facilisi nullam vehicula ipsum a. -Nibh nisl condimentum id venenatis a. -Diam vel quam elementum pulvinar etiam non quam lacus suspendisse. \ No newline at end of file diff --git a/doc/use/playing_messages.adoc b/doc/use/playing_messages.adoc index 13463a9..6596857 100644 --- a/doc/use/playing_messages.adoc +++ b/doc/use/playing_messages.adoc @@ -1,11 +1,32 @@ = Playing back messages from a trace file -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -Et malesuada fames ac turpis egestas. -Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi. -Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis. -Sed augue lacus viverra vitae congue eu. -Velit ut tortor pretium viverra suspendisse. -Amet commodo nulla facilisi nullam vehicula ipsum a. -Nibh nisl condimentum id venenatis a. -Diam vel quam elementum pulvinar etiam non quam lacus suspendisse. \ No newline at end of file +OSI Visualizer can visualize the content of an OSI trace file. + +[[image-playback]] +image::playback.png[title = "Playback section in the configuration panel."] + +**Prerequisites** + +OSI Visualizer is running. + +**Steps** + +. In the configuration panel of the channel, select **Playback**. +. From the **ZMQ** drop-down list, select the ZMQ pattern you want to use. +. In the **Load** field, select the OSI trace file. +. From the **Data** drop-down list, select the ZMQ pattern you want to use. +. In the **Delay** field, enter the delta-delay in milliseconds. + The delta-delay slows down the playback speed by delaying each message by the given value. +. If you want to publish the messages to localhost, select **Send to Port** and enter the port number you want to send OSI messages to. +. If you want to add a FMU, check the **FMU** box and select the appropriate FMU file. +. Once you have configured the channel correctly, press the **Play** button to start the playback. + +**Result** + +The channel is playing back the OSI trace file. +If **Send to Port** is enabled, the messages are sent to localhost at the given port. + +**Troubleshooting** + +When playing back large trace files, the visualization may not render smoothly. +In this case, increase the delta-delay. \ No newline at end of file diff --git a/doc/use/receiving_network.adoc b/doc/use/receiving_network.adoc index 522ce40..6c2e820 100644 --- a/doc/use/receiving_network.adoc +++ b/doc/use/receiving_network.adoc @@ -1,11 +1,23 @@ = Receiving OSI messages from a network -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -Et malesuada fames ac turpis egestas. -Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi. -Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis. -Sed augue lacus viverra vitae congue eu. -Velit ut tortor pretium viverra suspendisse. -Amet commodo nulla facilisi nullam vehicula ipsum a. -Nibh nisl condimentum id venenatis a. -Diam vel quam elementum pulvinar etiam non quam lacus suspendisse. \ No newline at end of file +OSI Visualizer can visualize OSI messages received over a network. + +[[image-connection]] +image::connection.png[title = "Connection section in the configuration panel."] + +**Prerequisites** + +OSI Visualizer is running. + +**Steps** + +. In the configuration panel of the channel, select **Connection**. +. In the **IP** field, enter the IP adress of the network. +. In the **Port** field, enter the port number you want to receive OSI messages at. +. From the **ZMQ** drop-down list, select the ZMQ pattern you want to use. +. If you want to add a FMU, check the **FMU** box and select the appropriate FMU file. +. From the **Data** drop-down list, select the ZMQ pattern you want to use. + +**Result** + +The channel is set up for receiving OSI messages over the network. diff --git a/doc/use/running_visualizer.adoc b/doc/use/running_visualizer.adoc index 6a289ee..5bc72ad 100644 --- a/doc/use/running_visualizer.adoc +++ b/doc/use/running_visualizer.adoc @@ -1,11 +1,22 @@ -= Running OSI visualizer - -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -Et malesuada fames ac turpis egestas. -Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi. -Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis. -Sed augue lacus viverra vitae congue eu. -Velit ut tortor pretium viverra suspendisse. -Amet commodo nulla facilisi nullam vehicula ipsum a. -Nibh nisl condimentum id venenatis a. -Diam vel quam elementum pulvinar etiam non quam lacus suspendisse. \ No newline at end of file += Running OSI Visualizer + +OSI Visualizer is started via the command line. + +**Prerequisites** + +You have built OSI Visualizer. + +**Steps** + +. Open a command line interpreter. +. Change to the OSI Visualizer repository. +. Run the following command to start OSI Visualizer. ++ +[source] +---- +./build/osi-visualizer +---- + +**Results** + +OSI Visualizer is running. diff --git a/doc/use/running_visualizer_docker.adoc b/doc/use/running_visualizer_docker.adoc index a3cffe0..4ba56e3 100644 --- a/doc/use/running_visualizer_docker.adoc +++ b/doc/use/running_visualizer_docker.adoc @@ -1,11 +1,47 @@ -= Running OSI visualizer using Docker - -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -Et malesuada fames ac turpis egestas. -Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi. -Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis. -Sed augue lacus viverra vitae congue eu. -Velit ut tortor pretium viverra suspendisse. -Amet commodo nulla facilisi nullam vehicula ipsum a. -Nibh nisl condimentum id venenatis a. -Diam vel quam elementum pulvinar etiam non quam lacus suspendisse. \ No newline at end of file += Running OSI Visualizer using Docker + +Using Docker enables running OSI Visualizer on non-Linux plattforms. + +**Prerequisites** + +You have built OSI Visualizer Docker image. + +**Steps** + +. Open a command line interpreter. +. Change to the OSI Visualizer repository. +. Run the following command to start OSI Visualizer. ++ +[source] +---- +sh run-nvidia-docker.sh +---- ++ +. Place Protobuffer files in `osi_pb/` to make them available to OSI Visualizer. + This directory is mounted as a volume to the Docker image. + +**Results** + +OSI Visualizer is running. +The Protobuffer files are available to OSI Visualizer + +**Troubleshooting** + +Currently OSI Visualizer is set up and tested to work with the playback option. +For using other functionalities, for example socket communication, you may need to change the Docker file. +After running the image, the following error may appear: + +[source] +---- +Creating network “osi-visualizer_default” with the default driver +No protocol specified QXcbConnection: Could not connect to display:1 +---- + +If this error message appears, add the following command to the end of the Docker file and run the image again: + +[source] +---- +sudo xhost + +---- + +You do not have to build the Docker image again. \ No newline at end of file diff --git a/doc/use/saving_messages.adoc b/doc/use/saving_messages.adoc index 1d5278f..cbb0d0c 100644 --- a/doc/use/saving_messages.adoc +++ b/doc/use/saving_messages.adoc @@ -1,11 +1,21 @@ = Saving OSI messages -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -Et malesuada fames ac turpis egestas. -Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi. -Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis. -Sed augue lacus viverra vitae congue eu. -Velit ut tortor pretium viverra suspendisse. -Amet commodo nulla facilisi nullam vehicula ipsum a. -Nibh nisl condimentum id venenatis a. -Diam vel quam elementum pulvinar etiam non quam lacus suspendisse. \ No newline at end of file +OSI Visualizer can log an OSI message stream and save it to a file. +By default, OSI Visualizer saves up to 1.000.000 messages. +can change this threshold via `osiMsgSaveThreshold_` in `appconfig.cpp`. + +[[image-save_osi_message]] +image::save_osi_message.png[title = "Save OSI message button."] + +**Prerequisites** + +* OSI Visualizer is running. +* OSI Visualizer is playing messages. + +**Steps** + +Click **Save OSI Message**. + +**Result** + +The channel is set up for playing back OSI trace files. \ No newline at end of file diff --git a/doc/use/showing_field_of_view.adoc b/doc/use/showing_field_of_view.adoc index 44423af..b1c9d59 100644 --- a/doc/use/showing_field_of_view.adoc +++ b/doc/use/showing_field_of_view.adoc @@ -1,11 +1,22 @@ = Showing the field of view of a sensor -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -Et malesuada fames ac turpis egestas. -Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi. -Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis. -Sed augue lacus viverra vitae congue eu. -Velit ut tortor pretium viverra suspendisse. -Amet commodo nulla facilisi nullam vehicula ipsum a. -Nibh nisl condimentum id venenatis a. -Diam vel quam elementum pulvinar etiam non quam lacus suspendisse. \ No newline at end of file +OSI Visualizer can visualize the field of view of sensors. + +[[image-field_of_view]] +image::field_of_view.png[title = "Save OSI message button."] + +**Prerequisites** + +* OSI Visualizer is running. + +**Steps** + +. In the configuration panel, select **Show Field of View**. +. In the **MinR** field, enter the minimum range in meter. +. In the **MaxR** field, enter the maximum range in meter. +. In the **AP** field, enter the azimuth positive angle in degree. +. In the **AN** field, enter the azimuth negative angle in degree. + +**Result** + +The field of view is displayed on the grid. \ No newline at end of file