Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 727fa15453fcace956b835e2377d4269 > files > 671

player-doc-3.0.2-5.fc14.noarch.rpm

<!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&nbsp;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&nbsp;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>vfh<br/>
<small>
[<a class="el" href="group__drivers.html">Drivers</a>]</small>
</h1>  </div>
</div>
<div class="contents">

<p>Vector Field Histogram local navigation algorithm.  
<a href="#_details">More...</a></p>
<table class="memberdecls">
</table>
<p>Vector Field Histogram local navigation algorithm. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This driver may take several seconds to start up, especially on slower machines. You may want to set the 'alwayson' option for vfh to '1' in your configuration file in order to front-load this delay. Otherwise, your client may experience a timeout in trying to subscribe to this device.</dd></dl>
<p>The vfh driver implements the Vector Field Histogram Plus local navigation method by Ulrich and Borenstein. VFH+ provides real-time obstacle avoidance and path following capabilities for mobile robots. Layered on top of a laser-equipped robot, vfh works great as a local navigation system (for global navigation, you can layer the <a class="el" href="group__driver__wavefront.html">wavefront</a> driver on top of vfh).</p>
<p>The primary parameters to tweak to get reliable performance are safety_dist and free_space_cutoff. In general, safety_dist determines how close the robot will come to an obstacle while turning (around a corner for instance) and free_space_cutoff determines how close a robot will get to an obstacle in the direction of motion before turning to avoid. From experience, it is recommeded that max_turnrate should be at least 15% of max_speed.</p>
<p>To get initiated to VFH, I recommend starting with the default values for all parameters and experimentally adjusting safety_dist and free_space_cutoff to get a feeling for how the parameters affect performance. Once comfortable, increase max_speed and max_turnrate. Unless you are familiar with the VFH algorithm, I don't recommend deviating from the default values for cell_size, window_diameter, or sector_angle.</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__position2d.html">position2d</a> : accepts target poses, to which vfh will attempt to drive the robot. Also passes through the data from the underlying <a class="el" href="group__interface__position2d.html">position2d</a> device. All data and commands are in the odometric frame of the underlying device.</li>
</ul>
<ul>
<li><a class="el" href="group__interface__planner.html">planner</a> : similar to above, but uses the planer interface which allows extras such as "done" when arrived.</li>
</ul>
<dl class="user"><dt><b>Requires</b></dt><dd></dd></dl>
<ul>
<li><a class="el" href="group__interface__position2d.html">position2d</a> : the underlying robot that will be controlled by vfh.</li>
</ul>
<ul>
<li>Exactly one of:<ul>
<li><a class="el" href="group__interface__laser.html">laser</a> : the laser that will be used to avoid obstacles</li>
<li><a class="el" href="group__interface__sonar.html">sonar</a> : the sonar that will be used to avoid obstacles</li>
</ul>
</li>
</ul>
<p>-</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000037">Todo:</a></b></dt><dd>: add support for getting the robot's true global pose via the <a class="el" href="group__interface__simulation.html">simulation</a> interface</dd></dl>
<dl class="user"><dt><b>Configuration requests</b></dt><dd></dd></dl>
<ul>
<li>all position2d requests (as long as the underlying position2d device supports them)</li>
</ul>
<dl class="user"><dt><b>Supported commands</b></dt><dd></dd></dl>
<ul>
<li>PLAYER_POSITION2D_CMD_POS : Position control. This is the normal way to use vfh. Velocity commands will be sent to the underlying <a class="el" href="group__interface__position2d.html">position2d</a> device to drive it toward the given pose.</li>
<li>PLAYER_POSITION2D_CMD_VEL : Velocity control. Position control is disabled and the velocities are passed directly through to the underlyin <a class="el" href="group__interface__position2d.html">position2d</a> device.</li>
</ul>
<dl class="user"><dt><b>Configuration file options</b></dt><dd></dd></dl>
<ul>
<li>cell_size (length)<ul>
<li>Default: 0.1 m</li>
<li>Local occupancy map grid size</li>
</ul>
</li>
<li>window_diameter (integer)<ul>
<li>Default: 61</li>
<li>Dimensions of occupancy map (map consists of window_diameter X window_diameter cells).</li>
</ul>
</li>
<li>sector_angle (integer)<ul>
<li>Default: 5</li>
<li>Histogram angular resolution, in degrees.</li>
</ul>
</li>
<li>safety_dist_0ms (length)<ul>
<li>Default: 0.1 m</li>
<li>The minimum distance the robot is allowed to get to obstacles when stopped.</li>
</ul>
</li>
<li>safety_dist_1ms (length)<ul>
<li>Default: safety_dist_0ms</li>
<li>The minimum distance the robot is allowed to get to obstacles when travelling at 1 m/s.</li>
</ul>
</li>
<li>max_speed (length / sec)<ul>
<li>Default: 0.2 m/sec</li>
<li>The maximum allowable speed of the robot.</li>
</ul>
</li>
<li>max_speed_narrow_opening (length / sec)<ul>
<li>Default: max_speed</li>
<li>The maximum allowable speed of the robot through a narrow opening</li>
</ul>
</li>
<li>max_speed_wide_opening (length / sec)<ul>
<li>Default: max_speed</li>
<li>The maximum allowable speed of the robot through a wide opening</li>
</ul>
</li>
<li>max_acceleration (length / sec / sec)<ul>
<li>Default: 0.2 m/sec/sec</li>
<li>The maximum allowable acceleration of the robot.</li>
</ul>
</li>
<li>min_turnrate (angle / sec)<ul>
<li>Default: 10 deg/sec</li>
<li>The minimum allowable turnrate of the robot.</li>
</ul>
</li>
<li>max_turnrate_0ms (angle / sec)<ul>
<li>Default: 40 deg/sec</li>
<li>The maximum allowable turnrate of the robot when stopped.</li>
</ul>
</li>
<li>max_turnrate_1ms (angle / sec)<ul>
<li>Default: max_turnrate_0ms</li>
<li>The maximum allowable turnrate of the robot when travelling 1 m/s.</li>
</ul>
</li>
<li>min_turn_radius_safety_factor (float)<ul>
<li>Default: 1.0</li>
<li>?</li>
</ul>
</li>
<li>free_space_cutoff_0ms (float)<ul>
<li>Default: 2000000.0</li>
<li>Unitless value. The higher the value, the closer the robot will get to obstacles before avoiding (while stopped).</li>
</ul>
</li>
<li>free_space_cutoff_1ms (float)<ul>
<li>Default: free_space_cutoff_0ms</li>
<li>Unitless value. The higher the value, the closer the robot will get to obstacles before avoiding (while travelling at 1 m/s).</li>
</ul>
</li>
<li>obs_cutoff_0ms (float)<ul>
<li>Default: free_space_cutoff_0ms</li>
<li>???</li>
</ul>
</li>
<li>obs_cutoff_1ms (float)<ul>
<li>Default: free_space_cutoff_1ms</li>
<li>???</li>
</ul>
</li>
<li>weight_desired_dir (float)<ul>
<li>Default: 5.0</li>
<li>Bias for the robot to turn to move toward goal position.</li>
</ul>
</li>
<li>weight_current_dir (float)<ul>
<li>Default: 3.0</li>
<li>Bias for the robot to continue moving in current direction of travel.</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.</li>
</ul>
</li>
<li>angle_epsilon (angle)<ul>
<li>Default: 10 deg</li>
<li>Angular difference from target angle that will considered acceptable.</li>
</ul>
</li>
<li>Stall escape options. If the underlying position2d device reports a stall, this driver can attempt a blind escape procedure. It does so by driving forward or backward while turning for a fixed amount of time. If the escape fails (i.e., the stall is still in effect), then it will try again.<ul>
<li>escape_speed (length / sec)<ul>
<li>Default: 0.0</li>
<li>If non-zero, the translational velocity that will be used while trying to escape.</li>
</ul>
</li>
<li>escape_time (float)<ul>
<li>Default: 0.0</li>
<li>If non-zero, the time (in seconds) for which an escape attempt will be made.</li>
</ul>
</li>
<li>escape_max_turnrate (angle / sec)<ul>
<li>Default: 0.0</li>
<li>If non-zero, the maximum angular velocity that will be used when trying to escape.</li>
</ul>
</li>
<li>synchronous (int)<ul>
<li>default: 0</li>
<li>If zero (the default), VFH runs in its own thread. If non-zero, VFH runs in the main Player thread, which will make the server less responsive, but prevent nasty asynchronous behaviour under high CPU load. This is probably only useful when running demanding simulations.</li>
</ul>
</li>
</ul>
</li>
</ul>
<dl class="user"><dt><b>Example</b></dt><dd><div class="fragment"><pre class="fragment">
driver
(
  name "p2os"
  provides ["odometry::position:1"]
  port "/dev/ttyS0"
)
driver
(
  name "sicklms200"
  provides ["laser:0"]
  port "/dev/ttyS1"
)
driver
(
  name "vfh"
  requires ["position:1" "laser:0"]
  provides ["position:0"]
  safety_dist 0.10
  distance_epsilon 0.3
  angle_epsilon 5
)
</pre></div></dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Chris Jones, Brian Gerkey, Alex Brooks, Richard Vaughan </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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional