## page was renamed from gmapping/Tutorials/MappingFromLoggedData
####################################
##FILL ME IN
####################################
## links to any required tutorials
## note.0= [[ROS/Tutorials|ROS tutorials]]
## descriptive title for the tutorial
## title = How to Build a Map Using Logged Data
## multi-line description to be displayed in search
## description = This tutorial shows you how to create a 2-D map from logged transform and laser scan data.
## the next tutorial description (optional)
## next =
## links to next tutorial (optional)
## next.0.link=[[pr2_simulator/Tutorials/BuildingAMapInSimulation|Building a map in simulator.]]
## next.1.link=
## what level user is this tutorial for
## level= BeginnerCategory
## choose the correct category (this tag will be searched over it must be here)
## keywords = gmapping
####################################
<<IncludeCSTemplate(TutorialCSHeaderTemplate)>>

<<TableOfContents(4)>>

== Building a map ==
 1. If you're working from a source checkout (as opposed to a binary installation), build gmapping:
 {{{
rosmake gmapping
}}}
 1. Get a bag.  You have a couple of choices:
  1. [[#record|Create a bag with your robot]]
  1. [[#download|Download an existing bag to test with]]
 Either way, you'll end up with a bag.
 1. Bring up the master:
 {{{
roscore
}}}
 1. Make sure that use_sim_time is set to true before any nodes are started:
 {{{
rosparam set use_sim_time true
}}}
 1. Bring up slam_gmapping, which will take in laser scans (in this case, on the '''base_scan''' topic) and produce a map:
 {{{
rosrun gmapping slam_gmapping scan:=base_scan
}}}
 '''Note:''' On the PR2, the `odom` frame is named `odom_combined`. Use the command:
 {{{
rosrun gmapping slam_gmapping scan:=base_scan _odom_frame:=odom_combined
}}}
 1. In a new terminal, start playing back the bag file to feed data to slam_gmapping:
 {{{
rosbag play --clock <name of the bag that you downloaded / created in step 2>
}}}
   Wait for rosbag to finish and exit.
 1. Save your new map to disk using `map_saver` from the `map_server` package:
 {{{
rosrun map_server map_saver -f <map_name>
}}}
 You now have a map, saved locally as '''map.pgm'''.  Congratulations.  You can view it with any image viewer (gimp, eog, gthumb, etc.); it should look very much like<<BR>>

{{attachment:basic_localization_stage_ground_truth.png|this|width="100%"}} .<<BR>>

 1. What's next?  You might want to use your new map in the [[navigation|navigation stack]], by passing your map to the [[map_server]].  As an example, if you're working with a PR2, you would supply your new map at [[2dnav_pr2_app/Tutorials/RunningNavigationStack#OwnMap|this point]] in the process of bringing up the navigation stack.

<<Anchor(download)>>

=== Downloading a test bag ===
 1. Download a bag file to test with here: [[attachment:basic_localization_stage.bag]]

<<Anchor(record)>>

=== Making your own bag ===
 1. Bring up your robot, with laser scans and transform data published, and joystick teleoperation enabled (details will vary from robot to robot).
 1. Start recording scans and transforms (note that the scan topic may vary from robot to robot):
 {{{
rosbag record -O mylaserdata /base_scan /tf
}}}
 This will start writing a file in the current directory called 'mylaserdata_<DATE>-topic.bag.
 1. Drive the robot around.  General advice:
  * Try to limit fast rotations, as they are hardest on the scan-matcher.  It helps to lower the maximum allowed velocity from the joystick.
  * Visualize what the robot "sees" with its laser; if the laser can't see it, it won't be in the map.
  * People walking around don't usually present a problem, unless they walk along with the robot, in view of its laser.
  * Loop closure is the hardest part; when closing a loop, be sure to drive another 5-10 meters to get plenty of overlap between the start and end of the loop.
 1. Kill the '''rosbag''' instance, and note the name of the file that was created.

== Variation: watching the mapping progress ==
If you don't care to wait until the log playback and mapping process has finished before seeing some results, then you can watch the progress in rviz.

 * {{{rosrun rviz rviz}}}
 * Add a display with a map, set to the topic /map

----
## TutorialCategory
## FILL IN THE STACK TUTORIAL CATEGORY HERE