Commit Graph

94 Commits (c06879b63567a78ef92b7d1fa79453839e36ffec)

Author SHA1 Message Date
Jonathan Huber c06879b635
[docs] Fix parameter name of publish_tracked_pose (#1620)
Signed-off-by: Jonathan Huber <jonathan.huber@enway.ai>
2021-05-04 13:43:20 +02:00
Michael Grupp 305605bd3a
Remove inactive mailing list from docs. (#1612)
Signed-off-by: Michael Grupp <grupp@magazino.eu>
2021-04-19 14:01:18 +02:00
Mohamed Ahmed 151c56312d
typo fix (#1591)
Signed-off-by: mohamedsayed18 <mohamed95.a.s@gmail.com>
2021-01-29 11:47:57 +01:00
Mohamed Ahmed 0d2bc2ca5b
Fixing typo in the docs (#1588)
Signed-off-by: mohamedsayed18 <mohamed95.a.s@gmail.com>
2021-01-25 10:21:50 +01:00
zhenzhenxiang 9020ba0247
Update algo_walkthrough.rst (#1545)
Fix typos.

Signed-off-by: zhenzhenxiang <405090724@163.com>
2020-11-11 13:46:46 +01:00
Michael Grupp 70612a4d40
Fix outdated build instructions (closes #1531). (#1537)
Signed-off-by: Michael Grupp <grupp@magazino.eu>
2020-10-27 09:28:18 +01:00
Michael Grupp 1c9274ffee
Default to master in rosinstall (fixes #1122). (#1530)
This makes much more sense than 1.0.0, which is counter-intuitive.

If someone is building from source they usually do it to build the
latest bleeding-edge version.

Signed-off-by: Michael Grupp <grupp@magazino.eu>
2020-10-22 17:33:45 +02:00
Erik Reed 7ac49a9287
Add color requirement note for point_cloud_viewer (#1424)
I was running through these docs and having [trouble](https://github.com/googlecartographer/point_cloud_viewer/issues/389)
with map visualization via `point_cloud_viewer`.
Notably, color is required for plys ingested by `point_cloud_viewer` (in contrast to Meshlab).

This PR adds a note to make this clear.

Signed-off-by: Erik Reed <ereed.uw@gmail.com>
2020-10-21 19:49:50 +02:00
Jonathan Huber dcbd9d10df
Make publishing tf optional, enable publishing PoseStamped (#1099)
If the output of cartographer should be used as an input to an additional sensor fusion method,
using the published TF transform is inconvenient or in our specific use case even harmful
because we don't want to add the raw cartographer output to our TF tree.

With this change it becomes optional to broadcast to /tf.
Morever there is an option to publish the tracked frame pose as a PoseStamped message.
We add two new optional parameters:
- `publish_to_tf` if false no tf transform is broadcasted
-  `publish_tracked_pose` If set `true` a PoseStamped representing the position of the
tracked pose w.r.t. map frame is published.

If default launchers and settings are used this PR causes no change in the behavior.
2020-10-21 14:03:15 +02:00
Michael Grupp 6296d41cd5
Update "Getting involved" documentation page. (#1522)
Some things were outdated after recent changes.

Signed-off-by: Michael Grupp <grupp@magazino.eu>
2020-10-15 10:49:24 +02:00
Michael Grupp 868d147fb5
Fix Sphinx documentation errors & warnings. (#1523)
Fixes broken links, code blocks and other things that
`sphinx-build docs/source docs/out -E` complained about.

Signed-off-by: Michael Grupp <grupp@magazino.eu>
2020-10-13 15:00:12 +02:00
Wolfgang Hess 26ab581a20
Minor documentation tweaks for Noetic. (#1520)
Signed-off-by: Wolfgang Hess <whess@lyft.com>
2020-10-05 14:41:05 +02:00
Geonhee 97883c4542
Update assets_writer.rst (#1442)
Signed-off-by: Geonhee-LEE <gunhee6392@gmail.com>
2020-08-29 11:49:05 +02:00
Wolfgang Hess bdf8f5921e
Fix build status on front page. (#1483)
* Fix build status on front page.

Changes "googlecartographer" to "cartographer-project"
for references to CI and GitHub.

Following cartographer-project/cartographer#1693.

Signed-off-by: Wolfgang Hess <whess@lyft.com>

* Remove Indigo and Lunar Dockerfiles.
2020-06-24 10:55:03 +02:00
mgladkova 20c2c8f0f7 Update ROS API documentation with description of changed/new services (#1282) 2019-07-09 14:10:58 +02:00
Ashwath Narayan Murali 2d9b751d51 Updated doc to remove abseil-cpp from ROS (#1211)
I have added a few lines to the doc to alert users to remove ros abseil-cpp and also to change the rosinstall file if they wish to checkout a different version of cartographer. As discussed in #1208
2019-04-17 14:23:38 +02:00
fprott 7e4af360e8 Expanded Landmarks documentation (#1241)
Expanded landmarks to included more information and make it more clear and first-time user friendly. Used knowledge from the issues, especially issue https://github.com/googlecartographer/cartographer_ros/issues/909 and https://github.com/googlecartographer/cartographer_ros/issues/1067
2019-04-03 19:34:51 +02:00
fprott 522fb13104 Landmarks note (#1242)
Added a note to point out that even if all the SLAM options are set for a 2D SLAM the landmarks will remain 3D objects.
2019-04-03 18:10:11 +02:00
fprott 5f1ff900b4 Fixed wrong Topic name for Landmarks (#1171)
The expected topic name for the cartographer seems to be landmark not landmarks even tough a list of landmarks is expected.
2019-01-30 13:46:41 +01:00
Esteve Fernandez 68f60ff763 Fix typo (#1130) 2019-01-16 14:10:54 +01:00
Michael Grupp d0871210e7 Update /write_state call in assets writer docs. (#1087)
* Update /write_state call in assets writer docs.

Follow-up to #966
Closes #1086

* typo

* bump googlebot
2018-11-05 21:26:05 -08:00
Florent Revest ba33291392 Rework the documentation as a step-by-step guide (#952)
This restructures the doc as a tutorial leading newcomers to becoming experimented users.

It adds pages on:
 - how to get started with Cartographer on a new .bag
 - how Cartographer works and can be tuned step-by-step
 - how to use "extra" features of Cartographer
 - how to contribute to Cartographer

It also provides some cosmethic changes with: new titles, non-indented code blocks, various illustrations, reworked paragraphs for clarity...
2018-11-05 12:22:55 +01:00
Alexander Belyaev ef0e971b50
Add landmarks demo to the docs. (#1077) 2018-10-25 17:25:29 +02:00
Alireza 39e7faad18 docs: Add documentation related to `bagfile_progress` publisher (#1039)
Add documentations related to the feature introduced in #940.
2018-10-19 11:10:32 +02:00
Michael Grupp 97266a69a0 Update docs of ROS API. (#928)
- add new ROS services
- remove outdated text about command line flags, refer users to `--help`
- bonus: fix a few typos, a Sphinx build warning and follow https://github.com/googlecartographer/cartographer/pull/1268
2018-07-25 14:23:31 +02:00
Dave Coleman 0beb972763 Minor grammar fix. (#900) 2018-07-05 10:57:20 +02:00
Alexander Reimann 037ea79e9b [docs] Add warning on pure_localization submap resolutions (#858)
Closes #847
2018-05-25 03:20:54 +02:00
Michael Grupp 9eeb3c9477 Add paragraph 'Odometry in Global Optimization' to tuning.rst (#802)
Follow https://github.com/googlecartographer/cartographer/pull/1029
2018-04-11 10:28:28 +02:00
Michael Grupp 15517addb1 Fix table formatting in data.rst (#748)
Adds whitespace to make restructured text happy again.
2018-03-01 11:21:01 +01:00
Juraj Oršulić b7d8af834e Unfrozen trajectories (#710)
Unfrozen trajectories
2018-02-27 21:26:52 +01:00
Michael Grupp 185ba8b6da Add Magazino public datasets to data.rst (#738)
* Add Magazino public datasets to data.rst
2018-02-27 20:12:57 +01:00
Michael Grupp 512a9cc358 Mention built-in evaluation tools in the tuning guide. (#705)
Other changes:
- Moved the 'Verification' paragraph in the tuning guide up,
  as it fits better after the particular issue discussed before 'Special Cases'.
- Fixed 'WARNING: Title underline too short.' messages.
2018-02-06 19:14:49 +01:00
Michael Grupp 3ca30fc904 Refactor ROS service responses. (#708)
Provide a descriptive StatusResponse msg field consisting of
an gRPC-like StatusCode and message string to the service caller.

Implements [RFC 13](https://github.com/googlecartographer/rfcs/blob/master/text/0013-improve-ros-service-responses.md).
2018-02-06 18:06:08 +01:00
Holger Rapp 8f14350e83 Fix link for a bag with intensities. (#704) 2018-02-02 21:31:25 +01:00
gaschler 02ed0153d1 Tuning guide for low latency and localization (#653)
Related to #397
2018-01-10 14:43:50 +01:00
Wolfgang Hess e0e3bdd625 Update the tuning guide following #604. (#606) 2017-11-17 15:46:54 +01:00
Wolfgang Hess af17cf5a27 Follow googlecartographer/cartographer#686. (#605) 2017-11-17 13:03:43 +01:00
Wolfgang Hess f241a679a9 Update the tuning guide following #598. (#599) 2017-11-16 15:12:53 +01:00
Christoph Schütte 5210e92533 Add proto3 install scripts to Dockerfiles and update docs. (#589) 2017-11-13 10:48:00 +01:00
Wolfgang Hess 1b8869bbf6
Unbreak the demo documentation. (#581) 2017-11-07 16:43:26 +01:00
Wolfgang Hess bf187d9059 Add 3D localization demo. (#580)
Adds configuration files and launch files for 3D backpack pure
localization.

Moves most demos to a separate documentation page.
2017-11-07 15:29:11 +01:00
Holger Rapp 7403d82fbb Added intensities to one more bag and added one new data set. (#554) 2017-11-02 16:30:39 +01:00
Holger Rapp b9877fed12 Update 3D public data (#538)
- Remove a bag that had the same data as another, just different timestamps.
- Republish a few bags with laser intensities.
2017-10-13 16:24:03 +02:00
Holger Rapp 8539e1a601 Add a --output_file_prefix option to the asset writer. (#537)
It defaults to using the first bag name, i.e. the files end up next to the input file which is more ergonomic than having them end up in $HOME/.ros.
2017-10-13 15:36:11 +02:00
Damon Kohler 634769e9d0 Adds two new FAQ entries. (#515) 2017-09-29 16:06:34 +02:00
Holger Rapp 46b0cc6497 Add documentation for the assets_writer. (#449)
Fixes #239.
2017-07-31 11:26:06 +02:00
Holger Rapp ba28491775 Update ROS API documentation. (#450)
Add mentions of the offline node and the occupancy grid node.

Fixes #448.
2017-07-28 14:35:46 +02:00
Holger Rapp 698fc1043f Beginnings of a tuning guide. (#445)
Related to #397.
2017-07-28 14:17:16 +02:00
Holger Rapp 99da2f20d8 Enable OccupancyGridNode and remove generating of assets in the node. (#436)
This will allow us to keep way less information in memory for SLAMing and fixes crashes related to multi trajectory (e.g. this fixes #413).

It also means that to get to an X-Ray or a map, users need to run the asset writer now after SLAMing, which is inconvenient.
Remove dependency on YAML and delete more dead code.
2017-07-21 17:19:47 +02:00
Wolfgang Hess e5c2881b90 Support multiple LaserScan and MultiEchoLaserScan topics. (#435)
This fixes #212.
2017-07-21 14:07:15 +02:00