-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathDoc3dCurveTangentEstimator.html
126 lines (124 loc) · 10.1 KB
/
Doc3dCurveTangentEstimator.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
<!-- HTML header for doxygen 1.8.11-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<title>DGtalTools: 3dCurveTangentEstimator</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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.3/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="modern-doxygen-green.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">DGtalTools
 <span id="projectnumber">1.5.beta</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">3dCurveTangentEstimator </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This program estimates the tangent vector to a set of 3D integer points, which are supposed to approximate a 3D curve.</p>
<p><b>Usage:</b> ./estimators/3dCurveTangentEstimator [options] –input <filename></p>
<p>This program estimates the tangent vector to a set of 3D integer points, which are supposed to approximate a 3D curve. This set of points is given as a list of points in file <input>. The tangent estimator uses either the digital Voronoi Covariance Measure (VCM) or the 3D lambda-Maximal Segment Tangent (L-MST). This program can also displays the curve and tangent estimations, and it can also extract maximal digital straight segments (2D and 3D).</p>
<dl class="section note"><dt>Note</dt><dd>It is not compulsory for the points to be ordered in sequence, except if you wish to compute maximal digital straight segments. In this case, you can select the connectivity of your curve between 6 (standard) or 26 (naive).</dd></dl>
<p><b>Allowed</b> <b>options</b> are :</p>
<div class="fragment"><div class="line">Positionals:</div>
<div class="line"> 1 TEXT:FILE REQUIRED the name of the text file containing the list of 3D points: (x y z) per line.</div>
<div class="line"> </div>
<div class="line">Options:</div>
<div class="line"> -h,--help Print <span class="keyword">this</span> help message and exit</div>
<div class="line"> -i,--input TEXT:FILE REQUIRED the name of the text file containing the list of 3D points: (x y z) per line.</div>
<div class="line"> -V,--view TEXT=OFF toggles display <a class="codeRef" href="https://dgtal-team.github.io/doc-nightly/namespaceDGtal.html#a9f6cc75dc44e45506a66cd233e0deb41a7671a5416d92f37137f9999ca23dd65e">ON</a>/OFF</div>
<div class="line"> -b,--box INT=0 specifies the tightness of the bounding box around the curve with a given integer displacement <arg> to enlarge it (0 is tight)</div>
<div class="line"> -v,--viewBox TEXT:{WIRED,COLORED}=WIRED</div>
<div class="line"> displays the bounding box, <arg>=WIRED means that only <a class="codeRef" href="https://dgtal-team.github.io/doc-nightly/namespaceboost.html#a02a2d933da658a600caa2c5031315d3a">edges</a> are displayed, <arg>=COLORED adds colors <span class="keywordflow">for</span> planes (XY is red, XZ green, YZ, blue).</div>
<div class="line"> -T,--connectivity TEXT:{6,26}=6 specifies whether it is a 6-connected curve or a 26-connected curve: arg=6 | 26.</div>
<div class="line"> -C,--curve3d displays the 3D curve</div>
<div class="line"> -c,--curve2d displays the 2D projections of the 3D curve on the bounding box</div>
<div class="line"> -3,--cover3d displays the 3D tangential cover of the curve</div>
<div class="line"> -2,--cover2d displays the 2D projections of the 3D tangential cover of the curve</div>
<div class="line"> -t,--tangent displays the tangents to the curve.</div>
<div class="line"> -n,--nbColors UINT=3 sets the number of successive colors used <span class="keywordflow">for</span> displaying 2d and 3d maximal segments (<span class="keywordflow">default</span> is 3: red, green, blue)</div>
<div class="line"> -R,--big-radius FLOAT=10 the radius parameter R in the VCM estimator.</div>
<div class="line"> -r,--small-radius FLOAT=3 the radius parameter r in the VCM estimator.</div>
<div class="line"> -m,--method TEXT:{VCM,L-MST}=VCM the method of tangent computation: VCM (<span class="keywordflow">default</span>), L-MST.</div>
<div class="line"> -a,--axes TEXT:{<a class="codeRef" href="https://dgtal-team.github.io/doc-nightly/namespaceDGtal.html#a9f6cc75dc44e45506a66cd233e0deb41a7671a5416d92f37137f9999ca23dd65e">ON</a>,OFF}=OFF show <a class="code" href="3dHeightMapViewer_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627">main</a> axes - prints list of axes <span class="keywordflow">for each</span> point and color points color = (<span class="keywordflow">if</span> X => 255, <span class="keywordflow">if</span> Y => 255, <span class="keywordflow">if</span> Z => 255)</div>
<div class="line"> -o,--output TEXT=3d-curve-tangent-estimations</div>
<div class="line"> the basename of the output text file which will contain points and tangent vectors: (x y z tx ty tz) per line</div>
<div class="ttc" id="a3dHeightMapViewer_8cpp_html_a3c04138a5bfe5d72780bb7e82a18e627"><div class="ttname"><a href="3dHeightMapViewer_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627">main</a></div><div class="ttdeci">int main(int argc, char **argv)</div><div class="ttdef"><b>Definition:</b> <a href="3dHeightMapViewer_8cpp_source.html#l00206">3dHeightMapViewer.cpp:206</a></div></div>
<div class="ttc" id="anamespaceDGtal_html_a9f6cc75dc44e45506a66cd233e0deb41a7671a5416d92f37137f9999ca23dd65e"><div class="ttname"><a href="https://dgtal-team.github.io/doc-nightly/namespaceDGtal.html#a9f6cc75dc44e45506a66cd233e0deb41a7671a5416d92f37137f9999ca23dd65e">DGtal::ON</a></div><div class="ttdeci">ON</div></div>
<div class="ttc" id="anamespaceboost_html_a02a2d933da658a600caa2c5031315d3a"><div class="ttname"><a href="https://dgtal-team.github.io/doc-nightly/namespaceboost.html#a02a2d933da658a600caa2c5031315d3a">boost::edges</a></div><div class="ttdeci">std::pair< typename graph_traits< DGtal::DigitalSurface< TDigitalSurfaceContainer > >::edge_iterator, typename graph_traits< DGtal::DigitalSurface< TDigitalSurfaceContainer > >::edge_iterator > edges(const DGtal::DigitalSurface< TDigitalSurfaceContainer > &digSurf)</div></div>
</div><!-- fragment --><p><b>Example:</b> This command line show an example of tangent estimation with the VCM estimator. </p><div class="fragment"><div class="line">3dCurveTangentEstimator ${<a class="code" href="namespaceDGtal.html">DGtal</a>}/examples/samples/sinus.dat -V <a class="codeRef" href="https://dgtal-team.github.io/doc-nightly/namespaceDGtal.html#a9f6cc75dc44e45506a66cd233e0deb41a7671a5416d92f37137f9999ca23dd65e">ON</a> -c -R 20 -r 3 -T 6</div>
<div class="ttc" id="anamespaceDGtal_html"><div class="ttname"><a href="namespaceDGtal.html">DGtal</a></div></div>
</div><!-- fragment --><p>You should obtain such a result: </p><div class="image">
<img src="res3dCurveTangentEstimator.png" alt=""/>
<div class="caption">
Resulting tangent vectors (red) obtained with the VCM estimator.</div></div>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="3dCurveTangentEstimator_8cpp_source.html">3dCurveTangentEstimator.cpp</a> </dd></dl>
</div></div><!-- contents -->
</div><!-- PageDoc -->
<!-- HTML footer for doxygen 1.8.11-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Companion project associated to <a href= "http://liris.cnrs.fr/dgtal/doc/nightly/"> DGtal </a>;
Generated on Mon Dec 23 2024 09:51:49 for DGtalTools by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.9.1
</small></address>
</body>
</html>