<!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="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pri-methods">Private Member Functions</a> | <a href="#pri-static-methods">Static Private Member Functions</a> | <a href="#pri-attribs">Private Attributes</a> </div> <div class="headertitle"> <h1>AMCLFiducial Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="AMCLFiducial" --><!-- doxytag: inherits="AMCLSensor" --><div class="dynheader"> Inheritance diagram for AMCLFiducial:</div> <div class="dyncontent"> <div class="center"> <img src="classAMCLFiducial.png" usemap="#AMCLFiducial_map" alt=""/> <map id="AMCLFiducial_map" name="AMCLFiducial_map"> <area href="classAMCLSensor.html" alt="AMCLSensor" shape="rect" coords="0,0,93,24"/> </map> </div> <p><a href="classAMCLFiducial-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a461760a03291c09d4574e3ae6de940c7"></a><!-- doxytag: member="AMCLFiducial::AMCLFiducial" ref="a461760a03291c09d4574e3ae6de940c7" args="(player_devaddr_t addr)" --> </td><td class="memItemRight" valign="bottom"><b>AMCLFiducial</b> (<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a> addr)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a520a1f9358a01639953a6312b537f8"></a><!-- doxytag: member="AMCLFiducial::Load" ref="a8a520a1f9358a01639953a6312b537f8" args="(ConfigFile *cf, int section)" --> virtual int </td><td class="memItemRight" valign="bottom"><b>Load</b> (<a class="el" href="classConfigFile.html">ConfigFile</a> *cf, int section)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2cb1506cdf95ffc1ca7f6f6a524e23aa"></a><!-- doxytag: member="AMCLFiducial::Unload" ref="a2cb1506cdf95ffc1ca7f6f6a524e23aa" args="(void)" --> virtual int </td><td class="memItemRight" valign="bottom"><b>Unload</b> (void)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a4d8abbd2772f8ac1681d89465a6bcd"></a><!-- doxytag: member="AMCLFiducial::Setup" ref="a6a4d8abbd2772f8ac1681d89465a6bcd" args="(void)" --> virtual int </td><td class="memItemRight" valign="bottom"><b>Setup</b> (void)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a247cd41084f6698dce64c55476bdfb6d"></a><!-- doxytag: member="AMCLFiducial::Shutdown" ref="a247cd41084f6698dce64c55476bdfb6d" args="(void)" --> virtual int </td><td class="memItemRight" valign="bottom"><b>Shutdown</b> (void)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6c11b66b280420efe5cd5fffa4c2d1bb"></a><!-- doxytag: member="AMCLFiducial::UpdateSensor" ref="a6c11b66b280420efe5cd5fffa4c2d1bb" args="(pf_t *pf, AMCLSensorData *data)" --> virtual bool </td><td class="memItemRight" valign="bottom"><b>UpdateSensor</b> (<a class="el" href="struct__pf__t.html">pf_t</a> *pf, <a class="el" href="classAMCLSensorData.html">AMCLSensorData</a> *data)</td></tr> <tr><td colspan="2"><h2><a name="pri-methods"></a> Private Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a46c6433a58948f9b82a116e5514a79a3"></a><!-- doxytag: member="AMCLFiducial::GetData" ref="a46c6433a58948f9b82a116e5514a79a3" args="(void)" --> virtual <a class="el" href="classAMCLSensorData.html">AMCLSensorData</a> * </td><td class="memItemRight" valign="bottom"><b>GetData</b> (void)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a84236e02377264f09612744e27af9723"></a><!-- doxytag: member="AMCLFiducial::SetupMap" ref="a84236e02377264f09612744e27af9723" args="(void)" --> int </td><td class="memItemRight" valign="bottom"><b>SetupMap</b> (void)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a258bcb7478d16798cfac2e38351ceccf"></a><!-- doxytag: member="AMCLFiducial::read_map_file" ref="a258bcb7478d16798cfac2e38351ceccf" args="(const char *)" --> int </td><td class="memItemRight" valign="bottom"><b>read_map_file</b> (const char *)</td></tr> <tr><td colspan="2"><h2><a name="pri-static-methods"></a> Static Private Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e01c8081adb8411cd50f462c5d41b04"></a><!-- doxytag: member="AMCLFiducial::SensorModel" ref="a8e01c8081adb8411cd50f462c5d41b04" args="(AMCLFiducialData *data, pf_vector_t pose)" --> static double </td><td class="memItemRight" valign="bottom"><b>SensorModel</b> (<a class="el" href="classAMCLFiducialData.html">AMCLFiducialData</a> *data, <a class="el" href="structpf__vector__t.html">pf_vector_t</a> pose)</td></tr> <tr><td colspan="2"><h2><a name="pri-attribs"></a> Private Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afcd6284aa23841e4ce0b1483d239bd51"></a><!-- doxytag: member="AMCLFiducial::fiducial_id" ref="afcd6284aa23841e4ce0b1483d239bd51" args="" --> player_device_id_t </td><td class="memItemRight" valign="bottom"><b>fiducial_id</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd6333ee9b8bdf82950e03ca3de32be9"></a><!-- doxytag: member="AMCLFiducial::map_id" ref="abd6333ee9b8bdf82950e03ca3de32be9" args="" --> player_device_id_t </td><td class="memItemRight" valign="bottom"><b>map_id</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3076feb0c1157837502310a47ae2e9f8"></a><!-- doxytag: member="AMCLFiducial::driver" ref="a3076feb0c1157837502310a47ae2e9f8" args="" --> <a class="el" href="classDriver.html">Driver</a> * </td><td class="memItemRight" valign="bottom"><b>driver</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade70a4eede2164e3e303ec8194f94c99"></a><!-- doxytag: member="AMCLFiducial::time" ref="ade70a4eede2164e3e303ec8194f94c99" args="" --> double </td><td class="memItemRight" valign="bottom"><b>time</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa117b1ab27cd895eee2d1484c1340172"></a><!-- doxytag: member="AMCLFiducial::map" ref="aa117b1ab27cd895eee2d1484c1340172" args="" --> <a class="el" href="structmap__t.html">map_t</a> * </td><td class="memItemRight" valign="bottom"><b>map</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af58a3b20b406be31339715b4a2a1b72b"></a><!-- doxytag: member="AMCLFiducial::fmap" ref="af58a3b20b406be31339715b4a2a1b72b" args="" --> <a class="el" href="classAMCLFiducialMap.html">AMCLFiducialMap</a> * </td><td class="memItemRight" valign="bottom"><b>fmap</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56ee4a7bfc126970a6d2e918ddff8b88"></a><!-- doxytag: member="AMCLFiducial::laser_pose" ref="a56ee4a7bfc126970a6d2e918ddff8b88" args="" --> <a class="el" href="structpf__vector__t.html">pf_vector_t</a> </td><td class="memItemRight" valign="bottom"><b>laser_pose</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2e2963c559c18c37efabe9e1d9725f5"></a><!-- doxytag: member="AMCLFiducial::range_max" ref="ab2e2963c559c18c37efabe9e1d9725f5" args="" --> double </td><td class="memItemRight" valign="bottom"><b>range_max</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae848ce72b0168edb2abb555f2ce65eb3"></a><!-- doxytag: member="AMCLFiducial::range_var" ref="ae848ce72b0168edb2abb555f2ce65eb3" args="" --> double </td><td class="memItemRight" valign="bottom"><b>range_var</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac6c0158cbe9b580f9a2599ac631a881b"></a><!-- doxytag: member="AMCLFiducial::angle_var" ref="ac6c0158cbe9b580f9a2599ac631a881b" args="" --> double </td><td class="memItemRight" valign="bottom"><b>angle_var</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68a7745615ddfc0ee1e388d8166c3fea"></a><!-- doxytag: member="AMCLFiducial::range_bad" ref="a68a7745615ddfc0ee1e388d8166c3fea" args="" --> double </td><td class="memItemRight" valign="bottom"><b>range_bad</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a821c1f7d2a8ede3e7eec689154b53e5b"></a><!-- doxytag: member="AMCLFiducial::angle_bad" ref="a821c1f7d2a8ede3e7eec689154b53e5b" args="" --> double </td><td class="memItemRight" valign="bottom"><b>angle_bad</b></td></tr> </table> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="amcl__fiducial_8h_source.html">amcl_fiducial.h</a></li> </ul> </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>