Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanuppal committed Apr 30, 2024
1 parent 669c8fb commit 0b3eef8
Show file tree
Hide file tree
Showing 25 changed files with 526 additions and 272 deletions.
105 changes: 105 additions & 0 deletions docs/_writing.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
<!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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>scan matching: an ICP Implementation</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>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.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-style.css" rel="stylesheet" type="text/css"/>
</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">scan matching
</div>
<div id="projectbrief">ICP algorithm library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<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');
$(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><!-- top -->
<div><div class="header">
<div class="headertitle"><div class="title">an ICP Implementation</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>An ICP implementation should reside in a single C++ source file, e.g., <code>my_icp.cpp</code>. You should declare a <code>final</code> class named <code>MyICP</code> that inherits <code>public <a class="el" href="classicp_1_1_i_c_p.html" title="Interface for iterative closest points; please read the Detailed Description for usage information.">icp::ICP</a></code> that must provide the following functionality:</p>
<ul>
<li><code>MyICP()</code></li>
<li><code>~MyICP() override</code></li>
<li><code>void iterate() override</code></li>
</ul>
<p>You may optionally override the following methods:</p>
<ul>
<li><code>setup() override</code></li>
<li><code>const std::vector&lt;Vector&gt;&amp; a, const std::vector&lt;Vector&gt;&amp; b) override</code></li>
</ul>
<p>Finally, define the following static variable:</p>
<div class="fragment"><div class="line"> ++</div>
<div class="line"><span class="keyword">static</span> <span class="keywordtype">bool</span> static_initialization = []() {</div>
<div class="line"> assert(ICP::register_method(<span class="stringliteral">&quot;my_icp&quot;</span>, []() -&gt; std::unique_ptr&lt;ICP&gt; {</div>
<div class="line"> <span class="keywordflow">return</span> std::make_unique&lt;MyICP&gt;();</div>
<div class="line"> }));</div>
<div class="line"> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line">}();</div>
</div><!-- fragment --> </div></div><!-- contents -->
</div><!-- PageDoc -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>
3 changes: 2 additions & 1 deletion docs/classicp_1_1_i_c_p-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,8 @@
<tr class="odd"><td class="entry"><a class="el" href="classicp_1_1_i_c_p.html#a9933256313a70fedacd7d3d7c8fa63c3">registered_methods</a>()</td><td class="entry"><a class="el" href="classicp_1_1_i_c_p.html">icp::ICP</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classicp_1_1_i_c_p.html#a32996eafad2cbc1ecc1361536abdfe68">setup</a>()</td><td class="entry"><a class="el" href="classicp_1_1_i_c_p.html">icp::ICP</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classicp_1_1_i_c_p.html#a47adf7aba7ca4afbdd308abaa4613bb1">transform</a></td><td class="entry"><a class="el" href="classicp_1_1_i_c_p.html">icp::ICP</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classicp_1_1_i_c_p.html#a98484780f08694a2bc37fcc3fd86bd4f">~ICP</a>()=default</td><td class="entry"><a class="el" href="classicp_1_1_i_c_p.html">icp::ICP</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classicp_1_1_i_c_p.html#a74f7a197dbc1258c2d08f95311f23b40">trim</a>(const std::vector&lt; Vector &gt; &amp;a, const std::vector&lt; Vector &gt; &amp;b)</td><td class="entry"><a class="el" href="classicp_1_1_i_c_p.html">icp::ICP</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classicp_1_1_i_c_p.html#a98484780f08694a2bc37fcc3fd86bd4f">~ICP</a>()=default</td><td class="entry"><a class="el" href="classicp_1_1_i_c_p.html">icp::ICP</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
51 changes: 42 additions & 9 deletions docs/classicp_1_1_i_c_p.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,8 @@
<tr class="separator:a6ee9bfb8de098c6d7e6041626e49b05a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32996eafad2cbc1ecc1361536abdfe68" id="r_a32996eafad2cbc1ecc1361536abdfe68"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a32996eafad2cbc1ecc1361536abdfe68">setup</a> ()</td></tr>
<tr class="separator:a32996eafad2cbc1ecc1361536abdfe68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74f7a197dbc1258c2d08f95311f23b40" id="r_a74f7a197dbc1258c2d08f95311f23b40"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a74f7a197dbc1258c2d08f95311f23b40">trim</a> (const std::vector&lt; <a class="el" href="namespaceicp.html#aba583ee22f8131f5494d90fb3a611bd5">Vector</a> &gt; &amp;<a class="el" href="#a8fa6d4d0a46ee621097c821afe7e5985">a</a>, const std::vector&lt; <a class="el" href="namespaceicp.html#aba583ee22f8131f5494d90fb3a611bd5">Vector</a> &gt; &amp;<a class="el" href="#aa2742888e6e4f43752c1ec834a39d06e">b</a>)</td></tr>
<tr class="separator:a74f7a197dbc1258c2d08f95311f23b40"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
Expand Down Expand Up @@ -176,7 +178,7 @@
<div class="textblock"><p>Interface for iterative closest points; please read the Detailed Description for usage information. </p>
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="comment">// Construct a new vanilla ICP instance.</span></div>
<div class="line">std::unique_ptr&lt;icp::ICP&gt; <a class="code hl_namespace" href="namespaceicp.html">icp</a> = <a class="code hl_function" href="#ad8075cc05cb50c4eb6cd69cd90f6b639">icp::ICP::from_method</a>(<span class="stringliteral">&quot;vanilla&quot;</span>);</div>
<div class="ttc" id="aclassicp_1_1_i_c_p_html_ad8075cc05cb50c4eb6cd69cd90f6b639"><div class="ttname"><a href="#ad8075cc05cb50c4eb6cd69cd90f6b639">icp::ICP::from_method</a></div><div class="ttdeci">static std::unique_ptr&lt; ICP &gt; from_method(std::string name)</div><div class="ttdoc">Factory constructor for the ICP method name.</div><div class="ttdef"><b>Definition</b> <a href="icp_8cpp_source.html#l00112">icp.cpp:112</a></div></div>
<div class="ttc" id="aclassicp_1_1_i_c_p_html_ad8075cc05cb50c4eb6cd69cd90f6b639"><div class="ttname"><a href="#ad8075cc05cb50c4eb6cd69cd90f6b639">icp::ICP::from_method</a></div><div class="ttdeci">static std::unique_ptr&lt; ICP &gt; from_method(std::string name)</div><div class="ttdoc">Factory constructor for the ICP method name.</div><div class="ttdef"><b>Definition</b> <a href="icp_8cpp_source.html#l00116">icp.cpp:116</a></div></div>
<div class="ttc" id="anamespaceicp_html"><div class="ttname"><a href="namespaceicp.html">icp</a></div><div class="ttdef"><b>Definition</b> <a href="geo_8cpp_source.html#l00009">geo.cpp:9</a></div></div>
</div><!-- fragment --></dd></dl>
<dl class="section user"><dt>Usage</dt><dd>Let <code>a</code> and <code>b</code> be two point clouds of type <code>std::vector&lt;Vector&gt;</code>. Then, given an <a class="el" href="classicp_1_1_i_c_p.html" title="Interface for iterative closest points; please read the Detailed Description for usage information.">ICP</a> instance <code>icp</code> of type <code>std::unique_ptr&lt;<a class="el" href="classicp_1_1_i_c_p.html" title="Interface for iterative closest points; please read the Detailed Description for usage information.">icp::ICP</a>&gt;</code>, perform the following steps.</dd></dl>
Expand Down Expand Up @@ -268,7 +270,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab5a0481925dfd8d0ba2ea9b5

<p>Begins the <a class="el" href="classicp_1_1_i_c_p.html" title="Interface for iterative closest points; please read the Detailed Description for usage information.">ICP</a> process for point clouds <code>a</code> and <code>b</code> with an initial guess for the transform <code>t</code>. </p>

<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00016">16</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00021">21</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
Expand All @@ -289,7 +291,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af1935a8a37141a32d5fd377f

<p>Computes the cost of the current transformation. </p>

<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00050">50</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00054">54</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
Expand All @@ -316,7 +318,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a80a0f5b00b3b9bf1403fdafe
<p>At least <code>burn_in</code> iterations will be performed.</p>
<dl class="section return"><dt>Returns</dt><dd>Information about the convergence. </dd></dl>

<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00058">58</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00062">62</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
Expand All @@ -337,7 +339,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac7d60a8302ef88190a30280a

<p>The current transform. </p>

<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00089">89</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00093">93</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -367,7 +369,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ad8075cc05cb50c4eb6cd69cd
<p>Factory constructor for the <a class="el" href="classicp_1_1_i_c_p.html" title="Interface for iterative closest points; please read the Detailed Description for usage information.">ICP</a> method <code>name</code>. </p>
<dl class="section pre"><dt>Precondition</dt><dd><code>name</code> is a valid registered method. See <a class="el" href="#aff3398f6b1cc6651d0c085ced4cb8db1" title="Whether name is a registered ICP method.">ICP::is_registered_method</a>. </dd></dl>

<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00112">112</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00116">116</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -396,7 +398,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aff3398f6b1cc6651d0c085ce

<p>Whether <code>name</code> is a registered <a class="el" href="classicp_1_1_i_c_p.html" title="Interface for iterative closest points; please read the Detailed Description for usage information.">ICP</a> method. </p>

<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00120">120</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00124">124</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -456,7 +458,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a878302998f8be12f56b5ec9d

<p>Registers a new <a class="el" href="classicp_1_1_i_c_p.html" title="Interface for iterative closest points; please read the Detailed Description for usage information.">ICP</a> method that can be created with <code>constructor</code>, returning <code>false</code> if <code>name</code> has already been registered. </p>

<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00099">99</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00103">103</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -485,7 +487,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9933256313a70fedacd7d3d7

<p>Returns a current list of the names of currently registered <a class="el" href="classicp_1_1_i_c_p.html" title="Interface for iterative closest points; please read the Detailed Description for usage information.">ICP</a> methods. </p>

<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00107">107</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00111">111</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -514,6 +516,37 @@ <h2 class="memtitle"><span class="permalink"><a href="#a32996eafad2cbc1ecc136153

<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00014">14</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void icp::ICP::trim </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; <a class="el" href="namespaceicp.html#aba583ee22f8131f5494d90fb3a611bd5">Vector</a> &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>a</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; <a class="el" href="namespaceicp.html#aba583ee22f8131f5494d90fb3a611bd5">Vector</a> &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>b</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00016">16</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
Expand Down
2 changes: 2 additions & 0 deletions docs/doxygen_crawl.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
<a href="sim__config_8h_source.html"/>
<a href="main_8md.html"/>
<a href="v1_8md.html"/>
<a href="writing__icp_8md.html"/>
<a href="kdtree_8cpp.html"/>
<a href="kdtree_8d.html"/>
<a href="kdtree_8h.html"/>
Expand All @@ -55,6 +56,7 @@
<a href="sim__config_8d.html"/>
<a href="sim__config_8h.html"/>
<a href="md_book_2versions_2v1.html"/>
<a href="_writing.html"/>
<a href="class_k_d_tree.html"/>
<a href="class_k_d_tree-members.html"/>
<a href="class_lidar_view.html"/>
Expand Down
1 change: 1 addition & 0 deletions docs/functions.html
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ <h3><a id="index_t" name="index_t"></a>- t -</h3><ul>
<li>to_string()&#160;:&#160;<a class="el" href="structicp_1_1_r_b_transform.html#ac5dbea10e73563a385bfe0ba2aa3d1f9">icp::RBTransform</a></li>
<li>transform&#160;:&#160;<a class="el" href="classicp_1_1_i_c_p.html#a47adf7aba7ca4afbdd308abaa4613bb1">icp::ICP</a></li>
<li>translation&#160;:&#160;<a class="el" href="structicp_1_1_r_b_transform.html#ac449288fecc4bb2a94783f45f8a912ac">icp::RBTransform</a></li>
<li>trim()&#160;:&#160;<a class="el" href="classicp_1_1_i_c_p.html#a74f7a197dbc1258c2d08f95311f23b40">icp::ICP</a></li>
</ul>


Expand Down
1 change: 1 addition & 0 deletions docs/functions_func.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@
<li>registered_methods()&#160;:&#160;<a class="el" href="classicp_1_1_i_c_p.html#a9933256313a70fedacd7d3d7c8fa63c3">icp::ICP</a></li>
<li>setup()&#160;:&#160;<a class="el" href="classicp_1_1_i_c_p.html#a32996eafad2cbc1ecc1361536abdfe68">icp::ICP</a></li>
<li>to_string()&#160;:&#160;<a class="el" href="structicp_1_1_r_b_transform.html#ac5dbea10e73563a385bfe0ba2aa3d1f9">icp::RBTransform</a></li>
<li>trim()&#160;:&#160;<a class="el" href="classicp_1_1_i_c_p.html#a74f7a197dbc1258c2d08f95311f23b40">icp::ICP</a></li>
<li>~ICP()&#160;:&#160;<a class="el" href="classicp_1_1_i_c_p.html#a98484780f08694a2bc37fcc3fd86bd4f">icp::ICP</a></li>
<li>~KDTree()&#160;:&#160;<a class="el" href="class_k_d_tree.html#af5990303a9e2cfe3b1de958cee1220cd">KDTree&lt; K, Node &gt;</a></li>
<li>~LidarView()&#160;:&#160;<a class="el" href="class_lidar_view.html#aaaa17fc7431a01c6b934264dc4655f7f">LidarView</a></li>
Expand Down
Loading

0 comments on commit 0b3eef8

Please sign in to comment.