<!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>fiducial<br/>
<small>
[<a class="el" href="group__interfaces.html">Interface specifications</a>]</small>
</h1> </div>
</div>
<div class="contents">
<p>Fiducial (marker) detection.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><p><a class="anchor" id="amgrpd41d8cd98f00b204e9800998ecf8427e"></a> </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__fiducial.html#gaeeb70dc0436bc6f21bcdf154bf4a45c1">PLAYER_FIDUCIAL_DATA_SCAN</a> 1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Info on a single detected fiducial. <a href="#gaeeb70dc0436bc6f21bcdf154bf4a45c1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__fiducial.html#gaf1a7fea13f1b92e48fd3df5e7411a1d2">PLAYER_FIDUCIAL_REQ_GET_GEOM</a> 1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Info on a single detected fiducial. <a href="#gaf1a7fea13f1b92e48fd3df5e7411a1d2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__fiducial.html#gab895a5dd0d31f75fcd73c76217069bb3">PLAYER_FIDUCIAL_REQ_GET_FOV</a> 2</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Info on a single detected fiducial. <a href="#gab895a5dd0d31f75fcd73c76217069bb3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__fiducial.html#gab6e79e2e88e22c9013b192e99bb7e78f">PLAYER_FIDUCIAL_REQ_SET_FOV</a> 3</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Info on a single detected fiducial. <a href="#gab6e79e2e88e22c9013b192e99bb7e78f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__fiducial.html#ga00318e909ae377d78d4a6bb328764ace">PLAYER_FIDUCIAL_REQ_GET_ID</a> 7</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Info on a single detected fiducial. <a href="#ga00318e909ae377d78d4a6bb328764ace"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__fiducial.html#gaa24ea959abcdd91abb4cb77011935aa2">PLAYER_FIDUCIAL_REQ_SET_ID</a> 8</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Info on a single detected fiducial. <a href="#gaa24ea959abcdd91abb4cb77011935aa2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__fiducial__item.html">player_fiducial_item</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__fiducial.html#ga480329f16b28273f8e581bd7feee2b3c">player_fiducial_item_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Info on a single detected fiducial. <a href="#ga480329f16b28273f8e581bd7feee2b3c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__fiducial__data.html">player_fiducial_data</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__fiducial.html#ga36b316df44f0248a61a6add81a406010">player_fiducial_data_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data: detected fiducials (<a class="el" href="group__interface__fiducial.html#gaeeb70dc0436bc6f21bcdf154bf4a45c1">PLAYER_FIDUCIAL_DATA_SCAN</a>). <a href="#ga36b316df44f0248a61a6add81a406010"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__fiducial__geom.html">player_fiducial_geom</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__fiducial.html#ga57106f21b747e0db0049c552abb17106">player_fiducial_geom_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: Get geometry. <a href="#ga57106f21b747e0db0049c552abb17106"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__fiducial__fov.html">player_fiducial_fov</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__fiducial.html#ga05884f8eae2992ad16e420be049b478e">player_fiducial_fov_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: Get/set sensor field of view. <a href="#ga05884f8eae2992ad16e420be049b478e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__fiducial__id.html">player_fiducial_id</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__fiducial.html#gaf0bf6bf1553bc3a6822e702b996bf02f">player_fiducial_id_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: Get/set fiducial ID. <a href="#gaf0bf6bf1553bc3a6822e702b996bf02f"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Fiducial (marker) detection. </p>
<p>The fiducial interface provides access to devices that detect coded fiducials (markers) placed in the environment. It can also be used for devices the detect natural landmarks. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="gaeeb70dc0436bc6f21bcdf154bf4a45c1"></a><!-- doxytag: member="player_interfaces.h::PLAYER_FIDUCIAL_DATA_SCAN" ref="gaeeb70dc0436bc6f21bcdf154bf4a45c1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_FIDUCIAL_DATA_SCAN 1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Info on a single detected fiducial. </p>
<p>The fiducial data packet contains a list of these. </p>
</div>
</div>
<a class="anchor" id="gab895a5dd0d31f75fcd73c76217069bb3"></a><!-- doxytag: member="player_interfaces.h::PLAYER_FIDUCIAL_REQ_GET_FOV" ref="gab895a5dd0d31f75fcd73c76217069bb3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_FIDUCIAL_REQ_GET_FOV 2</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Info on a single detected fiducial. </p>
<p>The fiducial data packet contains a list of these. </p>
</div>
</div>
<a class="anchor" id="gaf1a7fea13f1b92e48fd3df5e7411a1d2"></a><!-- doxytag: member="player_interfaces.h::PLAYER_FIDUCIAL_REQ_GET_GEOM" ref="gaf1a7fea13f1b92e48fd3df5e7411a1d2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_FIDUCIAL_REQ_GET_GEOM 1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Info on a single detected fiducial. </p>
<p>The fiducial data packet contains a list of these. </p>
</div>
</div>
<a class="anchor" id="ga00318e909ae377d78d4a6bb328764ace"></a><!-- doxytag: member="player_interfaces.h::PLAYER_FIDUCIAL_REQ_GET_ID" ref="ga00318e909ae377d78d4a6bb328764ace" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_FIDUCIAL_REQ_GET_ID 7</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Info on a single detected fiducial. </p>
<p>The fiducial data packet contains a list of these. </p>
</div>
</div>
<a class="anchor" id="gab6e79e2e88e22c9013b192e99bb7e78f"></a><!-- doxytag: member="player_interfaces.h::PLAYER_FIDUCIAL_REQ_SET_FOV" ref="gab6e79e2e88e22c9013b192e99bb7e78f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_FIDUCIAL_REQ_SET_FOV 3</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Info on a single detected fiducial. </p>
<p>The fiducial data packet contains a list of these. </p>
</div>
</div>
<a class="anchor" id="gaa24ea959abcdd91abb4cb77011935aa2"></a><!-- doxytag: member="player_interfaces.h::PLAYER_FIDUCIAL_REQ_SET_ID" ref="gaa24ea959abcdd91abb4cb77011935aa2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_FIDUCIAL_REQ_SET_ID 8</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Info on a single detected fiducial. </p>
<p>The fiducial data packet contains a list of these. </p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ga36b316df44f0248a61a6add81a406010"></a><!-- doxytag: member="player_interfaces.h::player_fiducial_data_t" ref="ga36b316df44f0248a61a6add81a406010" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__fiducial__data.html">player_fiducial_data</a> <a class="el" href="structplayer__fiducial__data.html">player_fiducial_data_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data: detected fiducials (<a class="el" href="group__interface__fiducial.html#gaeeb70dc0436bc6f21bcdf154bf4a45c1">PLAYER_FIDUCIAL_DATA_SCAN</a>). </p>
<p>The fiducial data packet (all fiducials). </p>
</div>
</div>
<a class="anchor" id="ga05884f8eae2992ad16e420be049b478e"></a><!-- doxytag: member="player_interfaces.h::player_fiducial_fov_t" ref="ga05884f8eae2992ad16e420be049b478e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__fiducial__fov.html">player_fiducial_fov</a> <a class="el" href="structplayer__fiducial__fov.html">player_fiducial_fov_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request/reply: Get/set sensor field of view. </p>
<p>The field of view of the fiducial device can be set using the <a class="el" href="group__interface__fiducial.html#gab6e79e2e88e22c9013b192e99bb7e78f">PLAYER_FIDUCIAL_REQ_SET_FOV</a> request (response will be null), and queried using a null <a class="el" href="group__interface__fiducial.html#gab895a5dd0d31f75fcd73c76217069bb3">PLAYER_FIDUCIAL_REQ_GET_FOV</a> request. </p>
</div>
</div>
<a class="anchor" id="ga57106f21b747e0db0049c552abb17106"></a><!-- doxytag: member="player_interfaces.h::player_fiducial_geom_t" ref="ga57106f21b747e0db0049c552abb17106" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__fiducial__geom.html">player_fiducial_geom</a> <a class="el" href="structplayer__fiducial__geom.html">player_fiducial_geom_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request/reply: Get geometry. </p>
<p>The geometry (pose and size) of the fiducial device can be queried by sending a null <a class="el" href="group__interface__fiducial.html#gaf1a7fea13f1b92e48fd3df5e7411a1d2">PLAYER_FIDUCIAL_REQ_GET_GEOM</a> request. </p>
</div>
</div>
<a class="anchor" id="gaf0bf6bf1553bc3a6822e702b996bf02f"></a><!-- doxytag: member="player_interfaces.h::player_fiducial_id_t" ref="gaf0bf6bf1553bc3a6822e702b996bf02f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__fiducial__id.html">player_fiducial_id</a> <a class="el" href="structplayer__fiducial__id.html">player_fiducial_id_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request/reply: Get/set fiducial ID. </p>
<p>Some fiducial finder devices display their own fiducial. Send a null <a class="el" href="group__interface__fiducial.html#ga00318e909ae377d78d4a6bb328764ace">PLAYER_FIDUCIAL_REQ_GET_ID</a> request to get the identifier displayed by the fiducial.</p>
<p>Some devices can dynamically change the identifier they display. Send a <a class="el" href="group__interface__fiducial.html#gaa24ea959abcdd91abb4cb77011935aa2">PLAYER_FIDUCIAL_REQ_SET_ID</a> request to set the currently displayed value. Make the request with the player_fiducial_id_t structure. The device replies with the same structure with the id field set to the value it actually used. You should check this value, as the device may not be able to display the value you requested.</p>
<p>Currently supported by the stg_fiducial driver. </p>
</div>
</div>
<a class="anchor" id="ga480329f16b28273f8e581bd7feee2b3c"></a><!-- doxytag: member="player_interfaces.h::player_fiducial_item_t" ref="ga480329f16b28273f8e581bd7feee2b3c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__fiducial__item.html">player_fiducial_item</a> <a class="el" href="structplayer__fiducial__item.html">player_fiducial_item_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Info on a single detected fiducial. </p>
<p>The fiducial data packet contains a list of these. </p>
</div>
</div>
</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
>
688
