Files
rtabmap/preview/pr-1492/api/latest/OdometryORBSLAM3_8h_source.html
T

179 lines
21 KiB
HTML
Raw Normal View History

<!-- HTML header for doxygen 1.9.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>RTAB-Map: corelib/include/rtabmap/core/odometry/OdometryORBSLAM3.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<script type="text/javascript">window.RTABMAP_DOC_ROOT="";</script>
<script type="text/javascript" src="../versions.js"></script>
<script type="text/javascript" src="version-switcher.js"></script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">RTAB-Map<span id="projectnumber">&#160;0.23.10</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_04d49acea3c42cab2afcd35cb2f2a48f.html">corelib</a></li><li class="navelem"><a class="el" href="dir_e996b11fd4b3a747423759b16a8ba4a6.html">include</a></li><li class="navelem"><a class="el" href="dir_ff01f7bc5399ccf9ff1cc91d1f45726a.html">rtabmap</a></li><li class="navelem"><a class="el" href="dir_884419f21456e80aa47bc1d0c2ab0140.html">core</a></li><li class="navelem"><a class="el" href="dir_fbc3350978c71aef49f2eeb1c9d88691.html">odometry</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">OdometryORBSLAM3.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">Copyright (c) 2010-2016, Mathieu Labbe - IntRoLab - Universite de Sherbrooke</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">All rights reserved.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"></span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">Redistribution and use in source and binary forms, with or without</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">modification, are permitted provided that the following conditions are met:</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * Redistributions of source code must retain the above copyright</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> notice, this list of conditions and the following disclaimer.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * Redistributions in binary form must reproduce the above copyright</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> notice, this list of conditions and the following disclaimer in the</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> documentation and/or other materials provided with the distribution.</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Neither the name of the Universite de Sherbrooke nor the</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> names of its contributors may be used to endorse or promote products</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> derived from this software without specific prior written permission.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"></span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot; AND</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment">LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment">ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment">(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment">SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment">*/</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#ifndef ODOMETRYORBSLAM3_H_</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#define ODOMETRYORBSLAM3_H_</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include &lt;rtabmap/core/Odometry.h&gt;</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#if defined(RTABMAP_ORB_SLAM) and RTABMAP_ORB_SLAM == 3</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#include &lt;System.h&gt;</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacertabmap.html">rtabmap</a> {</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="foldopen" id="foldopen00039" data-start="{" data-end="};">
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classrtabmap_1_1OdometryORBSLAM3.html"> 39</a></span><span class="keyword">class </span>RTABMAP_CORE_EXPORT <a class="code hl_class" href="classrtabmap_1_1OdometryORBSLAM3.html">OdometryORBSLAM3</a> : <span class="keyword">public</span> <a class="code hl_class" href="classrtabmap_1_1Odometry.html">Odometry</a></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span>{</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_class" href="classrtabmap_1_1OdometryORBSLAM3.html">OdometryORBSLAM3</a>(<span class="keyword">const</span> rtabmap::ParametersMap &amp; parameters = rtabmap::ParametersMap());</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classrtabmap_1_1OdometryORBSLAM3.html">~OdometryORBSLAM3</a>();</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classrtabmap_1_1OdometryORBSLAM3.html#a57626265fa4c23fab95140ca9c1f8f93"> 45</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classrtabmap_1_1OdometryORBSLAM3.html#a57626265fa4c23fab95140ca9c1f8f93">reset</a>(<span class="keyword">const</span> <a class="code hl_class" href="classrtabmap_1_1Transform.html">Transform</a> &amp; initialPose = Transform::getIdentity());</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classrtabmap_1_1OdometryORBSLAM3.html#a6a4161d9be51ff66e3571ba912655029"> 46</a></span> <span class="keyword">virtual</span> <a class="code hl_enumeration" href="classrtabmap_1_1Odometry.html#a6427d44c57fd6b7152b62d5b7cca1849">Odometry::Type</a> <a class="code hl_function" href="classrtabmap_1_1OdometryORBSLAM3.html#a6a4161d9be51ff66e3571ba912655029">getType</a>() {<span class="keywordflow">return</span> Odometry::kTypeORBSLAM;}</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="classrtabmap_1_1OdometryORBSLAM3.html#a2f226f38792f0c8bc146d73985239370"> 47</a></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classrtabmap_1_1OdometryORBSLAM3.html#a2f226f38792f0c8bc146d73985239370">canProcessAsyncIMU</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classrtabmap_1_1Transform.html">Transform</a> computeTransform(<a class="code hl_class" href="classrtabmap_1_1SensorData.html">SensorData</a> &amp; image, <span class="keyword">const</span> <a class="code hl_class" href="classrtabmap_1_1Transform.html">Transform</a> &amp; guess = <a class="code hl_class" href="classrtabmap_1_1Transform.html">Transform</a>(), <a class="code hl_class" href="classrtabmap_1_1OdometryInfo.html">OdometryInfo</a> * info = 0);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordtype">bool</span> init(<span class="keyword">const</span> <a class="code hl_class" href="classrtabmap_1_1CameraModel.html">rtabmap::CameraModel</a> &amp; model1, <span class="keyword">const</span> <a class="code hl_class" href="classrtabmap_1_1CameraModel.html">rtabmap::CameraModel</a> &amp; model2, <span class="keywordtype">double</span> stamp, <span class="keywordtype">bool</span> stereo, <span class="keywordtype">double</span> baseline);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="preprocessor">#if defined(RTABMAP_ORB_SLAM) and RTABMAP_ORB_SLAM == 3</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> ORB_SLAM3::System * orbslam_;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordtype">bool</span> firstFrame_;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <a class="code hl_class" href="classrtabmap_1_1Transform.html">Transform</a> originLocalTransform_;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <a class="code hl_class" href="classrtabmap_1_1Transform.html">Transform</a> previousPose_;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keywordtype">bool</span> useIMU_;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <a class="code hl_class" href="classrtabmap_1_1Transform.html">Transform</a> imuLocalTransform_;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> ParametersMap parameters_;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> std::vector&lt;ORB_SLAM3::IMU::Point&gt; orbslamImus_;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keywordtype">double</span> lastImuStamp_;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keywordtype">double</span> lastImageStamp_;</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span>};</div>
</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span>}</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="preprocessor">#endif </span><span class="comment">/* ODOMETRYORBSLAM_H3_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclassrtabmap_1_1CameraModel_html"><div class="ttname"><a href="classrtabmap_1_1CameraModel.html">rtabmap::CameraModel</a></div><div class="ttdoc">Represents a pinhole camera model containing intrinsic and extrinsic parameters, used for projection,...</div><div class="ttdef"><b>Definition</b> <a href="CameraModel_8h_source.html#l00052">CameraModel.h:53</a></div></div>
<div class="ttc" id="aclassrtabmap_1_1OdometryInfo_html"><div class="ttname"><a href="classrtabmap_1_1OdometryInfo.html">rtabmap::OdometryInfo</a></div><div class="ttdef"><b>Definition</b> <a href="OdometryInfo_8h_source.html#l00045">OdometryInfo.h:46</a></div></div>
<div class="ttc" id="aclassrtabmap_1_1OdometryORBSLAM3_html"><div class="ttname"><a href="classrtabmap_1_1OdometryORBSLAM3.html">rtabmap::OdometryORBSLAM3</a></div><div class="ttdef"><b>Definition</b> <a href="OdometryORBSLAM3_8h_source.html#l00039">OdometryORBSLAM3.h:40</a></div></div>
<div class="ttc" id="aclassrtabmap_1_1OdometryORBSLAM3_html_a2f226f38792f0c8bc146d73985239370"><div class="ttname"><a href="classrtabmap_1_1OdometryORBSLAM3.html#a2f226f38792f0c8bc146d73985239370">rtabmap::OdometryORBSLAM3::canProcessAsyncIMU</a></div><div class="ttdeci">virtual bool canProcessAsyncIMU() const</div></div>
<div class="ttc" id="aclassrtabmap_1_1OdometryORBSLAM3_html_a57626265fa4c23fab95140ca9c1f8f93"><div class="ttname"><a href="classrtabmap_1_1OdometryORBSLAM3.html#a57626265fa4c23fab95140ca9c1f8f93">rtabmap::OdometryORBSLAM3::reset</a></div><div class="ttdeci">virtual void reset(const Transform &amp;initialPose=Transform::getIdentity())</div><div class="ttdoc">Resets internal state and sets the initial pose.</div></div>
<div class="ttc" id="aclassrtabmap_1_1OdometryORBSLAM3_html_a6a4161d9be51ff66e3571ba912655029"><div class="ttname"><a href="classrtabmap_1_1OdometryORBSLAM3.html#a6a4161d9be51ff66e3571ba912655029">rtabmap::OdometryORBSLAM3::getType</a></div><div class="ttdeci">virtual Odometry::Type getType()</div><div class="ttdef"><b>Definition</b> <a href="OdometryORBSLAM3_8h_source.html#l00046">OdometryORBSLAM3.h:46</a></div></div>
<div class="ttc" id="aclassrtabmap_1_1Odometry_html"><div class="ttname"><a href="classrtabmap_1_1Odometry.html">rtabmap::Odometry</a></div><div class="ttdoc">Abstract base class for visual, lidar and visual-inertial odometry backends.</div><div class="ttdef"><b>Definition</b> <a href="Odometry_8h_source.html#l00056">Odometry.h:57</a></div></div>
<div class="ttc" id="aclassrtabmap_1_1Odometry_html_a6427d44c57fd6b7152b62d5b7cca1849"><div class="ttname"><a href="classrtabmap_1_1Odometry.html#a6427d44c57fd6b7152b62d5b7cca1849">rtabmap::Odometry::Type</a></div><div class="ttdeci">Type</div><div class="ttdoc">Odometry backend selected by Parameters::kOdomStrategy().</div><div class="ttdef"><b>Definition</b> <a href="Odometry_8h_source.html#l00060">Odometry.h:60</a></div></div>
<div class="ttc" id="aclassrtabmap_1_1SensorData_html"><div class="ttname"><a href="classrtabmap_1_1SensorData.html">rtabmap::SensorData</a></div><div class="ttdoc">Container class for all sensor data captured at a specific time.</div><div class="ttdef"><b>Definition</b> <a href="SensorData_8h_source.html#l00096">SensorData.h:97</a></div></div>
<div class="ttc" id="aclassrtabmap_1_1Transform_html"><div class="ttname"><a href="classrtabmap_1_1Transform.html">rtabmap::Transform</a></div><div class="ttdoc">Represents a 3D rigid body transformation (rotation + translation).</div><div class="ttdef"><b>Definition</b> <a href="Transform_8h_source.html#l00052">Transform.h:53</a></div></div>
<div class="ttc" id="anamespacertabmap_html"><div class="ttname"><a href="namespacertabmap.html">rtabmap</a></div><div class="ttdef"><b>Definition</b> <a href="BayesFilter_8h_source.html#l00039">BayesFilter.h:39</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>