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_1VWDictionary.html
+22 -15
View File
@@ -124,6 +124,8 @@ Public Types</h2></td></tr>
, <a class="el" href="classrtabmap_1_1VWDictionary.html#a9466840dd5ad3dc914543a97421c3655a1745dd334296b8a41cf0c88dcc8a7d5d">kNNBruteForce</a>
, <br />
&#160;&#160;<a class="el" href="classrtabmap_1_1VWDictionary.html#a9466840dd5ad3dc914543a97421c3655a602d99d5bdef453a39339a0b45979451">kNNBruteForceGPU</a>
, <a class="el" href="classrtabmap_1_1VWDictionary.html#a9466840dd5ad3dc914543a97421c3655a994442dbb17b48ba9a9315edee24a7a1">kNNFlannKdTreeSingle</a>
, <a class="el" href="classrtabmap_1_1VWDictionary.html#a9466840dd5ad3dc914543a97421c3655a306c8d555b740267fa80a1ee673ef7c7">kNNNanoFlannKdTree</a>
, <a class="el" href="classrtabmap_1_1VWDictionary.html#a9466840dd5ad3dc914543a97421c3655afeba67ed0aafc39aa35b2a194e147ff9">kNNUndef</a>
<br />
}</td></tr>
@@ -310,6 +312,7 @@ Protected Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Nearest neighbor search strategies for descriptor matching. </p>
<p>The values are those of the Kp/NNStrategy parameter, saved in user configurations and databases: append, never renumber. The Vis/CorNNType parameter has strategies of its own, its values are mapped to these ones by RegistrationVis::nnStrategyFromCorNNType(). </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a9466840dd5ad3dc914543a97421c3655ae4301e202dd36e997bf3298390c667f0" name="a9466840dd5ad3dc914543a97421c3655ae4301e202dd36e997bf3298390c667f0"></a>kNNFlannNaive&#160;</td><td class="fielddoc"><p>FLANN naive search (exhaustive) </p>
</td></tr>
@@ -321,11 +324,15 @@ Protected Attributes</h2></td></tr>
</td></tr>
<tr><td class="fieldname"><a id="a9466840dd5ad3dc914543a97421c3655a602d99d5bdef453a39339a0b45979451" name="a9466840dd5ad3dc914543a97421c3655a602d99d5bdef453a39339a0b45979451"></a>kNNBruteForceGPU&#160;</td><td class="fielddoc"><p>Brute force GPU-accelerated search (requires CUDA) </p>
</td></tr>
<tr><td class="fieldname"><a id="a9466840dd5ad3dc914543a97421c3655a994442dbb17b48ba9a9315edee24a7a1" name="a9466840dd5ad3dc914543a97421c3655a994442dbb17b48ba9a9315edee24a7a1"></a>kNNFlannKdTreeSingle&#160;</td><td class="fielddoc"><p>FLANN single exact kd-tree index (rebuilt whenever a word is added, for an index built once) </p>
</td></tr>
<tr><td class="fieldname"><a id="a9466840dd5ad3dc914543a97421c3655a306c8d555b740267fa80a1ee673ef7c7" name="a9466840dd5ad3dc914543a97421c3655a306c8d555b740267fa80a1ee673ef7c7"></a>kNNNanoFlannKdTree&#160;</td><td class="fielddoc"><p>nanoflann kd-tree index (float descriptors only, incremental) </p>
</td></tr>
<tr><td class="fieldname"><a id="a9466840dd5ad3dc914543a97421c3655afeba67ed0aafc39aa35b2a194e147ff9" name="a9466840dd5ad3dc914543a97421c3655afeba67ed0aafc39aa35b2a194e147ff9"></a>kNNUndef&#160;</td><td class="fielddoc"><p>Undefined strategy. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00072">72</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00077">77</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
</div>
</div>
@@ -418,7 +425,7 @@ Protected Attributes</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>String representation of the strategy name </dd></dl>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00096">96</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00103">103</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
</div>
</div>
@@ -787,7 +794,7 @@ Protected Attributes</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00232">232</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00245">245</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
</div>
</div>
@@ -817,7 +824,7 @@ Protected Attributes</h2></td></tr>
<p>Get all visual words. </p>
<dl class="section return"><dt>Returns</dt><dd>Map of visual word ID to <a class="el" href="classrtabmap_1_1VisualWord.html" title="Represents a visual word (feature descriptor) used in the bag-of-words (BoW) model.">VisualWord</a> pointer </dd></dl>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00238">238</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00251">251</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
</div>
</div>
@@ -850,7 +857,7 @@ Protected Attributes</h2></td></tr>
<dl class="section note"><dt>Note</dt><dd>The NNDR method was introduced in "Distinctive Image Features
from Scale-Invariant Keypoints" by David Lowe (IJCV 2004). </dd></dl>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00251">251</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00264">264</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
</div>
</div>
@@ -880,7 +887,7 @@ from Scale-Invariant Keypoints" by David Lowe (IJCV 2004). </dd></dl>
<p>Get the count of words not yet indexed in the search tree. </p>
<dl class="section return"><dt>Returns</dt><dd>Number of words waiting to be indexed </dd></dl>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00257">257</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00270">270</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
</div>
</div>
@@ -930,7 +937,7 @@ from Scale-Invariant Keypoints" by David Lowe (IJCV 2004). </dd></dl>
<p>Get the total number of active word-to-signature references. </p>
<dl class="section return"><dt>Returns</dt><dd>Total count of active references </dd></dl>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00269">269</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00282">282</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
</div>
</div>
@@ -1048,7 +1055,7 @@ from Scale-Invariant Keypoints" by David Lowe (IJCV 2004). </dd></dl>
<p>Get the current nearest neighbor search strategy. </p>
<dl class="section return"><dt>Returns</dt><dd>The current NNStrategy </dd></dl>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00302">302</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00315">315</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
</div>
</div>
@@ -1078,7 +1085,7 @@ from Scale-Invariant Keypoints" by David Lowe (IJCV 2004). </dd></dl>
<p>Check if the dictionary is in incremental mode. </p>
<dl class="section return"><dt>Returns</dt><dd>true if incremental, false if fixed </dd></dl>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00308">308</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00321">321</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
</div>
</div>
@@ -1108,7 +1115,7 @@ from Scale-Invariant Keypoints" by David Lowe (IJCV 2004). </dd></dl>
<p>Check if FLANN index is updated incrementally. </p>
<dl class="section return"><dt>Returns</dt><dd>true if incremental FLANN updates are enabled </dd></dl>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00314">314</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00327">327</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
</div>
</div>
@@ -1397,7 +1404,7 @@ from Scale-Invariant Keypoints" by David Lowe (IJCV 2004). </dd></dl>
<p>Get the count of unused visual words. </p>
<dl class="section return"><dt>Returns</dt><dd>Number of unused words </dd></dl>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00404">404</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00417">417</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
</div>
</div>
@@ -1599,7 +1606,7 @@ from Scale-Invariant Keypoints" by David Lowe (IJCV 2004). </dd></dl>
<p>Starting ID for visual words (typically 1) </p>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00084">84</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00091">91</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
</div>
</div>
@@ -1625,7 +1632,7 @@ from Scale-Invariant Keypoints" by David Lowe (IJCV 2004). </dd></dl>
<p>Invalid visual word ID (typically 0) </p>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00089">89</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00096">96</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
</div>
</div>
@@ -1652,7 +1659,7 @@ from Scale-Invariant Keypoints" by David Lowe (IJCV 2004). </dd></dl>
<p>Map of visual word ID to <a class="el" href="classrtabmap_1_1VisualWord.html" title="Represents a visual word (feature descriptor) used in the bag-of-words (BoW) model.">VisualWord</a> pointer. </p>
<dl class="section note"><dt>Note</dt><dd>All visual words (used and unused) are stored here </dd></dl>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00461">461</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00474">474</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
</div>
</div>
@@ -1679,7 +1686,7 @@ from Scale-Invariant Keypoints" by David Lowe (IJCV 2004). </dd></dl>
<p>Total count of active word-to-signature references. </p>
<dl class="section note"><dt>Note</dt><dd>Used to track all references for updating common signatures </dd></dl>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00467">467</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="VWDictionary_8h_source.html#l00480">480</a> of file <a class="el" href="VWDictionary_8h_source.html">VWDictionary.h</a>.</p>
</div>
</div>