i/rtabmap
1
0
Fork 0
mirror of https://github.com/introlab/rtabmap.git synced 2026-10-07 10:37:47 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation (latest) f647014f54

Browse Source
This commit is contained in:
github-actions[bot]
2026-08-16 17:18:46 +00:00
parent b5d349f1f0
commit 5fd30cd7da
99 changed files with 4037 additions and 3352 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/latest/classrtabmap_1_1Parameters.html
+10 -10
View File
@@ -687,7 +687,7 @@ Static Public Member Functions</h2></td></tr>
<tr class="memdesc:aa01d5fdd8fd13161fffbccd2418d4985"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of parameter Mem/RotateImagesUpsideUp , as a string: bool . <br /></td></tr>
<tr class="separator:aa01d5fdd8fd13161fffbccd2418d4985"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a994321ccf32f126b6781aa1925a5fa66" id="r_a994321ccf32f126b6781aa1925a5fa66"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1Parameters.html#a994321ccf32f126b6781aa1925a5fa66">kKpNNStrategy</a> ()</td></tr>
<tr class="memdesc:a994321ccf32f126b6781aa1925a5fa66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key of parameter Kp/NNStrategy : "kNNFlannNaive=0, kNNFlannKdTree=1, kNNFlannLSH=2, kNNBruteForce=3, kNNBruteForceGPU=4" Default value: 1 ( int ). <br /></td></tr>
<tr class="memdesc:a994321ccf32f126b6781aa1925a5fa66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key of parameter Kp/NNStrategy : "FLANN Linear=0, FLANN KdTree=1, FLANN LSH=2, Brute Force=3, Brute Force GPU=4, FLANN KdTree Single=5, NanoFLANN KdTree=6" Default value: 1 ( int ). <br /></td></tr>
<tr class="separator:a994321ccf32f126b6781aa1925a5fa66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2df3c573a24040a99c2204b15d40b3af" id="r_a2df3c573a24040a99c2204b15d40b3af"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1Parameters.html#a2df3c573a24040a99c2204b15d40b3af">defaultKpNNStrategy</a> ()</td></tr>
<tr class="memdesc:a2df3c573a24040a99c2204b15d40b3af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default value of parameter Kp/NNStrategy : 1 . <br /></td></tr>
@@ -705,7 +705,7 @@ Static Public Member Functions</h2></td></tr>
<tr class="memdesc:a9aa02c3425918b1b506575caa9346c90"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of parameter Kp/IncrementalDictionary , as a string: bool . <br /></td></tr>
<tr class="separator:a9aa02c3425918b1b506575caa9346c90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a092387f2a424c8db4f2482742b0b0fb9" id="r_a092387f2a424c8db4f2482742b0b0fb9"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1Parameters.html#a092387f2a424c8db4f2482742b0b0fb9">kKpIncrementalFlann</a> ()</td></tr>
<tr class="memdesc:a092387f2a424c8db4f2482742b0b0fb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key of parameter Kp/IncrementalFlann : uFormat("When using FLANN based strategy, add/remove points to its index without always rebuilding the index (the index is built only when the dictionary increases of the factor \"%s\" in size).", <a class="el" href="classrtabmap_1_1Parameters.html#a17550d1f1b862a621c409d4e12c7696b" title="Key of parameter Kp/FlannRebalancingFactor : uFormat(&quot;Factor used when rebuilding the incremental FLA...">kKpFlannRebalancingFactor()</a>.c_str()) Default value: true ( bool ). <br /></td></tr>
<tr class="memdesc:a092387f2a424c8db4f2482742b0b0fb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key of parameter Kp/IncrementalFlann : uFormat("When using FLANN based strategy, add/remove points to its index without always rebuilding the index (the index is only rebuilt when too many of its features have been removed, see \"%s\").", <a class="el" href="classrtabmap_1_1Parameters.html#a17550d1f1b862a621c409d4e12c7696b" title="Key of parameter Kp/FlannRebalancingFactor : uFormat(&quot;Rebuild the incremental FLANN index (see \&quot;%s\&quot;...">kKpFlannRebalancingFactor()</a>.c_str()) Default value: true ( bool ). <br /></td></tr>
<tr class="separator:a092387f2a424c8db4f2482742b0b0fb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66f0bded3fc68132c461caec2347d740" id="r_a66f0bded3fc68132c461caec2347d740"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1Parameters.html#a66f0bded3fc68132c461caec2347d740">defaultKpIncrementalFlann</a> ()</td></tr>
<tr class="memdesc:a66f0bded3fc68132c461caec2347d740"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default value of parameter Kp/IncrementalFlann : true . <br /></td></tr>
@@ -714,7 +714,7 @@ Static Public Member Functions</h2></td></tr>
<tr class="memdesc:ab209736974cc9fcf74a1159e25f103a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of parameter Kp/IncrementalFlann , as a string: bool . <br /></td></tr>
<tr class="separator:ab209736974cc9fcf74a1159e25f103a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17550d1f1b862a621c409d4e12c7696b" id="r_a17550d1f1b862a621c409d4e12c7696b"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1Parameters.html#a17550d1f1b862a621c409d4e12c7696b">kKpFlannRebalancingFactor</a> ()</td></tr>
<tr class="memdesc:a17550d1f1b862a621c409d4e12c7696b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key of parameter Kp/FlannRebalancingFactor : uFormat("Factor used when rebuilding the incremental FLANN index (see \"%s\"). Set &lt;=1 to disable.", <a class="el" href="classrtabmap_1_1Parameters.html#a092387f2a424c8db4f2482742b0b0fb9" title="Key of parameter Kp/IncrementalFlann : uFormat(&quot;When using FLANN based strategy, add/remove points to...">kKpIncrementalFlann()</a>.c_str()) Default value: 2.0 ( float ). <br /></td></tr>
<tr class="memdesc:a17550d1f1b862a621c409d4e12c7696b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key of parameter Kp/FlannRebalancingFactor : uFormat("Rebuild the incremental FLANN index (see \"%s\") once the ratio (factor-1)/factor of its features has been removed, e.g. half of them for a factor of 2. Rebuilding frees the memory of the removed features and speeds up the searches. Features are mostly removed when memory management is enabled (\"%s\" or \"%s\"). Set to 1 to never rebuild, which also uses less memory as the features don't have to be referenced one by one.", <a class="el" href="classrtabmap_1_1Parameters.html#a092387f2a424c8db4f2482742b0b0fb9" title="Key of parameter Kp/IncrementalFlann : uFormat(&quot;When using FLANN based strategy, add/remove points to...">kKpIncrementalFlann()</a>.c_str(), <a class="el" href="classrtabmap_1_1Parameters.html#a8ee7e153cfb26574c7d1c7b427593f8a" title="Key of parameter Rtabmap/TimeThr : &quot;Maximum time allowed for map update (ms) (0 means infinity)....">kRtabmapTimeThr()</a>.c_str(), <a class="el" href="classrtabmap_1_1Parameters.html#a66882ccd6f0a49f2c23db8718d12a59c" title="Key of parameter Rtabmap/MemoryThr : uFormat(&quot;Maximum nodes in the Working Memory (0 means infinity)....">kRtabmapMemoryThr()</a>.c_str()) Default value: 2.0 ( float ). <br /></td></tr>
<tr class="separator:a17550d1f1b862a621c409d4e12c7696b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48c34474ee0a9b6f8862688f2015fce8" id="r_a48c34474ee0a9b6f8862688f2015fce8"><td class="memItemLeft" align="right" valign="top">static float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1Parameters.html#a48c34474ee0a9b6f8862688f2015fce8">defaultKpFlannRebalancingFactor</a> ()</td></tr>
<tr class="memdesc:a48c34474ee0a9b6f8862688f2015fce8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default value of parameter Kp/FlannRebalancingFactor : 2.0 . <br /></td></tr>
@@ -723,7 +723,7 @@ Static Public Member Functions</h2></td></tr>
<tr class="memdesc:a31c98171e623d2d00ced8d5ee75aed20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of parameter Kp/FlannRebalancingFactor , as a string: float . <br /></td></tr>
<tr class="separator:a31c98171e623d2d00ced8d5ee75aed20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98de5152ce8f3bc8d1f197d20d4e778a" id="r_a98de5152ce8f3bc8d1f197d20d4e778a"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1Parameters.html#a98de5152ce8f3bc8d1f197d20d4e778a">kKpByteToFloat</a> ()</td></tr>
<tr class="memdesc:a98de5152ce8f3bc8d1f197d20d4e778a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key of parameter Kp/ByteToFloat : uFormat("For %s=1, binary descriptors are converted to float by converting each byte to float instead of converting each bit to float. When converting bytes instead of bits, less memory is used and search is faster at the cost of slightly less accurate matching.", <a class="el" href="classrtabmap_1_1Parameters.html#a994321ccf32f126b6781aa1925a5fa66" title="Key of parameter Kp/NNStrategy : &quot;kNNFlannNaive=0, kNNFlannKdTree=1, kNNFlannLSH=2,...">kKpNNStrategy()</a>.c_str()) Default value: false ( bool ). <br /></td></tr>
<tr class="memdesc:a98de5152ce8f3bc8d1f197d20d4e778a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key of parameter Kp/ByteToFloat : uFormat("For %s=1, binary descriptors are converted to float by converting each byte to float instead of converting each bit to float. When converting bytes instead of bits, less memory is used and search is faster at the cost of slightly less accurate matching.", <a class="el" href="classrtabmap_1_1Parameters.html#a994321ccf32f126b6781aa1925a5fa66" title="Key of parameter Kp/NNStrategy : &quot;FLANN Linear=0, FLANN KdTree=1, FLANN LSH=2, Brute Force=3,...">kKpNNStrategy()</a>.c_str()) Default value: false ( bool ). <br /></td></tr>
<tr class="separator:a98de5152ce8f3bc8d1f197d20d4e778a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65c89efe990caf9872456567afd54c71" id="r_a65c89efe990caf9872456567afd54c71"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1Parameters.html#a65c89efe990caf9872456567afd54c71">defaultKpByteToFloat</a> ()</td></tr>
<tr class="memdesc:a65c89efe990caf9872456567afd54c71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default value of parameter Kp/ByteToFloat : false . <br /></td></tr>
@@ -4269,7 +4269,7 @@ Static Public Member Functions</h2></td></tr>
<tr class="memdesc:a32e8334e07d7959d8d14ef93954d4e91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of parameter Vis/CorType , as a string: int . <br /></td></tr>
<tr class="separator:a32e8334e07d7959d8d14ef93954d4e91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a341b0c15fe1fba640ad3aee76019a618" id="r_a341b0c15fe1fba640ad3aee76019a618"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1Parameters.html#a341b0c15fe1fba640ad3aee76019a618">kVisCorNNType</a> ()</td></tr>
<tr class="memdesc:a341b0c15fe1fba640ad3aee76019a618"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key of parameter Vis/CorNNType : uFormat("[%s=0] kNNFlannNaive=0, kNNFlannKdTree=1, kNNFlannLSH=2, kNNBruteForce=3, kNNBruteForceGPU=4, BruteForceCrossCheck=5, SuperGlue=6, GMS=7. Used for features matching approach.", <a class="el" href="classrtabmap_1_1Parameters.html#a1f1c5f9198da6ec1d43a36621b0e6687" title="Key of parameter Vis/CorType : &quot;Correspondences computation approach: 0=Features Matching,...">kVisCorType()</a>.c_str()) Default value: 1 ( int ). <br /></td></tr>
<tr class="memdesc:a341b0c15fe1fba640ad3aee76019a618"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key of parameter Vis/CorNNType : uFormat("[%s=0] FLANN Linear=0, FLANN KdTree=1, FLANN LSH=2, Brute Force=3, Brute Force GPU=4, Brute Force Cross Check=5, SuperGlue=6, GMS=7, FLANN KdTree Single=8, NanoFLANN KdTree=9. Used for features matching approach.", <a class="el" href="classrtabmap_1_1Parameters.html#a1f1c5f9198da6ec1d43a36621b0e6687" title="Key of parameter Vis/CorType : &quot;Correspondences computation approach: 0=Features Matching,...">kVisCorType()</a>.c_str()) Default value: 1 ( int ). <br /></td></tr>
<tr class="separator:a341b0c15fe1fba640ad3aee76019a618"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a975192ffcb93b8b2923379657090fcf7" id="r_a975192ffcb93b8b2923379657090fcf7"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1Parameters.html#a975192ffcb93b8b2923379657090fcf7">defaultVisCorNNType</a> ()</td></tr>
<tr class="memdesc:a975192ffcb93b8b2923379657090fcf7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default value of parameter Vis/CorNNType : 1 . <br /></td></tr>
@@ -11324,7 +11324,7 @@ The <a class="el" href="parameters.html">Parameter reference</a> page, which lis
</table>
</div><div class="memdoc">
<p>Key of parameter Kp/NNStrategy : "kNNFlannNaive=0, kNNFlannKdTree=1, kNNFlannLSH=2, kNNBruteForce=3, kNNBruteForceGPU=4" Default value: 1 ( int ). </p>
<p>Key of parameter Kp/NNStrategy : "FLANN Linear=0, FLANN KdTree=1, FLANN LSH=2, Brute Force=3, Brute Force GPU=4, FLANN KdTree Single=5, NanoFLANN KdTree=6" Default value: 1 ( int ). </p>
<p class="definition">Definition at line <a class="el" href="Parameters_8h_source.html#l00255">255</a> of file <a class="el" href="Parameters_8h_source.html">Parameters.h</a>.</p>
@@ -11498,7 +11498,7 @@ The <a class="el" href="parameters.html">Parameter reference</a> page, which lis
</table>
</div><div class="memdoc">
<p>Key of parameter Kp/IncrementalFlann : uFormat("When using FLANN based strategy, add/remove points to its index without always rebuilding the index (the index is built only when the dictionary increases of the factor \"%s\" in size).", <a class="el" href="classrtabmap_1_1Parameters.html#a17550d1f1b862a621c409d4e12c7696b" title="Key of parameter Kp/FlannRebalancingFactor : uFormat(&quot;Factor used when rebuilding the incremental FLA...">kKpFlannRebalancingFactor()</a>.c_str()) Default value: true ( bool ). </p>
<p>Key of parameter Kp/IncrementalFlann : uFormat("When using FLANN based strategy, add/remove points to its index without always rebuilding the index (the index is only rebuilt when too many of its features have been removed, see \"%s\").", <a class="el" href="classrtabmap_1_1Parameters.html#a17550d1f1b862a621c409d4e12c7696b" title="Key of parameter Kp/FlannRebalancingFactor : uFormat(&quot;Rebuild the incremental FLANN index (see \&quot;%s\&quot;...">kKpFlannRebalancingFactor()</a>.c_str()) Default value: true ( bool ). </p>
<p class="definition">Definition at line <a class="el" href="Parameters_8h_source.html#l00257">257</a> of file <a class="el" href="Parameters_8h_source.html">Parameters.h</a>.</p>
@@ -11585,7 +11585,7 @@ The <a class="el" href="parameters.html">Parameter reference</a> page, which lis
</table>
</div><div class="memdoc">
<p>Key of parameter Kp/FlannRebalancingFactor : uFormat("Factor used when rebuilding the incremental FLANN index (see \"%s\"). Set &lt;=1 to disable.", <a class="el" href="classrtabmap_1_1Parameters.html#a092387f2a424c8db4f2482742b0b0fb9" title="Key of parameter Kp/IncrementalFlann : uFormat(&quot;When using FLANN based strategy, add/remove points to...">kKpIncrementalFlann()</a>.c_str()) Default value: 2.0 ( float ). </p>
<p>Key of parameter Kp/FlannRebalancingFactor : uFormat("Rebuild the incremental FLANN index (see \"%s\") once the ratio (factor-1)/factor of its features has been removed, e.g. half of them for a factor of 2. Rebuilding frees the memory of the removed features and speeds up the searches. Features are mostly removed when memory management is enabled (\"%s\" or \"%s\"). Set to 1 to never rebuild, which also uses less memory as the features don't have to be referenced one by one.", <a class="el" href="classrtabmap_1_1Parameters.html#a092387f2a424c8db4f2482742b0b0fb9" title="Key of parameter Kp/IncrementalFlann : uFormat(&quot;When using FLANN based strategy, add/remove points to...">kKpIncrementalFlann()</a>.c_str(), <a class="el" href="classrtabmap_1_1Parameters.html#a8ee7e153cfb26574c7d1c7b427593f8a" title="Key of parameter Rtabmap/TimeThr : &quot;Maximum time allowed for map update (ms) (0 means infinity)....">kRtabmapTimeThr()</a>.c_str(), <a class="el" href="classrtabmap_1_1Parameters.html#a66882ccd6f0a49f2c23db8718d12a59c" title="Key of parameter Rtabmap/MemoryThr : uFormat(&quot;Maximum nodes in the Working Memory (0 means infinity)....">kRtabmapMemoryThr()</a>.c_str()) Default value: 2.0 ( float ). </p>
<p class="definition">Definition at line <a class="el" href="Parameters_8h_source.html#l00258">258</a> of file <a class="el" href="Parameters_8h_source.html">Parameters.h</a>.</p>
@@ -11672,7 +11672,7 @@ The <a class="el" href="parameters.html">Parameter reference</a> page, which lis
</table>
</div><div class="memdoc">
<p>Key of parameter Kp/ByteToFloat : uFormat("For %s=1, binary descriptors are converted to float by converting each byte to float instead of converting each bit to float. When converting bytes instead of bits, less memory is used and search is faster at the cost of slightly less accurate matching.", <a class="el" href="classrtabmap_1_1Parameters.html#a994321ccf32f126b6781aa1925a5fa66" title="Key of parameter Kp/NNStrategy : &quot;kNNFlannNaive=0, kNNFlannKdTree=1, kNNFlannLSH=2,...">kKpNNStrategy()</a>.c_str()) Default value: false ( bool ). </p>
<p>Key of parameter Kp/ByteToFloat : uFormat("For %s=1, binary descriptors are converted to float by converting each byte to float instead of converting each bit to float. When converting bytes instead of bits, less memory is used and search is faster at the cost of slightly less accurate matching.", <a class="el" href="classrtabmap_1_1Parameters.html#a994321ccf32f126b6781aa1925a5fa66" title="Key of parameter Kp/NNStrategy : &quot;FLANN Linear=0, FLANN KdTree=1, FLANN LSH=2, Brute Force=3,...">kKpNNStrategy()</a>.c_str()) Default value: false ( bool ). </p>
<p class="definition">Definition at line <a class="el" href="Parameters_8h_source.html#l00259">259</a> of file <a class="el" href="Parameters_8h_source.html">Parameters.h</a>.</p>
@@ -45950,7 +45950,7 @@ The <a class="el" href="parameters.html">Parameter reference</a> page, which lis
</table>
</div><div class="memdoc">
<p>Key of parameter Vis/CorNNType : uFormat("[%s=0] kNNFlannNaive=0, kNNFlannKdTree=1, kNNFlannLSH=2, kNNBruteForce=3, kNNBruteForceGPU=4, BruteForceCrossCheck=5, SuperGlue=6, GMS=7. Used for features matching approach.", <a class="el" href="classrtabmap_1_1Parameters.html#a1f1c5f9198da6ec1d43a36621b0e6687" title="Key of parameter Vis/CorType : &quot;Correspondences computation approach: 0=Features Matching,...">kVisCorType()</a>.c_str()) Default value: 1 ( int ). </p>
<p>Key of parameter Vis/CorNNType : uFormat("[%s=0] FLANN Linear=0, FLANN KdTree=1, FLANN LSH=2, Brute Force=3, Brute Force GPU=4, Brute Force Cross Check=5, SuperGlue=6, GMS=7, FLANN KdTree Single=8, NanoFLANN KdTree=9. Used for features matching approach.", <a class="el" href="classrtabmap_1_1Parameters.html#a1f1c5f9198da6ec1d43a36621b0e6687" title="Key of parameter Vis/CorType : &quot;Correspondences computation approach: 0=Features Matching,...">kVisCorType()</a>.c_str()) Default value: 1 ( int ). </p>
<p class="definition">Definition at line <a class="el" href="Parameters_8h_source.html#l00783">783</a> of file <a class="el" href="Parameters_8h_source.html">Parameters.h</a>.</p>