Skip to content
This repository has been archived by the owner on Jan 21, 2022. It is now read-only.

Latest commit

 

History

History
68 lines (45 loc) · 3.74 KB

README.md

File metadata and controls

68 lines (45 loc) · 3.74 KB

osi-visualizer

Visualization tool for OSI messages. This software serves as visualization tool for the current implementation of the OSI (Open Simulation Interface) mesages.The osi-visualizer supports to visualize the OSI GroundTruth and SensorData messages. It supports two independent visual channels with two different input types (file and network stream).

General Information

Some software library dependencies are needed to run the osi-visualizer:

The required version of Open Simulation Interface (https://github.com/OpenSimulationInterface/open-simulation-interface.git) is referenced as a git submodule, so be sure to run git submodule init && git submodule update after cloning the osi-visualizer repository.

If the CMake build process does not automatically locate the required libraries, please use the usual CMake options to set the relevant CMake variables to the proper paths.

Currently we strongly recommend users to use the osi-visualizer under Ubuntu Linux 16.04 LTS. You can see a working development environment based on Ubuntu 16.04 LTS in the Dockerfile in the repository.

Build

From Terminal:

  • cd ${SRC_DIRECTORY}
  • mkdir build
  • cd build
  • cmake ..
  • make
  • cp osi-visualizer ..
  • cd ..
  • ./osi-visualizer

From QtCreator:

Open New Project -> CMakeLists.txt

Usage

Connection:

The channel receives osi message from the network with specific IP address, Port number and data type.

Playback:

The channel receives osi message from the loaded file. The tool will check a header file of same name with a extension: .txth. If it doesn't exist, the tool will create one automatically for the first time. A "Delta-Delay" variable can be set to slow down the playback speed in case of very large message files. By default this value is "0" ms.

Example: set it to 10 ms, each message will have 10 ms more delay for playing.

Besides the tool provides sending out osi message to network with specific port number.

Save OSI Message:

Log or cut out part of the osi message stream. Current the threshold is 100 osi messages. It can be saved to another osi file.

Menu options

File Menu:

"Play" -> play/pause Channel 1;

"Python Compare" -> A standalone compare tool to compare two osi message file directly. By default, it takes the playback file from these two channels. It supports flexible selecting random file as well. Just put the python scripts into folder: ./Resources/Python/ before start this tool. Then all the scripts will be shown up in the "Python Scripts" select menu. The compare script should take the two osi files' full path as arguments. The compare result can be exported to a text file by clicking the "Export" button.

View Menu:

"Combine Channels" -> Config two channels' "Play/Pause' button act simultaneously, or not. It can only be checked when the channels are at the same status: both "Play" or "Pause". By default, it is unchecked.

"Show Grid" -> Show up the grid in the canvas. By default, it is checked.

"Show Object details" -> Select object from the Objects Overview tree. Show up the selected object's position, velocity and acceleration in another independent dialog. By default, it is checked.

The others are self-explaining.

Notice

When playing large osi files, try to adapt the Delta Delay. Then the tool renders smoothly.