This repository contains an implementation of the algorithms provided in the paper: An Efficient Solution to the 2D Visibility Problem in Cartesian Grid Maps and its Application in Heuristic Path Planning (ICRA2024, arxiv paper).
Provides a linear complexity & highly efficient 2D visibility solution, based on a solution to a linear first-order hyperbolic partial differential equation. The latter is the transport equation, as we define light/visibility as a transportable quantity, and transport it over the grid.
The algorithm functions in a dynamic-programming approach.
For example, a 101x101 grid can be processed at ~55kHz in C++ on an i9-13980HX processor.
Code developed for C++20.
C++ code by default now computes standalone visibility for random environments and plots them using SFML using two methods: proposed and raycasting.
Benchmarks show that proposed method runs ~80 times faster than raycasting for an empty
We provide a commented MATLAB implementation of all the demonstrations provided in the paper.
- The environments can be randomized by uncommeting the loaded seed, but we provide the seeds that we used for reproducibility purposes (rnd_1.mat rnd_2.mat).
- a_quiver_plots.m plots the components a(x,y) and b(x,y) that govern the solution behaviour of the partial differential equation (lines-of-sight vs curves-of-sight are illustrated in the paper).
- b_visibility_shapes.m plots the visibility polygon provided in the paper (environment can be randomized also).
- c_sample_planner_solving_random_environments.m solves a path planning problem using the visibility heuristic path planner solution and plots the results.
- d_sample_planner_solving_maze same as 3- but loads maze images and solves them.
- e_used_for_video_submission.m self-explanatory.
- f_comparison_to_a_star.m used to get the comparison results against astar.
- test_environment_generator.m standalone, tests generating random environments with given settings making sure that start and end positions are not inside obstacles
We provide a C++ implementation that is interfaced with MATLAB too.
How to use the C++ code:
The C++ code has a parser that parses settings from settings.config file, and can work in two modes. In the first mode, a random environment with a given grid size is generated containing a specific number of obstacles that have given dimensions (all loaded via settings.config). The start and end points can also be specified as well as some other settings.
In the second mode, the C++ code uses SFML to load an image representing the environment (mazes in this case). The directory of the image is set in the settings.config also as well as start and end point positions.
In both modes, the solver outputs .txt files which are loaded by MATLAB and plotted as meshes for viewing purposes. The MATLAB interface uses the solution lightSource_enum to also plots lines to visualize the path. lightSource_enum essentially stores the parent of every explored point in the grid, meaning we can retract the solution with it.
Important notes before using:
- In the load image mode, the dimensions of the image may be flipped so double check when setting start and end positions.
- For both modes, make sure to set equal start and end points in both the MATLAB interface and in settings.config. In MATLAB, the values have to be incremented by 1 to match the C++ code.
- Instead, you can try to parse settings.config also in MATLAB.
- Set the correct image path in settings.config.
To interface with MATLAB, the code interface.m calls visibility_heuristic_planner.exe using visibility_heuristic_planner.bat, where the components of the .bat file are:
set path=%path:C:\Program Files\MATLAB\R2022b\bin\win64;=%
visibility_heuristic_planner.exe
Make sure to change the path for your MATLAB installation directory inside the .bat (and use the proper version).
The code then reads the results and plots them nicely.
Mode=2 reads an image map, the path of which is specified in imagePath in settings.config, for example lab_image_edited.png (893x646) in the folder images.
Bottom left corner is the origin.
This is relevant for selecting start/end points. This standard can ofcourse be changed.
Required:
cmake and g++:
sudo apt install cmake
sudo apt install g++
libsfml-dev:
sudo apt-get install libsfml-dev
Set compiler path (or comment that part), make sure SFML libraries are installed, then:
mkdir build && cd build
cmake ..
make
We provide tasks.json, c_cpp_properties.json, and launch.json for building and launching the code in Visual Studio Code.
Make sure to change the compiler path in tasks.json for both debug and release modes:
"command": "C:\\Workdir\\Programs\\msys64\\mingw64\\bin\\g++.exe"
The tasks.json automatically links the SFML libraries with the argument "-lsfml-graphics".
For debug purposes, change "miDebuggerPath": "C:\Workdir\Programs\msys64\mingw64\bin\gdb.exe" path as well in launch.json.
Dependencies:
If you are using Visual Studio Code and MSYS2:
Install SFML in MSYS2 using:
pacman -S mingw-w64-x86_64-sfml
We provide CMakeLists.txt for easy building and compilation too. Install CMake Tools extension on VSCode and configure the kit and the generator.
We used:
pacman -S mingw-w64-x86_64-cmake
Make sure cmake is working using cmake --version, a reload may be necessary
Set the cmakePath accordingly in settings.json:
"cmake.cmakePath": "C:\\Workdir\\Programs\\msys64\\mingw64\\bin\\cmake.exe",