mirror of
https://github.com/introlab/rtabmap.git
synced 2026-10-04 09:07:47 +08:00
Preview for PR #1492 25b41788677116f6905c26584214a5e014292ec9
This commit is contained in:
@@ -0,0 +1,363 @@
|
||||
<!-- 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::Parameters 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="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"> 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&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&dn=expat.txt MIT */
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
<!-- 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="namespacertabmap.html">rtabmap</a></li><li class="navelem"><a class="el" href="classrtabmap_1_1Parameters.html">Parameters</a></li> </ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
||||
<a href="classrtabmap_1_1Parameters-members.html">List of all members</a> </div>
|
||||
<div class="headertitle"><div class="title">rtabmap::Parameters Class Reference</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p><code>#include <<a class="el" href="Parameters_8h_source.html">Parameters.h</a>></code></p>
|
||||
<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:a3921b82495e0308f8cfcbdb8ef072e21" id="r_a3921b82495e0308f8cfcbdb8ef072e21"><td class="memItemLeft" align="right" valign="top">static const ParametersMap & </td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1Parameters.html#a3921b82495e0308f8cfcbdb8ef072e21">getDefaultParameters</a> ()</td></tr>
|
||||
<tr class="separator:a3921b82495e0308f8cfcbdb8ef072e21"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a08f4ea48ac7dbd93cb322d1c89b455b0" id="r_a08f4ea48ac7dbd93cb322d1c89b455b0"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1Parameters.html#a08f4ea48ac7dbd93cb322d1c89b455b0">getType</a> (const std::string &paramKey)</td></tr>
|
||||
<tr class="separator:a08f4ea48ac7dbd93cb322d1c89b455b0"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a7aacfe3e18e28a1fb81d0f3f0ffbb414" id="r_a7aacfe3e18e28a1fb81d0f3f0ffbb414"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1Parameters.html#a7aacfe3e18e28a1fb81d0f3f0ffbb414">getDescription</a> (const std::string &paramKey)</td></tr>
|
||||
<tr class="separator:a7aacfe3e18e28a1fb81d0f3f0ffbb414"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac2d0a1d5a2c6a0eb35f890bf32b0fb6b" id="r_ac2d0a1d5a2c6a0eb35f890bf32b0fb6b"><td class="memItemLeft" align="right" valign="top"><a id="ac2d0a1d5a2c6a0eb35f890bf32b0fb6b" name="ac2d0a1d5a2c6a0eb35f890bf32b0fb6b"></a>
|
||||
static bool </td><td class="memItemRight" valign="bottom"><b>parse</b> (const ParametersMap &parameters, const std::string &key, bool &value)</td></tr>
|
||||
<tr class="separator:ac2d0a1d5a2c6a0eb35f890bf32b0fb6b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aee607be3b7cdceda5384e8b0067b1383" id="r_aee607be3b7cdceda5384e8b0067b1383"><td class="memItemLeft" align="right" valign="top"><a id="aee607be3b7cdceda5384e8b0067b1383" name="aee607be3b7cdceda5384e8b0067b1383"></a>
|
||||
static bool </td><td class="memItemRight" valign="bottom"><b>parse</b> (const ParametersMap &parameters, const std::string &key, int &value)</td></tr>
|
||||
<tr class="separator:aee607be3b7cdceda5384e8b0067b1383"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a26de8e6d156bd4b9e958eadb2b95acd8" id="r_a26de8e6d156bd4b9e958eadb2b95acd8"><td class="memItemLeft" align="right" valign="top"><a id="a26de8e6d156bd4b9e958eadb2b95acd8" name="a26de8e6d156bd4b9e958eadb2b95acd8"></a>
|
||||
static bool </td><td class="memItemRight" valign="bottom"><b>parse</b> (const ParametersMap &parameters, const std::string &key, unsigned int &value)</td></tr>
|
||||
<tr class="separator:a26de8e6d156bd4b9e958eadb2b95acd8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa2778211b266c6ff164a1ad2207a06f9" id="r_aa2778211b266c6ff164a1ad2207a06f9"><td class="memItemLeft" align="right" valign="top"><a id="aa2778211b266c6ff164a1ad2207a06f9" name="aa2778211b266c6ff164a1ad2207a06f9"></a>
|
||||
static bool </td><td class="memItemRight" valign="bottom"><b>parse</b> (const ParametersMap &parameters, const std::string &key, float &value)</td></tr>
|
||||
<tr class="separator:aa2778211b266c6ff164a1ad2207a06f9"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a827de39e089f1294d59b9f46b696ff78" id="r_a827de39e089f1294d59b9f46b696ff78"><td class="memItemLeft" align="right" valign="top"><a id="a827de39e089f1294d59b9f46b696ff78" name="a827de39e089f1294d59b9f46b696ff78"></a>
|
||||
static bool </td><td class="memItemRight" valign="bottom"><b>parse</b> (const ParametersMap &parameters, const std::string &key, double &value)</td></tr>
|
||||
<tr class="separator:a827de39e089f1294d59b9f46b696ff78"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a2c0c7a722852041367e492c7546dca25" id="r_a2c0c7a722852041367e492c7546dca25"><td class="memItemLeft" align="right" valign="top"><a id="a2c0c7a722852041367e492c7546dca25" name="a2c0c7a722852041367e492c7546dca25"></a>
|
||||
static bool </td><td class="memItemRight" valign="bottom"><b>parse</b> (const ParametersMap &parameters, const std::string &key, std::string &value)</td></tr>
|
||||
<tr class="separator:a2c0c7a722852041367e492c7546dca25"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a67499f69de9d4083c0f558482fab6354" id="r_a67499f69de9d4083c0f558482fab6354"><td class="memItemLeft" align="right" valign="top"><a id="a67499f69de9d4083c0f558482fab6354" name="a67499f69de9d4083c0f558482fab6354"></a>
|
||||
static void </td><td class="memItemRight" valign="bottom"><b>parse</b> (const ParametersMap &parameters, ParametersMap &parametersOut)</td></tr>
|
||||
<tr class="separator:a67499f69de9d4083c0f558482fab6354"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ae8334c3f96ae62c53a44e214291a1a55" id="r_ae8334c3f96ae62c53a44e214291a1a55"><td class="memItemLeft" align="right" valign="top"><a id="ae8334c3f96ae62c53a44e214291a1a55" name="ae8334c3f96ae62c53a44e214291a1a55"></a>
|
||||
static const char * </td><td class="memItemRight" valign="bottom"><b>showUsage</b> ()</td></tr>
|
||||
<tr class="separator:ae8334c3f96ae62c53a44e214291a1a55"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a29c603e4fa43de65410f68177dfabd1f" id="r_a29c603e4fa43de65410f68177dfabd1f"><td class="memItemLeft" align="right" valign="top"><a id="a29c603e4fa43de65410f68177dfabd1f" name="a29c603e4fa43de65410f68177dfabd1f"></a>
|
||||
static ParametersMap </td><td class="memItemRight" valign="bottom"><b>parseArguments</b> (int argc, char *argv[], bool onlyParameters=false)</td></tr>
|
||||
<tr class="separator:a29c603e4fa43de65410f68177dfabd1f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:acea8e9b0545d81e133df5f9003cfebd6" id="r_acea8e9b0545d81e133df5f9003cfebd6"><td class="memItemLeft" align="right" valign="top"><a id="acea8e9b0545d81e133df5f9003cfebd6" name="acea8e9b0545d81e133df5f9003cfebd6"></a>
|
||||
static std::string </td><td class="memItemRight" valign="bottom"><b>getVersion</b> ()</td></tr>
|
||||
<tr class="separator:acea8e9b0545d81e133df5f9003cfebd6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:afdde408b7fd3ea213928e217bdf16d07" id="r_afdde408b7fd3ea213928e217bdf16d07"><td class="memItemLeft" align="right" valign="top"><a id="afdde408b7fd3ea213928e217bdf16d07" name="afdde408b7fd3ea213928e217bdf16d07"></a>
|
||||
static std::string </td><td class="memItemRight" valign="bottom"><b>getDefaultDatabaseName</b> ()</td></tr>
|
||||
<tr class="separator:afdde408b7fd3ea213928e217bdf16d07"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a2846e0206ea0a49334306b06ebe5d68f" id="r_a2846e0206ea0a49334306b06ebe5d68f"><td class="memItemLeft" align="right" valign="top"><a id="a2846e0206ea0a49334306b06ebe5d68f" name="a2846e0206ea0a49334306b06ebe5d68f"></a>
|
||||
static std::string </td><td class="memItemRight" valign="bottom"><b>serialize</b> (const ParametersMap &parameters)</td></tr>
|
||||
<tr class="separator:a2846e0206ea0a49334306b06ebe5d68f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a04cdc3d32b8ce6d45028a61cbb5a6dd5" id="r_a04cdc3d32b8ce6d45028a61cbb5a6dd5"><td class="memItemLeft" align="right" valign="top"><a id="a04cdc3d32b8ce6d45028a61cbb5a6dd5" name="a04cdc3d32b8ce6d45028a61cbb5a6dd5"></a>
|
||||
static ParametersMap </td><td class="memItemRight" valign="bottom"><b>deserialize</b> (const std::string &parameters)</td></tr>
|
||||
<tr class="separator:a04cdc3d32b8ce6d45028a61cbb5a6dd5"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a19b08ace8778d65c8ca75a5eef27f8e8" id="r_a19b08ace8778d65c8ca75a5eef27f8e8"><td class="memItemLeft" align="right" valign="top"><a id="a19b08ace8778d65c8ca75a5eef27f8e8" name="a19b08ace8778d65c8ca75a5eef27f8e8"></a>
|
||||
static bool </td><td class="memItemRight" valign="bottom"><b>isFeatureParameter</b> (const std::string &param)</td></tr>
|
||||
<tr class="separator:a19b08ace8778d65c8ca75a5eef27f8e8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9151a491f69d97383ff0ecf3b1099de7" id="r_a9151a491f69d97383ff0ecf3b1099de7"><td class="memItemLeft" align="right" valign="top"><a id="a9151a491f69d97383ff0ecf3b1099de7" name="a9151a491f69d97383ff0ecf3b1099de7"></a>
|
||||
static ParametersMap </td><td class="memItemRight" valign="bottom"><b>getDefaultOdometryParameters</b> (bool stereo=false, bool vis=true, bool icp=false)</td></tr>
|
||||
<tr class="separator:a9151a491f69d97383ff0ecf3b1099de7"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a444d703ab1bb69aa97a8a572713ce373" id="r_a444d703ab1bb69aa97a8a572713ce373"><td class="memItemLeft" align="right" valign="top"><a id="a444d703ab1bb69aa97a8a572713ce373" name="a444d703ab1bb69aa97a8a572713ce373"></a>
|
||||
static ParametersMap </td><td class="memItemRight" valign="bottom"><b>getDefaultParameters</b> (const std::string &group)</td></tr>
|
||||
<tr class="separator:a444d703ab1bb69aa97a8a572713ce373"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a24faced7b8d2ebb7045cd6f8f6382ad7" id="r_a24faced7b8d2ebb7045cd6f8f6382ad7"><td class="memItemLeft" align="right" valign="top">static ParametersMap </td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1Parameters.html#a24faced7b8d2ebb7045cd6f8f6382ad7">filterParameters</a> (const ParametersMap &parameters, const std::string &group, bool remove=false)</td></tr>
|
||||
<tr class="separator:a24faced7b8d2ebb7045cd6f8f6382ad7"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:accc76111f7c590bec371233f192b96cf" id="r_accc76111f7c590bec371233f192b96cf"><td class="memItemLeft" align="right" valign="top"><a id="accc76111f7c590bec371233f192b96cf" name="accc76111f7c590bec371233f192b96cf"></a>
|
||||
static void </td><td class="memItemRight" valign="bottom"><b>readINI</b> (const std::string &configFile, ParametersMap &parameters, bool modifiedOnly=false)</td></tr>
|
||||
<tr class="separator:accc76111f7c590bec371233f192b96cf"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a4bbaf3429e9edd2898521f35a92caa85" id="r_a4bbaf3429e9edd2898521f35a92caa85"><td class="memItemLeft" align="right" valign="top"><a id="a4bbaf3429e9edd2898521f35a92caa85" name="a4bbaf3429e9edd2898521f35a92caa85"></a>
|
||||
static void </td><td class="memItemRight" valign="bottom"><b>readINIStr</b> (const std::string &configContent, ParametersMap &parameters, bool modifiedOnly=false)</td></tr>
|
||||
<tr class="separator:a4bbaf3429e9edd2898521f35a92caa85"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a2d874bd517313a7c631c750a3720cbb3" id="r_a2d874bd517313a7c631c750a3720cbb3"><td class="memItemLeft" align="right" valign="top"><a id="a2d874bd517313a7c631c750a3720cbb3" name="a2d874bd517313a7c631c750a3720cbb3"></a>
|
||||
static void </td><td class="memItemRight" valign="bottom"><b>writeINI</b> (const std::string &configFile, const ParametersMap &parameters)</td></tr>
|
||||
<tr class="separator:a2d874bd517313a7c631c750a3720cbb3"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ae3e84e415669d8c8bf17b119683b1056" id="r_ae3e84e415669d8c8bf17b119683b1056"><td class="memItemLeft" align="right" valign="top">static const std::map< std::string, std::pair< bool, std::string > > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1Parameters.html#ae3e84e415669d8c8bf17b119683b1056">getRemovedParameters</a> ()</td></tr>
|
||||
<tr class="separator:ae3e84e415669d8c8bf17b119683b1056"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a66c12cd1e2e614cc5c987cf7f0dbe2be" id="r_a66c12cd1e2e614cc5c987cf7f0dbe2be"><td class="memItemLeft" align="right" valign="top">static const ParametersMap & </td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1Parameters.html#a66c12cd1e2e614cc5c987cf7f0dbe2be">getBackwardCompatibilityMap</a> ()</td></tr>
|
||||
<tr class="separator:a66c12cd1e2e614cc5c987cf7f0dbe2be"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a28f4a27d2b537f0b3e2dd67bea048b5c" id="r_a28f4a27d2b537f0b3e2dd67bea048b5c"><td class="memItemLeft" align="right" valign="top"><a id="a28f4a27d2b537f0b3e2dd67bea048b5c" name="a28f4a27d2b537f0b3e2dd67bea048b5c"></a>
|
||||
static std::string </td><td class="memItemRight" valign="bottom"><b>createDefaultWorkingDirectory</b> ()</td></tr>
|
||||
<tr class="separator:a28f4a27d2b537f0b3e2dd67bea048b5c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Class <a class="el" href="classrtabmap_1_1Parameters.html">Parameters</a>. This class is used to manage all custom parameters we want in the application. It was designed to be very easy to add a new parameter (just by adding one line of code). The macro PARAM(PREFIX, NAME, TYPE, DEFAULT_VALUE) is used to create a parameter in this class. A parameter can be accessed after by Parameters::defaultPARAMETERNAME() for the default value, Parameters::kPARAMETERNAME for his key (parameter name). The class provides also a general map containing all the parameter's key and default value. This map can be accessed anywhere in the application by <a class="el" href="classrtabmap_1_1Parameters.html#a3921b82495e0308f8cfcbdb8ef072e21">Parameters::getDefaultParameters()</a>; Example: </p><div class="fragment"><div class="line"><span class="comment">//Defining a parameter in this class with the macro PARAM:</span></div>
|
||||
<div class="line">PARAM(Video, ImageWidth, <span class="keywordtype">int</span>, 640);</div>
|
||||
<div class="line"> </div>
|
||||
<div class="line"><span class="comment">// Now from anywhere in the application (Parameters is a singleton)</span></div>
|
||||
<div class="line"><span class="keywordtype">int</span> width = Parameters::defaultVideoImageWidth(); <span class="comment">// theDefaultValue = 640</span></div>
|
||||
<div class="line">std::string theKey = Parameters::kVideoImageWidth(); <span class="comment">// theKey = "Video/ImageWidth"</span></div>
|
||||
<div class="line">std::string strValue = Util::value(<a class="code hl_function" href="classrtabmap_1_1Parameters.html#a3921b82495e0308f8cfcbdb8ef072e21">Parameters::getDefaultParameters</a>(), theKey); <span class="comment">// strValue = "640"</span></div>
|
||||
<div class="ttc" id="aclassrtabmap_1_1Parameters_html_a3921b82495e0308f8cfcbdb8ef072e21"><div class="ttname"><a href="classrtabmap_1_1Parameters.html#a3921b82495e0308f8cfcbdb8ef072e21">rtabmap::Parameters::getDefaultParameters</a></div><div class="ttdeci">static const ParametersMap & getDefaultParameters()</div><div class="ttdef"><b>Definition</b> <a href="Parameters_8h_source.html#l00978">Parameters.h:978</a></div></div>
|
||||
</div><!-- fragment --> <dl class="section see"><dt>See also</dt><dd><a class="el" href="classrtabmap_1_1Parameters.html#a3921b82495e0308f8cfcbdb8ef072e21">getDefaultParameters()</a> TODO Add a detailed example with simple classes </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="Parameters_8h_source.html#l00170">170</a> of file <a class="el" href="Parameters_8h_source.html">Parameters.h</a>.</p>
|
||||
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a id="a3921b82495e0308f8cfcbdb8ef072e21" name="a3921b82495e0308f8cfcbdb8ef072e21"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a3921b82495e0308f8cfcbdb8ef072e21">◆ </a></span>getDefaultParameters()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">static const ParametersMap & rtabmap::Parameters::getDefaultParameters </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></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>Get default parameters </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="Parameters_8h_source.html#l00978">978</a> of file <a class="el" href="Parameters_8h_source.html">Parameters.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a08f4ea48ac7dbd93cb322d1c89b455b0" name="a08f4ea48ac7dbd93cb322d1c89b455b0"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a08f4ea48ac7dbd93cb322d1c89b455b0">◆ </a></span>getType()</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::Parameters::getType </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const std::string & </td>
|
||||
<td class="paramname"><em>paramKey</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Get parameter type </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a7aacfe3e18e28a1fb81d0f3f0ffbb414" name="a7aacfe3e18e28a1fb81d0f3f0ffbb414"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a7aacfe3e18e28a1fb81d0f3f0ffbb414">◆ </a></span>getDescription()</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::Parameters::getDescription </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const std::string & </td>
|
||||
<td class="paramname"><em>paramKey</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Get parameter description </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a24faced7b8d2ebb7045cd6f8f6382ad7" name="a24faced7b8d2ebb7045cd6f8f6382ad7"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a24faced7b8d2ebb7045cd6f8f6382ad7">◆ </a></span>filterParameters()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">static ParametersMap rtabmap::Parameters::filterParameters </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const ParametersMap & </td>
|
||||
<td class="paramname"><em>parameters</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const std::string & </td>
|
||||
<td class="paramname"><em>group</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">bool </td>
|
||||
<td class="paramname"><em>remove</em> = <code>false</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>If remove=false: keep only parameters of the specified group. If remove=true: remove parameters of the specified group. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ae3e84e415669d8c8bf17b119683b1056" name="ae3e84e415669d8c8bf17b119683b1056"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ae3e84e415669d8c8bf17b119683b1056">◆ </a></span>getRemovedParameters()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">static const std::map< std::string, std::pair< bool, std::string > > & rtabmap::Parameters::getRemovedParameters </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Get removed parameters (backward compatibility) <OldKeyName, <isEqual, NewKeyName> >, when isEqual=true, the old value can be safely copied to new parameter </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a66c12cd1e2e614cc5c987cf7f0dbe2be" name="a66c12cd1e2e614cc5c987cf7f0dbe2be"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a66c12cd1e2e614cc5c987cf7f0dbe2be">◆ </a></span>getBackwardCompatibilityMap()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">static const ParametersMap & rtabmap::Parameters::getBackwardCompatibilityMap </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p><NewKeyName, OldKeyName> </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="Parameters_8h_source.html">Parameters.h</a></li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
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
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user