Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanuppal committed Apr 21, 2024
1 parent 20271ad commit a0f89e6
Show file tree
Hide file tree
Showing 45 changed files with 1,701 additions and 1,336 deletions.
22 changes: 11 additions & 11 deletions docs/classicp_1_1_i_c_p.html
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,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#l00113">icp.cpp:113</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#l00112">icp.cpp:112</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 @@ -212,7 +212,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6ee9bfb8de098c6d7e604162
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00013">13</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#l00012">12</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -268,7 +268,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#l00017">17</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#l00016">16</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
Expand All @@ -289,7 +289,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#l00051">51</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#l00050">50</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
Expand All @@ -316,7 +316,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#l00059">59</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#l00058">58</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
Expand All @@ -337,7 +337,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#l00090">90</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#l00089">89</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -367,7 +367,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#l00113">113</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#l00112">112</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -396,7 +396,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#l00121">121</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#l00120">120</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -456,7 +456,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#l00100">100</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#l00099">99</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -485,7 +485,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#l00108">108</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#l00107">107</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
Expand All @@ -512,7 +512,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a32996eafad2cbc1ecc136153
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="icp_8cpp_source.html#l00015">15</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#l00014">14</a> of file <a class="el" href="icp_8cpp_source.html">icp.cpp</a>.</p>

</div>
</div>
Expand Down
89 changes: 89 additions & 0 deletions docs/dir_37cc3c73d5254b7419be442ea9d38477.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
<!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: book/versions Directory 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>
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_b11dea735a166eca9c79fb414c2dda10.html">book</a></li><li class="navelem"><a class="el" href="dir_37cc3c73d5254b7419be442ea9d38477.html">versions</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">versions Directory Reference</div></div>
</div><!--header-->
<div class="contents">
</div><!-- contents -->
<!-- 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>
6 changes: 6 additions & 0 deletions docs/dir_b11dea735a166eca9c79fb414c2dda10.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,12 @@
<div class="headertitle"><div class="title">book Directory Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="subdirs" name="subdirs"></a>
Directories</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><span class="iconfclosed"></span>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dir_37cc3c73d5254b7419be442ea9d38477.html">versions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
4 changes: 4 additions & 0 deletions docs/doxygen_crawl.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
<a href="sim__config_8d_source.html"/>
<a href="sim__config_8h_source.html"/>
<a href="main_8md.html"/>
<a href="v1_8md.html"/>
<a href="kdtree_8cpp.html"/>
<a href="kdtree_8d.html"/>
<a href="kdtree_8h.html"/>
Expand All @@ -53,6 +54,7 @@
<a href="sim__config_8cpp.html"/>
<a href="sim__config_8d.html"/>
<a href="sim__config_8h.html"/>
<a href="md_book_2versions_2v1.html"/>
<a href="class_k_d_tree.html"/>
<a href="class_k_d_tree-members.html"/>
<a href="class_lidar_view.html"/>
Expand All @@ -72,8 +74,10 @@
<a href="dir_156e6a4e01c93213f20015fc7847b1f4.html"/>
<a href="dir_5ba998bec3831bd658c4991b03a0da20.html"/>
<a href="dir_68267d1309a1af8e8297ef4c3efbcdba.html"/>
<a href="dir_37cc3c73d5254b7419be442ea9d38477.html"/>
<a href="index.html"/>
<a href="doxygen_crawl.html"/>
<a href="pages.html"/>
<a href="namespacemembers.html"/>
<a href="namespacemembers.html"/>
<a href="namespacemembers.html"/>
Expand Down
Loading

0 comments on commit a0f89e6

Please sign in to comment.