Releases: ethz-asl/wavemap
v2.2.1
Summary
This patch enhances the VSCode development container for wavemap, adding features like tab completions and colors in the terminal.
Special thanks to @marcojob for contributing these improvements!
Detailed description
The changes set the container's default shell to bash
and add a .bashrc
file, which was missing.
Package changelogs
The changes only affect the Docker file for the devcontainer.
Upgrade notes
Upgrade instructions for
- C++ Library
- To use wavemap as a standalone CMake project, please see these instructions
- Python Library
- To install wavemap's Python API, please see these instructions
- ROS1
- Catkin
- Go to your catkin workspace src directory:
cd ~/catkin_ws/src
- Pull the newest wavemap code:
cd wavemap && git checkout main && git pull
- Rebuild wavemap:
catkin build wavemap_all
- Go to your catkin workspace src directory:
- Docker
docker build --tag=wavemap_ros1 --build-arg='VERSION=v2.2.1' -<<< $(curl -s https://raw.githubusercontent.com/ethz-asl/wavemap/v2.2.1/tooling/docker/ros1/incremental.Dockerfile)
- Catkin
For more info, see our guides on installing wavemap.
v2.2.0
Summary
This release simplifies interacting with chunked octrees, improves performance, and extends the QueryAccelerator
to support HashedChunkedWaveletOctree
maps.
Detailed description
Release 2.0.0 introduced experimental NodePtr
and NodeRef
classes, enabling traversal of chunked octrees as if they were regular octrees. This PR finalizes their implementation and uses them to simplify map operations and measurement integrators, and extend the QueryAccelerator
to support chunked octrees.
For a detailed summary, list of API changes, and benchmarking results, please see PR #84.
Package changelogs
Libraries
Interfaces
Upgrade notes
Upgrade instructions for
- C++ Library
- To use wavemap as a standalone CMake project, please see these instructions
- Python Library
- To install wavemap's Python API, please see these instructions
- ROS1
- Catkin
- Go to your catkin workspace src directory:
cd ~/catkin_ws/src
- Pull the newest wavemap code:
cd wavemap && git checkout main && git pull
- Rebuild wavemap:
catkin build wavemap_all
- Go to your catkin workspace src directory:
- Docker
docker build --tag=wavemap_ros1 --build-arg='VERSION=v2.2.0' -<<< $(curl -s https://raw.githubusercontent.com/ethz-asl/wavemap/v2.2.0/tooling/docker/ros1/incremental.Dockerfile)
- Catkin
For more info, see our guides on installing wavemap.
v2.1.2
Summary
This patch introduces additional tools to track resource usage and updates the PR template to include benchmarking results, to monitor how the framework evolves.
Detailed description
For a detailed summary, list of API changes, and benchmarking results, please see PR #83.
Package changelogs
Libraries
Interfaces
Upgrade notes
Upgrade instructions for
- C++ Library
- To use wavemap as a standalone CMake project, please see these instructions
- Python Library
- To install wavemap's Python API, please see these instructions
- ROS1
- Catkin
- Go to your catkin workspace src directory:
cd ~/catkin_ws/src
- Pull the newest wavemap code:
cd wavemap && git checkout main && git pull
- Rebuild wavemap:
catkin build wavemap_all
- Go to your catkin workspace src directory:
- Docker
docker build --tag=wavemap_ros1 --build-arg='VERSION=v2.1.2' -<<< $(curl -s https://raw.githubusercontent.com/ethz-asl/wavemap/v2.1.2/tooling/docker/ros1/incremental.Dockerfile)
- Catkin
For more info, see our guides on installing wavemap.
v2.1.1
Summary
This patch adds a py.typed marker file to pywavemap to signal that the package includes type annotations. Additionally, it addresses warnings related to missing includes for STL header files, triggered by the latest cpplint v2.0.0 release.
Special thanks to @Divelix for contributing this release!
Detailed description
Adding the py.typed marker file enables tools like mypy and IDEs such as VSCode to recognize Python package type annotations, for improved error detection and autocompletion. For more information on py.typed files, please refer to PEP 561. We generate this file using nanobind’s CMake interface.
In addition, the cpplint version we were using previously (1.6.1) only performed "include-what-you-use" checks for STL headers up to C++11. The updated version, 2.0.0, now includes broader checks and covers new C++17 STL headers. This release wavemap addresses all new warnings.
Package changelogs
Libraries
Interfaces
Examples
Upgrade notes
Upgrade instructions for
- C++ Library
- To use wavemap as a standalone CMake project, please see these instructions
- Python Library
- To install wavemap's Python API, please see these instructions
- ROS1
- Catkin
- Go to your catkin workspace src directory:
cd ~/catkin_ws/src
- Pull the newest wavemap code:
cd wavemap && git checkout main && git pull
- Rebuild wavemap:
catkin build wavemap_all
- Go to your catkin workspace src directory:
- Docker
docker build --tag=wavemap_ros1 --build-arg="VERSION=v2.1.1" -<<< $(curl -s https://raw.githubusercontent.com/ethz-asl/wavemap/v2.1.1/tooling/docker/ros1/incremental.Dockerfile)
- Catkin
For more info, see our guides on installing wavemap.
v2.1.0
Summary
This release introduces pywavemap, a Python API for the wavemap library.
Detailed description
This PR extends wavemap 2.0 with a full-fledged Python API, enabling the creation, reading, and writing of map files. Users can configure and run modular mapping pipelines directly in Python. The API includes fast, batched map accessors to simplify using wavemap as an input to PyTorch and other machine-learning frameworks. Additionally, the documentation has been extended and the CI pipeline has been rewritten for improved testing and easier future extensions.
Please see #69 for a full description of all the changes.
Package changelogs
Libraries
Examples
Upgrade notes
Upgrade instructions for
- C++ Library
- To use wavemap as a standalone CMake project, please see these instructions
- Python Library
- To install wavemap's Python API, please see these instructions
- ROS1
- Catkin
- Go to your catkin workspace src directory:
cd ~/catkin_ws/src
- Pull the newest wavemap code:
cd wavemap && git checkout main && git pull
- Rebuild wavemap:
catkin build wavemap_all
- Go to your catkin workspace src directory:
- Docker
docker build --tag=wavemap_ros1 --build-arg="VERSION=v2.1.0" -<<< $(curl -s https://raw.githubusercontent.com/ethz-asl/wavemap/v2.1.0/tooling/docker/ros1/incremental.Dockerfile)
- Catkin
For more info, see our guides on installing wavemap.
v2.0.1
Summary
This patch fixes a compilation error when wavemap's ROS server is compiled with optional support for Livox pointclouds.
Detailed description
The error was caused by two type names in the Livox pointcloud callback code not being updated after the refactoring for wavemap 2.0. It didn't show up during testing because the code path only gets compiled if catkin detects that the livox_ros_driver2
package is available.
Fixes #67
Package changelogs
Interfaces
- ROS1
Upgrade notes
Upgrade instructions for
- C++ Library
- For instructions on setting up wavemap as a standalone CMake project, please refer to our docs
- ROS1
- Catkin
- Go to your catkin workspace src directory:
cd ~/catkin_ws/src
- Pull the newest wavemap code:
cd wavemap && git checkout main && git pull
- Rebuild wavemap:
catkin build wavemap_all
- Go to your catkin workspace src directory:
- Docker
docker build --tag=wavemap_ros1 --build-arg="VERSION=v2.0.1" -<<< $(curl -s https://raw.githubusercontent.com/ethz-asl/wavemap/v2.0.1/tooling/docker/ros1/incremental.Dockerfile)
- Catkin
For more info, see our guides on installing wavemap.
v2.0.0
Summary
This release significantly enhances wavemap's generality and functionality. The core library is now a standalone CMake C++ package, enabling its use on non-ROS platforms and paving the way for future integrations, such as a Python API. Other major updates include generic spatial data structures, new path-planning utilities, a plugin system for map operations, and extensions to the documentation.
Detailed description
In terms of functionality, wavemap's spatial data structures can now be used to store arbitrary data types. A wide range of new utilities has been added, with a special focus on path-planning applications. In terms of code, wavemap can now be used as a pure CMake C++ library. In addition to making the framework usable without ROS, this change lays the groundwork for Python bindings and simplifies the development of future interfaces (e.g., ROS2, Zenoh). Other major improvements include a modular system for adding and configuring map operations, similar to plugins. We already include new operations to publish the map in alternative formats (e.g. obstacle pointcloud) and perform local mapping, and expect to add many more in the future.
Please see #66 for a full description of all the changes.
This PR addresses GH issues #25 and #59.
Breaking changes
This release changes the high-level structure of wavemap's configuration files to accommodate new functionalities and improve user-friendliness. Users who created custom configs for a previous wavemap version will have to update these manually. However, no functionalities have been removed.
Package changelogs
Libraries
Interfaces
Examples
Upgrade notes
Upgrade instructions for
- C++ Library
- For instructions on setting up wavemap as a standalone CMake project, see our new docs
- ROS1
- Catkin
- Go to your catkin workspace src directory:
cd ~/catkin_ws/src
- Pull the newest wavemap code:
cd wavemap && git checkout main && git pull
- Remove the old built packages with
catkin clean wavemap_all
, or if that doesn't runcatkin clean -bdi
- Build the new packages:
catkin build wavemap_all
- Go to your catkin workspace src directory:
- Docker
docker build --tag=wavemap_ros1 --build-arg="VERSION=v2.0.0" -<<< $(curl -s https://raw.githubusercontent.com/ethz-asl/wavemap/main/tooling/docker/ros1/incremental.Dockerfile)
- For more info, see the ROS1 installation page
- Catkin
v1.6.3
Summary
This patch fixes a rendering bug in wavemap's Rviz plugin that appears when using the TopDownOrtho ViewController.
Detailed description
Wavemap's Rviz plugin uses Level of Detail (LoD) rendering to improve Rviz's frame rate when displaying large maps. The LoD level for each rendered block is selected based on its distance to the camera, but this does not work when using orthographic projection (TopDownOrtho mode). This patch ensures that the highest LoD level is used in this mode. We plan further optimizations in future development cycles.
Package changelogs
Upgrade notes
Upgrade instructions for
- Catkin
- Go to your catkin workspace src directory:
cd ~/catkin_ws/src
- Pull the newest wavemap code:
cd wavemap && git checkout main && git pull
- Rebuild wavemap:
catkin build wavemap_all
- Go to your catkin workspace src directory:
- Docker
docker build --tag=wavemap --build-arg="VERSION=v1.6.3" - <<< $(curl -s https://raw.githubusercontent.com/ethz-asl/wavemap/main/tooling/docker/incremental.Dockerfile)
For more info, see the installation page in the docs.
v1.6.2
Summary
This patch adds and updates included header files for compatibility with newer Ubuntu versions.
Backward compatibility is maintained, at least down to Ubuntu 20.04.
Main changes
- Include
<optional>
for std::optional - Update includes for Ogre and Rviz headers deprecated in Ubuntu 23
Thank you lucasw for these contributions.
Package changelogs
- Libraries
- ROS
Upgrade notes
Since there are no functional changes, upgrading existing installations is not required. If you still wish to test the newest code:
- Catkin
- Go to your catkin workspace src directory:
cd ~/catkin_ws/src
- Pull the newest wavemap code:
cd wavemap && git checkout main && git pull
- Rebuild wavemap:
catkin build wavemap_all
- Go to your catkin workspace src directory:
- Docker
docker build --tag=wavemap --build-arg="VERSION=v1.6.2" - <<< $(curl -s https://raw.githubusercontent.com/ethz-asl/wavemap/main/tooling/docker/incremental.Dockerfile)
For more info or to install wavemap on a new system, see the installation page in the docs.
v1.6.1
Summary
This release adds a Dockerfile, scripts, and documentation to make it easy to reproduce the interactive multi-sensor, multi-resolution mapping demo we performed at RSS and the Swiss Robotics Day.
See the new documentation section here.
Main changes
- A Dockerfile that includes all the required software (sensor drivers, FastLIO2, and wavemap)
- A script to easily launch the demo in Docker
- Documentation on how to setup and run the demo
Package changelogs
- ROS
- Tooling
Upgrade notes
Upgrade instructions for
- Catkin
- Go to your catkin workspace src directory:
cd ~/catkin_ws/src
- Pull the newest wavemap code:
cd wavemap && git checkout main && git pull
- Rebuilding is not required, as the changes only affect launch and config files
- Go to your catkin workspace src directory:
- Docker
docker build --tag=wavemap --build-arg="VERSION=v1.6.1" - <<< $(curl -s https://raw.githubusercontent.com/ethz-asl/wavemap/main/tooling/docker/incremental.Dockerfile)
For more info, see the installation page in the docs.