Skip to content

Commit

Permalink
Added documentation for people using ROS. (#320)
Browse files Browse the repository at this point in the history
* Added documentation for people using ROS.

* Added installation recommendation.
  • Loading branch information
simonpierredeschenes committed Feb 21, 2019
1 parent e99c470 commit 5960271
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/LinkingProjects.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
| [Tutorials Home](index.md) | [Previous](Configuration.md) | [Next](Pointclouds.md) |
| [Tutorials Home](index.md) | [Previous](Configuration.md) | [Next](UsingInRos.md) |
| ------------- |:-------------:| -----:|

# Linking Projects to libpointmatcher
Expand Down
2 changes: 1 addition & 1 deletion doc/Pointclouds.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
| [Tutorials Home](index.md) | [Previous](LinkingProjects.md) | [Next](Transformations.md) |
| [Tutorials Home](index.md) | [Previous](UsingInRos.md) | [Next](Transformations.md) |
| ------------- |:-------------:| -----:|

# Point Clouds in Libpointmatcher
Expand Down
6 changes: 6 additions & 0 deletions doc/UsingInRos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
| [Tutorials Home](index.md) | [Previous](LinkingProjects.md) | [Next](Pointclouds.md) |
| ------------- |:-------------:| -----:|

# Using libpointmatcher in ROS

If you want to use libpointmatcher in [ROS](http://www.ros.org/), you can use the [ethzasl_icp_mapping](https://github.com/ethz-asl/ethzasl_icp_mapping) stack. It allows the conversion of pointclouds from ROS message formats to a libpointmatcher-compatible format and provides a mapping node that is already functionnal and that can be customized using YAML configuration files to suite your needs. It also provides an odometry estimation based on the results of the pointcloud registrations. It includes a wide range of launch files that can be used as usage examples of the different nodes of the stack. Finally, it is recommended to install it from sources rather than from apt-get, because the last release was a long time ago, and it might not be working.
1 change: 1 addition & 0 deletions doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Beginner<a name="beginner"></a>
Advanced<a name="advanced"></a>
-------
- [How to link a project to libpointmatcher?](LinkingProjects.md)
- [How to use libpointmatcher in ROS?](UsingInRos.md)
- [How are point clouds represented?](Pointclouds.md)
- [Example: Writing a program which performs ICP](BasicRegistration.md)
- [How to move a point cloud using a rigid transformation?](Transformations.md)
Expand Down

0 comments on commit 5960271

Please sign in to comment.