rtabmap/preview/pr-1492/api/latest/classrtabmap_1_1FlannIndex.html

<!-- 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: rtabmap::FlannIndex Class Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="custom.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>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">DoxygenAwesomeDarkModeToggle.init();</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>
   <div id="projectbrief">Real-Time Appearance-Based Mapping</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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classrtabmap_1_1FlannIndex.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classrtabmap_1_1FlannIndex-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">rtabmap::FlannIndex Class Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a88ddfe63de9e9f574ac804ade460f010" id="r_a88ddfe63de9e9f574ac804ade460f010"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><b>flann_algorithm_t</b> { <b>FLANN_INDEX_LINEAR</b> = 0
, <b>FLANN_INDEX_KDTREE</b> = 1
, <b>FLANN_INDEX_KDTREE_SINGLE</b> = 4
, <b>FLANN_INDEX_LSH</b> = 6
 }</td></tr>
<tr class="separator:a88ddfe63de9e9f574ac804ade460f010"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6eb4692afb561932aa6a20f7ebdee6c4" id="r_a6eb4692afb561932aa6a20f7ebdee6c4"><td class="memItemLeft" align="right" valign="top"><a id="a6eb4692afb561932aa6a20f7ebdee6c4" name="a6eb4692afb561932aa6a20f7ebdee6c4"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>release</b> ()</td></tr>
<tr class="separator:a6eb4692afb561932aa6a20f7ebdee6c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f2bf8718a75aa0b5dded8c287293c23" id="r_a1f2bf8718a75aa0b5dded8c287293c23"><td class="memItemLeft" align="right" valign="top"><a id="a1f2bf8718a75aa0b5dded8c287293c23" name="a1f2bf8718a75aa0b5dded8c287293c23"></a>
std::vector&lt; unsigned char &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>serializeIndex</b> (bool computeChecksum=true) const</td></tr>
<tr class="separator:a1f2bf8718a75aa0b5dded8c287293c23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a759817fbddaf8c6bdb04ba0a44e9847a" id="r_a759817fbddaf8c6bdb04ba0a44e9847a"><td class="memItemLeft" align="right" valign="top"><a id="a759817fbddaf8c6bdb04ba0a44e9847a" name="a759817fbddaf8c6bdb04ba0a44e9847a"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>indexedFeatures</b> () const</td></tr>
<tr class="separator:a759817fbddaf8c6bdb04ba0a44e9847a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a2eed18fe1216142d09c05243e9d06f" id="r_a5a2eed18fe1216142d09c05243e9d06f"><td class="memItemLeft" align="right" valign="top"><a id="a5a2eed18fe1216142d09c05243e9d06f" name="a5a2eed18fe1216142d09c05243e9d06f"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>memoryUsed</b> () const</td></tr>
<tr class="separator:a5a2eed18fe1216142d09c05243e9d06f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad2f29314c6b021d1c53217a7a041521" id="r_aad2f29314c6b021d1c53217a7a041521"><td class="memItemLeft" align="right" valign="top"><a id="aad2f29314c6b021d1c53217a7a041521" name="aad2f29314c6b021d1c53217a7a041521"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>buildIndex</b> (flann_algorithm_t algorithm, const cv::Mat &amp;features, bool useDistanceL1=false, float rebalancingFactor=2.0f)</td></tr>
<tr class="separator:aad2f29314c6b021d1c53217a7a041521"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a826b3a33e22f455f04688df9d0d25b0b" id="r_a826b3a33e22f455f04688df9d0d25b0b"><td class="memItemLeft" align="right" valign="top"><a id="a826b3a33e22f455f04688df9d0d25b0b" name="a826b3a33e22f455f04688df9d0d25b0b"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>loadIndex</b> (const std::vector&lt; unsigned char &gt; &amp;indexData, flann_algorithm_t algorithm, const cv::Mat &amp;features, bool useDistanceL1=false, float rebalancingFactor=2.0f, std::string *errorMsg=NULL)</td></tr>
<tr class="separator:a826b3a33e22f455f04688df9d0d25b0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a028eac4aeef64d62b9edea1f7b38a71e" id="r_a028eac4aeef64d62b9edea1f7b38a71e"><td class="memItemLeft" align="right" valign="top"><a id="a028eac4aeef64d62b9edea1f7b38a71e" name="a028eac4aeef64d62b9edea1f7b38a71e"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>loadIndex</b> (const unsigned char *indexData, size_t indexDataSize, flann_algorithm_t algorithm, const cv::Mat &amp;features, bool useDistanceL1=false, float rebalancingFactor=2.0f, std::string *errorMsg=NULL)</td></tr>
<tr class="separator:a028eac4aeef64d62b9edea1f7b38a71e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a5c33446a515bd8f0c2f73a1adaeb23" id="r_a4a5c33446a515bd8f0c2f73a1adaeb23"><td class="memItemLeft" align="right" valign="top"><a id="a4a5c33446a515bd8f0c2f73a1adaeb23" name="a4a5c33446a515bd8f0c2f73a1adaeb23"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>isBuilt</b> ()</td></tr>
<tr class="separator:a4a5c33446a515bd8f0c2f73a1adaeb23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace329768df8b54b935fbe7a8921efe69" id="r_ace329768df8b54b935fbe7a8921efe69"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1FlannIndex.html#ace329768df8b54b935fbe7a8921efe69">featuresType</a> () const</td></tr>
<tr class="separator:ace329768df8b54b935fbe7a8921efe69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8191e3ba9cc7a5361443430171691df3" id="r_a8191e3ba9cc7a5361443430171691df3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1FlannIndex.html#a8191e3ba9cc7a5361443430171691df3">featuresDim</a> () const</td></tr>
<tr class="separator:a8191e3ba9cc7a5361443430171691df3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bd8312e92376d6bf2885907f5d93c68" id="r_a8bd8312e92376d6bf2885907f5d93c68"><td class="memItemLeft" align="right" valign="top"><a id="a8bd8312e92376d6bf2885907f5d93c68" name="a8bd8312e92376d6bf2885907f5d93c68"></a>
std::vector&lt; unsigned int &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>addPoints</b> (const cv::Mat &amp;features)</td></tr>
<tr class="separator:a8bd8312e92376d6bf2885907f5d93c68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d78d049ac4afb9f90fc0705506a6ce0" id="r_a7d78d049ac4afb9f90fc0705506a6ce0"><td class="memItemLeft" align="right" valign="top"><a id="a7d78d049ac4afb9f90fc0705506a6ce0" name="a7d78d049ac4afb9f90fc0705506a6ce0"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>removePoint</b> (unsigned int index)</td></tr>
<tr class="separator:a7d78d049ac4afb9f90fc0705506a6ce0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accf263b21aaacf3d00e6e73ccef5cc75" id="r_accf263b21aaacf3d00e6e73ccef5cc75"><td class="memItemLeft" align="right" valign="top"><a id="accf263b21aaacf3d00e6e73ccef5cc75" name="accf263b21aaacf3d00e6e73ccef5cc75"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>knnSearch</b> (const cv::Mat &amp;query, cv::Mat &amp;indices, cv::Mat &amp;dists, int knn, int checks=32, float eps=0.0, bool sorted=true) const</td></tr>
<tr class="separator:accf263b21aaacf3d00e6e73ccef5cc75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37bb608ab9ae1e7db35c2681a0c17eb5" id="r_a37bb608ab9ae1e7db35c2681a0c17eb5"><td class="memItemLeft" align="right" valign="top"><a id="a37bb608ab9ae1e7db35c2681a0c17eb5" name="a37bb608ab9ae1e7db35c2681a0c17eb5"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>radiusSearch</b> (const cv::Mat &amp;query, std::vector&lt; std::vector&lt; size_t &gt; &gt; &amp;indices, std::vector&lt; std::vector&lt; float &gt; &gt; &amp;dists, float radius, int maxNeighbors=0, int checks=32, float eps=0.0, bool sorted=true) const</td></tr>
<tr class="separator:a37bb608ab9ae1e7db35c2681a0c17eb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="FlannIndex_8h_source.html#l00037">37</a> of file <a class="el" href="FlannIndex_8h_source.html">FlannIndex.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a88ddfe63de9e9f574ac804ade460f010" name="a88ddfe63de9e9f574ac804ade460f010"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88ddfe63de9e9f574ac804ade460f010">&#9670;&#160;</a></span>flann_algorithm_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum rtabmap::FlannIndex::flann_algorithm_t</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="FlannIndex_8h_source.html#l00041">41</a> of file <a class="el" href="FlannIndex_8h_source.html">FlannIndex.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ace329768df8b54b935fbe7a8921efe69" name="ace329768df8b54b935fbe7a8921efe69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace329768df8b54b935fbe7a8921efe69">&#9670;&#160;</a></span>featuresType()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int rtabmap::FlannIndex::featuresType </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="FlannIndex_8h_source.html#l00085">85</a> of file <a class="el" href="FlannIndex_8h_source.html">FlannIndex.h</a>.</p>

</div>
</div>
<a id="a8191e3ba9cc7a5361443430171691df3" name="a8191e3ba9cc7a5361443430171691df3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8191e3ba9cc7a5361443430171691df3">&#9670;&#160;</a></span>featuresDim()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int rtabmap::FlannIndex::featuresDim </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="FlannIndex_8h_source.html#l00086">86</a> of file <a class="el" href="FlannIndex_8h_source.html">FlannIndex.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>corelib/include/rtabmap/core/<a class="el" href="FlannIndex_8h_source.html">FlannIndex.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespacertabmap.html">rtabmap</a></li><li class="navelem"><a class="el" href="classrtabmap_1_1FlannIndex.html">FlannIndex</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
  </ul>
</div>
</body>
</html>