root / trunk / docs / libdragonfly / odometry_8h.html @ 1371
History | View | Annotate | Download (6.28 KB)
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
---|---|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
3 |
<title>libdragonfly: odometry.h File Reference</title> |
4 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
6 |
</head><body> |
7 |
<!-- Generated by Doxygen 1.5.5 -->
|
8 |
<div class="navigation" id="top"> |
9 |
<div class="tabs"> |
10 |
<ul>
|
11 |
<li><a href="index.html"><span>Main Page</span></a></li> |
12 |
<li><a href="pages.html"><span>Related Pages</span></a></li> |
13 |
<li><a href="modules.html"><span>Modules</span></a></li> |
14 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
15 |
<li class="current"><a href="files.html"><span>Files</span></a></li> |
16 |
</ul>
|
17 |
</div>
|
18 |
</div>
|
19 |
<div class="contents"> |
20 |
<h1>odometry.h File Reference</h1>Code for estimating the robots pose. <a href="#_details">More...</a> |
21 |
<p>
|
22 |
|
23 |
<p>
|
24 |
<a href="odometry_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
25 |
<tr><td></td></tr> |
26 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
27 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gea4914268d0abe55b9caafac537bc263"></a><!-- doxytag: member="odometry.h::ODOMETRY_CLK" ref="gea4914268d0abe55b9caafac537bc263" args="" --> |
28 |
#define </td><td class="memItemRight" valign="bottom"><b>ODOMETRY_CLK</b> 255u</td></tr> |
29 |
|
30 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3104e6ab77c71296e6879fc57af26e8e"></a><!-- doxytag: member="odometry.h::TIME_SCALE" ref="g3104e6ab77c71296e6879fc57af26e8e" args="" --> |
31 |
#define </td><td class="memItemRight" valign="bottom"><b>TIME_SCALE</b> 64</td></tr> |
32 |
|
33 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc7a3a8ed9add07ef101e2265dc954b63"></a><!-- doxytag: member="odometry.h::ROBOT_WIDTH_UM" ref="gc7a3a8ed9add07ef101e2265dc954b63" args="" --> |
34 |
#define </td><td class="memItemRight" valign="bottom"><b>ROBOT_WIDTH_UM</b> 137000</td></tr> |
35 |
|
36 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcf7c58b37a2d5cb3793a4f94c2fd1ab0"></a><!-- doxytag: member="odometry.h::CLICK_DISTANCE_UM" ref="gcf7c58b37a2d5cb3793a4f94c2fd1ab0" args="" --> |
37 |
#define </td><td class="memItemRight" valign="bottom"><b>CLICK_DISTANCE_UM</b> 204</td></tr> |
38 |
|
39 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g30e5d468b11a21497a943586ed536d81"></a><!-- doxytag: member="odometry.h::DISTANCE_SCALE" ref="g30e5d468b11a21497a943586ed536d81" args="" --> |
40 |
#define </td><td class="memItemRight" valign="bottom"><b>DISTANCE_SCALE</b> 2.10526316</td></tr> |
41 |
|
42 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7618f3a2fe3ffe816299501556cea637"></a><!-- doxytag: member="odometry.h::ANGLE_SCALE" ref="g7618f3a2fe3ffe816299501556cea637" args="" --> |
43 |
#define </td><td class="memItemRight" valign="bottom"><b>ANGLE_SCALE</b> 1.12823207</td></tr> |
44 |
|
45 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
46 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__odometry.html#g31c085285b8a8c5049123640e228741a">odometry_dx</a> (void)</td></tr> |
47 |
|
48 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the robots estimated x position. <a href="group__odometry.html#g31c085285b8a8c5049123640e228741a"></a><br></td></tr> |
49 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__odometry.html#g52bee31a0838e0a782758c90e4fa35df">odometry_dy</a> (void)</td></tr> |
50 |
|
51 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the robots estimated y position. <a href="group__odometry.html#g52bee31a0838e0a782758c90e4fa35df"></a><br></td></tr> |
52 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__odometry.html#g85a0a0b11d2adf53e2f88a836080d1f4">odometry_angle</a> (void)</td></tr> |
53 |
|
54 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the robots estimated orientation. <a href="group__odometry.html#g85a0a0b11d2adf53e2f88a836080d1f4"></a><br></td></tr> |
55 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__odometry.html#g9ccb8b57330f6769afa0f68be3a6d564">odometry_init</a> (void)</td></tr> |
56 |
|
57 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize odometry. MUST be called before the other functions work. <a href="group__odometry.html#g9ccb8b57330f6769afa0f68be3a6d564"></a><br></td></tr> |
58 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__odometry.html#g778f4744dfbdb1923b51cc43f0e9ff37">odometry_reset</a> (void)</td></tr> |
59 |
|
60 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset position and orientation to the origin facing the x axis. <a href="group__odometry.html#g778f4744dfbdb1923b51cc43f0e9ff37"></a><br></td></tr> |
61 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc958e4b80d89acf8b61a140b49353ff7"></a><!-- doxytag: member="odometry.h::odometry_velocity" ref="gc958e4b80d89acf8b61a140b49353ff7" args="(void)" --> |
62 |
long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__odometry.html#gc958e4b80d89acf8b61a140b49353ff7">odometry_velocity</a> (void)</td></tr> |
63 |
|
64 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Report estimated velocity [mm/s]. <br></td></tr> |
65 |
</table>
|
66 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
67 |
Code for estimating the robots pose. |
68 |
<p>
|
69 |
Offers simple position and orientation information.<p>
|
70 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl> |
71 |
</div>
|
72 |
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 2 23:20:08 2009 for libdragonfly by |
73 |
<a href="http://www.doxygen.org/index.html"> |
74 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> |
75 |
</body>
|
76 |
</html>
|