rtabmap/preview/pr-1492/api/latest/classrtabmap_1_1GlobalDescriptorExtractor.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::GlobalDescriptorExtractor 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_1GlobalDescriptorExtractor.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="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classrtabmap_1_1GlobalDescriptorExtractor-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">rtabmap::GlobalDescriptorExtractor Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></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:a85d6fe3e4aef5a9270cc8544c53b07a3" id="r_a85d6fe3e4aef5a9270cc8544c53b07a3"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><b>Type</b> { <b>kUndef</b> =0
, <b>kPyDescriptor</b> =1
 }</td></tr>
<tr class="separator:a85d6fe3e4aef5a9270cc8544c53b07a3"><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:af0079b90bbb342b637be7f825d7930c0" id="r_af0079b90bbb342b637be7f825d7930c0"><td class="memItemLeft" align="right" valign="top"><a id="af0079b90bbb342b637be7f825d7930c0" name="af0079b90bbb342b637be7f825d7930c0"></a>
virtual <a class="el" href="classrtabmap_1_1GlobalDescriptor.html">GlobalDescriptor</a>&#160;</td><td class="memItemRight" valign="bottom"><b>extract</b> (const <a class="el" href="classrtabmap_1_1SensorData.html">SensorData</a> &amp;data) const =0</td></tr>
<tr class="separator:af0079b90bbb342b637be7f825d7930c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affbc9bc7fc7acf7ddabd320a5a790c41" id="r_affbc9bc7fc7acf7ddabd320a5a790c41"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1GlobalDescriptorExtractor.html#affbc9bc7fc7acf7ddabd320a5a790c41">parseParameters</a> (const <a class="el" href="namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55">ParametersMap</a> &amp;parameters)</td></tr>
<tr class="separator:affbc9bc7fc7acf7ddabd320a5a790c41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c6463a1a7954219d43f6f3719b0a651" id="r_a7c6463a1a7954219d43f6f3719b0a651"><td class="memItemLeft" align="right" valign="top"><a id="a7c6463a1a7954219d43f6f3719b0a651" name="a7c6463a1a7954219d43f6f3719b0a651"></a>
virtual GlobalDescriptorExtractor::Type&#160;</td><td class="memItemRight" valign="bottom"><b>getType</b> () const =0</td></tr>
<tr class="separator:a7c6463a1a7954219d43f6f3719b0a651"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aefa3abcd36ea0b0ed00870b5e85eae54" id="r_aefa3abcd36ea0b0ed00870b5e85eae54"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1GlobalDescriptorExtractor.html#aefa3abcd36ea0b0ed00870b5e85eae54">typeName</a> (Type type)</td></tr>
<tr class="separator:aefa3abcd36ea0b0ed00870b5e85eae54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44bfe65a365474bf9d81d90b388fdc24" id="r_a44bfe65a365474bf9d81d90b388fdc24"><td class="memItemLeft" align="right" valign="top"><a id="a44bfe65a365474bf9d81d90b388fdc24" name="a44bfe65a365474bf9d81d90b388fdc24"></a>
static <a class="el" href="classrtabmap_1_1GlobalDescriptorExtractor.html">GlobalDescriptorExtractor</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>create</b> (const <a class="el" href="namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55">ParametersMap</a> &amp;parameters=<a class="el" href="namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55">ParametersMap</a>())</td></tr>
<tr class="separator:a44bfe65a365474bf9d81d90b388fdc24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a555fae5f364a27a474706c8052f0e0af" id="r_a555fae5f364a27a474706c8052f0e0af"><td class="memItemLeft" align="right" valign="top"><a id="a555fae5f364a27a474706c8052f0e0af" name="a555fae5f364a27a474706c8052f0e0af"></a>
static <a class="el" href="classrtabmap_1_1GlobalDescriptorExtractor.html">GlobalDescriptorExtractor</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>create</b> (GlobalDescriptorExtractor::Type type, const <a class="el" href="namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55">ParametersMap</a> &amp;parameters=<a class="el" href="namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55">ParametersMap</a>())</td></tr>
<tr class="separator:a555fae5f364a27a474706c8052f0e0af"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ab611952daf1e8e77d46b66b6f3fe0d0c" id="r_ab611952daf1e8e77d46b66b6f3fe0d0c"><td class="memItemLeft" align="right" valign="top"><a id="ab611952daf1e8e77d46b66b6f3fe0d0c" name="ab611952daf1e8e77d46b66b6f3fe0d0c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>GlobalDescriptorExtractor</b> (const <a class="el" href="namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55">ParametersMap</a> &amp;parameters=<a class="el" href="namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55">ParametersMap</a>())</td></tr>
<tr class="separator:ab611952daf1e8e77d46b66b6f3fe0d0c"><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="GlobalDescriptorExtractor_8h_source.html#l00040">40</a> of file <a class="el" href="GlobalDescriptorExtractor_8h_source.html">GlobalDescriptorExtractor.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a85d6fe3e4aef5a9270cc8544c53b07a3" name="a85d6fe3e4aef5a9270cc8544c53b07a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85d6fe3e4aef5a9270cc8544c53b07a3">&#9670;&#160;</a></span>Type</h2>

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

<p class="definition">Definition at line <a class="el" href="GlobalDescriptorExtractor_8h_source.html#l00042">42</a> of file <a class="el" href="GlobalDescriptorExtractor_8h_source.html">GlobalDescriptorExtractor.h</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static std::string rtabmap::GlobalDescriptorExtractor::typeName </td>
          <td>(</td>
          <td class="paramtype">Type&#160;</td>
          <td class="paramname"><em>type</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="GlobalDescriptorExtractor_8h_source.html#l00046">46</a> of file <a class="el" href="GlobalDescriptorExtractor_8h_source.html">GlobalDescriptorExtractor.h</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void rtabmap::GlobalDescriptorExtractor::parseParameters </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="namespacertabmap.html#ad08b6f1796a27dd7316c99c385e2cc55">ParametersMap</a> &amp;&#160;</td>
          <td class="paramname"><em>parameters</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="GlobalDescriptorExtractor_8h_source.html#l00064">64</a> of file <a class="el" href="GlobalDescriptorExtractor_8h_source.html">GlobalDescriptorExtractor.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="GlobalDescriptorExtractor_8h_source.html">GlobalDescriptorExtractor.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_1GlobalDescriptorExtractor.html">GlobalDescriptorExtractor</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>