<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<!-- $Id: header.html 8799 2010-06-28 04:12:42Z jpgr87 $ -->
<HEAD>
<meta HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=utf-8">
<meta name="keywords" content="stage, robot, simulation, player, player/stage">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<style type="text/css">
.floatright { float: right; margin: 0 0 1em 1em; }
body {
font-family: sans-serif;
#font-family: Geneva, Verdana, Helvetica, Arial, sans-serif;
background-color: #FFF;
color:#000;
}
a:link {
color: #A00;
}
a:visited {
color: #800;
}
a { text-decoration: none; }
a:hover { text-decoration: underline; }
.timestamp { text-align:right; background-color: #DDD; font-size:75%;}
h1 {
font-size:160%;
}
h2 {
font-size:110%;
#color: #FFF;
#background-color: #666;
#padding:3px;
}
h3 { text-align:left; }
img {
border: 0;
}
ul.menu {
position:relative;
left:-2.5em;
margin-bottom:0px;
margin-top:0px;
}
ul.menu1 {
position:relative;
left:-2.1em;
margin-bottom:0px;
margin-top:0px;
}
li.menu {
list-style-type: none;
position:relative;
#left:-0.5em;
}
#sidebar { position: absolute; left:0px; padding:2em; top:0em; width:12em;}
#content { position: absolute; left:12em; top:0em; padding-left:3em; padding-right:3em; padding-bottom:2em; margin-top:1em; margin-right:2em; }
div.box { background-color:#EEE; border: 1px solid #000; padding: 0.5ex 0.4em 0.5ex 0.6em; margin:1em; }
div.title { font-weight:bold; background-color:#eee; margin-bottom:2px;}
div.topbar { position: absolute; top:0px; left:9em; margin:1em; }
</style>
<TITLE>Player Manual</TITLE>
</HEAD>
<body>
<div id="sidebar">
<h2 style="text-align:center;">
<a href="index.html">
<img width=140 src="http://playerstage.sourceforge.net/images/player_button_v3.png" alt="Player logo"><br></a>
</h2>
<div class="box">
<div class=title>Player</div>
<ul class=menu>
<li class=menu><a href="index.html">Frontpage</a>
<li class=menu><a href="modules.html">Contents</a>
</ul>
</div>
<div class="box">
<div class=title>User</div>
<ul class=menu>
<li class=menu><a href="install.html">Installation</a>
<li class=menu><a href="start.html">Quick start</a>
<li class=menu><a href="supported_hardware.html">Supported devices</a>
<li class=menu><a href="group__tutorials.html">Tutorials</a>
<li class=menu><a href="group__utils.html">Utilities</a>
<li class=menu><a href="group__clientlibs.html">Client libraries</a>
<li class=menu><a href="http://playerstage.sourceforge.net/wiki/Basic_FAQ">FAQ</a>
<li class=menu><a href="help.html">Help</a>
</ul>
</div>
<div class=box>
<div class="title">Developer</div>
<ul class=menu>
<li class=menu><a href="architecture.html">Architecture</a>
<li class=menu><a href="group__libplayercore.html">libplayercore</a>
<ul class=menu1>
<li class=menu><a href="group__interfaces.html">interfaces</a></li>
</ul>
<li class=menu><a href="group__libplayerdrivers.html">libplayerdrivers</a>
<ul class=menu1>
<li class=menu><a href="group__drivers.html">drivers</a></li>
</ul>
<li class=menu><a href="group__libplayercommon.html">libplayercommon</a>
<li class=menu><a href="group__libplayerutils.html">libplayerutils</a>
<li class=menu><a href="group__libplayersd.html">libplayersd</a>
<li class=menu><a href="group__libplayertcp.html">libplayertcp</a>
<li class=menu><a href="group__libplayerxdr.html">libplayerxdr</a>
<li class=menu><a href="todo.html">TODO</a>
</ul>
</div>
<div class=box>
<!-- <a href="http://sourceforge.net"><img border=0 src="http://sourceforge.net/sflogo.php?group_id=42445&type=1"></a> -->
<div class="title">Online</div>
<a href="http://playerstage.sourceforge.net">Homepage</a><br>
<a href="http://sourceforge.net/project/showfiles.php?group_id=42445">Download</a><br>
<a href="http://sourceforge.net/projects/playerstage">Project</a><br>
<a href="http://sourceforge.net/tracker/?group_id=42445">Bugs</a><br>
<a href="http://sourceforge.net/mail/?group_id=42445">Help</a>
</div>
</div>
<div id="content" >
<!-- Generated by Doxygen 1.7.1 -->
<div class="header">
<div class="headertitle">
<h1>wavefront<br/>
<small>
[<a class="el" href="group__drivers.html">Drivers</a>]</small>
</h1> </div>
</div>
<div class="contents">
<p>Wavefront-propagation path-planner.
<a href="#_details">More...</a></p>
<table class="memberdecls">
</table>
<p>Wavefront-propagation path-planner. </p>
<p>The wavefront driver implements a global path planner for a planar mobile robot.</p>
<p>This driver works in the following way: upon receiving a new <a class="el" href="group__interface__planner.html">planner</a> target, a path is planned from the robot's current pose, as reported by the underlying <a class="el" href="group__interface__localize.html">localize</a> device. The waypoints in this path are handed down, in sequence, to the underlying <a class="el" href="group__interface__position2d.html">position2d</a> device, which should be capable of local navigation (the <a class="el" href="group__driver__vfh.html">vfh</a> driver is a great candidate). By tying everything together in this way, this driver offers the mythical "global goto" for your robot.</p>
<p>The planner first creates a configuration space of grid cells from the map that is given, treating both occupied and unknown cells as occupied. The planner assigns a cost to each of the free cells based on their distance to the nearest obstacle. The nearer the obstacle, the higher the cost. Beyond the max_radius given by the user, the cost in the c-space cells is zero.</p>
<p>When the planner is given a new goal, it finds a path by working its way outwards from the goal cell, assigning plan costs to the cells as it expands (like a wavefront expanding outwards in water). The plan cost in each cell is dependant on its distance from the goal, as well as the obstacle cost assigned in the configuration space step. Once the plan costs for all the cells have been evaluated, the robot can simply follow the gradient of each lowest adjacent cell all the way to the goal.</p>
<p>In order to function effectively with an underlying obstacle avoidance algorithm, such as Vector Field Histogram (the <a class="el" href="group__driver__vfh.html">vfh</a> driver), the planner only hands off waypoints, not the entire path. The wavefront planner finds the longest straight-line distances that don't cross obstacles between cells that are on the path. The endpoints of these straight lines become sequential goal locations for the underlying device driving the robot.</p>
<p>For help in using this driver, try the <a class="el" href="group__util__playernav.html">playernav</a> utility.</p>
<dl class="user"><dt><b>Compile-time dependencies</b></dt><dd></dd></dl>
<ul>
<li>none</li>
</ul>
<dl class="user"><dt><b>Provides</b></dt><dd></dd></dl>
<ul>
<li><a class="el" href="group__interface__planner.html">planner</a></li>
</ul>
<dl class="user"><dt><b>Requires</b></dt><dd></dd></dl>
<p>This driver controls two named position2d devices: one for input and one for output. That way you can read poses from a localization or SLAM system and send commands directly to the robot. The input and output devices may be the same.</p>
<ul>
<li>"input" <a class="el" href="group__interface__position2d.html">position2d</a> : source of current pose information (usually you would use the <a class="el" href="group__driver__amcl.html">amcl</a> driver)</li>
<li>"output" <a class="el" href="group__interface__position2d.html">position2d</a> : robot to be controlled; this device must be capable of position control (usually you would use the <a class="el" href="group__driver__vfh.html">vfh</a> driver)</li>
<li><a class="el" href="group__interface__map.html">map</a> : the map to plan paths in</li>
</ul>
<dl class="user"><dt><b>Configuration requests</b></dt><dd></dd></dl>
<ul>
<li>PLAYER_PLANNER_REQ_GET_WAYPOINTS</li>
</ul>
<dl class="user"><dt><b>Configuration file options</b></dt><dd></dd></dl>
<p>Note that the various thresholds should be set to GREATER than the underlying position device; otherwise the planner could wait indefinitely for the position device to achieve a target, when the position device thinks it has already achieved it.</p>
<ul>
<li>safety_dist (length)<ul>
<li>Default: 0.25 m</li>
<li>Don't plan a path any closer than this distance to any obstacle. Set this to be GREATER than the corresponding threshold of the underlying position device!</li>
</ul>
</li>
<li>max_radius (length)<ul>
<li>Default: 1.0 m</li>
<li>For planning purposes, all cells that are at least this far from any obstacle are equally good (save CPU cycles).</li>
</ul>
</li>
<li>dist_penalty (float)<ul>
<li>Default: 1.0</li>
<li>Extra cost to discourage cutting corners</li>
</ul>
</li>
<li>distance_epsilon (length)<ul>
<li>Default: 0.5 m</li>
<li>Planar distance from the target position that will be considered acceptable. Set this to be GREATER than the corresponding threshold of the underlying position device!</li>
</ul>
</li>
<li>angle_epsilon (angle)<ul>
<li>Default: 10 deg</li>
<li>Angular difference from target angle that will considered acceptable. Set this to be GREATER than the corresponding threshold of the underlying position device!</li>
</ul>
</li>
<li>replan_dist_thresh (length)<ul>
<li>Default: 2.0 m</li>
<li>Change in robot's position (in localization space) that will trigger replanning. Set to -1 for no replanning (i.e, make a plan one time and then stick with it until the goal is reached). Replanning is pretty cheap computationally and can really help in dynamic environments. Note that no changes are made to the map in order to replan; support is forthcoming for explicitly replanning around obstacles that were not in the map. See also replan_min_time.</li>
</ul>
</li>
<li>replan_min_time (float)<ul>
<li>Default: 2.0</li>
<li>Minimum time in seconds between replanning. Set to -1 for no replanning. See also replan_dist_thresh;</li>
</ul>
</li>
<li>cspace_file (filename)<ul>
<li>Default: "player.cspace"</li>
<li>Use this file to cache the configuration space (c-space) data. At startup, if this file can be read and if the metadata (e.g., size, scale) in it matches the current map, then the c-space data is read from the file. Otherwise, the c-space data is computed. In either case, the c-space data will be cached to this file for use next time. C-space computation can be expensive and so caching can save a lot of time, especially when the planner is frequently stopped and started. This feature requires md5 hashing functions in libcrypto.</li>
</ul>
</li>
<li>add_rotational_waypoints (integer)<ul>
<li>Default: 1</li>
<li>If non-zero, add an in-place rotational waypoint before the next waypoint if the difference between the robot's current heading and the heading to the next waypoint is greater than 45 degrees. Generally helps the low-level position controller, but sacrifices speed.</li>
</ul>
</li>
<li>force_map_refresh (integer)<ul>
<li>Default: 0</li>
<li>If non-zero, map is updated from subscribed map device whenever new goal is set</li>
</ul>
</li>
</ul>
<dl class="user"><dt><b>Example</b></dt><dd></dd></dl>
<p>This example shows how to use the wavefront driver to plan and execute paths on a laser-equipped Pioneer.</p>
<div class="fragment"><pre class="fragment">
driver
(
name "p2os"
provides ["odometry:::position2d:0"]
port "/dev/ttyS0"
)
driver
(
name "sicklms200"
provides ["laser:0"]
port "/dev/ttyS1"
)
driver
(
name "mapfile"
provides ["map:0"]
filename "mymap.pgm"
resolution 0.1
)
driver
(
name "amcl"
provides ["position2d:2"]
requires ["odometry:::position2d:1" "laser:0" "laser:::map:0"]
)
driver
(
name "vfh"
provides ["position2d:1"]
requires ["position2d:0" "laser:0"]
safety_dist 0.1
distance_epsilon 0.3
angle_epsilon 5
)
driver
(
name "wavefront"
provides ["planner:0"]
requires ["output:::position2d:1" "input:::position2d:2" "map:0"]
safety_dist 0.15
distance_epsilon 0.5
angle_epsilon 10
)
</pre></div><dl class="author"><dt><b>Author:</b></dt><dd>Brian Gerkey, Andrew Howard </dd></dl>
</div>
<!-- render the modification time of the source file -->
<div class="timestamp">
<hr>
<table style="width:100%;">
<tr>
<td style="text-align:left;">
Last updated 12 September 2005 21:38:45
<!--
<td style="text-align:right;">
<a href="http://validator.w3.org/check/referer"><img style="vertical-align:middle;border:0;width:88px;height:31px"
src="http://www.w3.org/Icons/valid-html401"
alt="Valid HTML 4.01!"></a>
<a href="http://jigsaw.w3.org/css-validator/">
<img style="vertical-align:middle;border:0;width:88px;height:31px"
src="http://jigsaw.w3.org/css-validator/images/vcss"
alt="Valid CSS!">
</a>
-->
</tr>
</table>
</div>
</tr>
</table>
</BODY>
</HTML>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
727fa15453fcace956b835e2377d4269
>
files
>
673
