-
Notifications
You must be signed in to change notification settings - Fork 0
/
contourGenerator.html
141 lines (139 loc) · 10.3 KB
/
contourGenerator.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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
<!-- 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: contourGenerator</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">contourGenerator </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Generates multigrid contours of 2d digital shapes using <a class="el" href="namespaceDGtal.html">DGtal</a> library.</p>
<p>The associated geometric information like contour, curvature can also be displayed.</p>
<p><b>Usage:</b> contourGenerator –shape <shapeName> [requiredParam] [otherOptions]</p>
<p><b>Allowed</b> <b>options</b> <b>are:</b> </p>
<div class="fragment"><div class="line">-h,--help Print <span class="keyword">this</span> help message and exit</div>
<div class="line">-l,--list List all available shapes</div>
<div class="line">-s,--shape TEXT Shape name</div>
<div class="line">-R,--radius FLOAT Radius of the shape</div>
<div class="line">-A,--axis1 FLOAT Half big axis of the shape (ellipse)</div>
<div class="line">-a,--axis2 FLOAT Half small axis of the shape (ellipse)</div>
<div class="line">-r,--smallradius FLOAT=5 Small radius of the shape (<span class="keywordflow">default</span> 5)</div>
<div class="line">-v,--varsmallradius FLOAT=5 Variable small radius of the shape (<span class="keywordflow">default</span> 5)</div>
<div class="line">-k UINT=3 Number of branches or corners the shape (<span class="keywordflow">default</span> 3)</div>
<div class="line">--phi FLOAT=0 Phase of the shape (in radian, <span class="keywordflow">default</span> 0.0)</div>
<div class="line">-w,--width FLOAT=10 Width of the shape (<span class="keywordflow">default</span> 10.0)</div>
<div class="line">-p,--<a class="codeRef" href="https://dgtal-team.github.io/doc-nightly/namespaceDGtal_1_1functions.html#a18b68d329aa1461a0847a18e99247885">power</a> FLOAT=2 Power of the metric (<span class="keywordflow">default</span> 2.0)</div>
<div class="line">-x,--center_x FLOAT=0 x-coordinate of the shape center (<span class="keywordflow">default</span> 0.0)</div>
<div class="line">-y,--center_y FLOAT=0 y-coordinate of the shape center (<span class="keywordflow">default</span> 0.0)</div>
<div class="line">-g,--gridstep FLOAT=1 Gridstep <span class="keywordflow">for</span> the digitization (<span class="keywordflow">default</span> 1.0)</div>
<div class="line">-f,--format TEXT=pts Output format:</div>
<div class="line"> List of pointel coordinates {pts}</div>
<div class="line"> Freeman chaincode <a class="codeRef" href="https://dgtal-team.github.io/doc-nightly/namespaceDGtal_1_1Z2i.html#a7622ca076fc84589070b3a7719f0eb1e">Vector</a> {fc} (<span class="keywordflow">default</span> pts)</div>
<div class="line">-o,--outputGeometry TEXT Base name of the file containing the shape geometry (points, tangents, curvature)</div>
<div class="ttc" id="anamespaceDGtal_1_1Z2i_html_a7622ca076fc84589070b3a7719f0eb1e"><div class="ttname"><a href="https://dgtal-team.github.io/doc-nightly/namespaceDGtal_1_1Z2i.html#a7622ca076fc84589070b3a7719f0eb1e">DGtal::Z2i::Vector</a></div><div class="ttdeci">Space::Vector Vector</div></div>
<div class="ttc" id="anamespaceDGtal_1_1functions_html_a18b68d329aa1461a0847a18e99247885"><div class="ttname"><a href="https://dgtal-team.github.io/doc-nightly/namespaceDGtal_1_1functions.html#a18b68d329aa1461a0847a18e99247885">DGtal::functions::power</a></div><div class="ttdeci">T power(const T &aVal, const unsigned int exponent)</div></div>
</div><!-- fragment --><p>You can also list all possible shapes: </p><div class="fragment"><div class="line">contourGenerator --list</div>
<div class="line">2D Shapes:</div>
<div class="line"> ball Ball <span class="keywordflow">for</span> the Euclidean metric.</div>
<div class="line"> Required parameter(s): --radius [-R]</div>
<div class="line"> <a class="codeRef" href="https://dgtal-team.github.io/doc-nightly/namespaceDGtal_1_1functions.html#ac8e2160844093488cdd738354027daa1">square</a> <a class="codeRef" href="https://dgtal-team.github.io/doc-nightly/namespaceDGtal_1_1functions.html#ac8e2160844093488cdd738354027daa1">square</a> (no signature).</div>
<div class="line"> Required parameter(s): --width [-w]</div>
<div class="line"> lpball Ball for the l_power metric (no signature).</div>
<div class="line"> Required parameter(s): --radius [-R], --<a class="codeRef" href="https://dgtal-team.github.io/doc-nightly/namespaceDGtal_1_1functions.html#a18b68d329aa1461a0847a18e99247885">power</a> [-p]</div>
<div class="line"> flower Flower with k petals with radius ranging from R+/-v.</div>
<div class="line"> Required parameter(s): --radius [-R], --varsmallradius [-v], --k [-k], --phi</div>
<div class="line"> ngon Regular k-gon.</div>
<div class="line"> Required parameter(s): --radius [-R], --k [-k], --phi </div>
<div class="line"> accflower Accelerated Flower with k petals.</div>
<div class="line"> Required parameter(s): --radius [-R], --varsmallradius [-v], --k [-k], --phi</div>
<div class="line"> ellipse Ellipse.</div>
<div class="line"> Required parameter(s): --axis1 [-A], --axis2 [-a], --phi </div>
<div class="ttc" id="anamespaceDGtal_1_1functions_html_ac8e2160844093488cdd738354027daa1"><div class="ttname"><a href="https://dgtal-team.github.io/doc-nightly/namespaceDGtal_1_1functions.html#ac8e2160844093488cdd738354027daa1">DGtal::functions::square</a></div><div class="ttdeci">T square(T x)</div></div>
</div><!-- fragment --><p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor"># generate a flower contour with 5 petals of maximal radius 5 and small radius 3 with grid size = 0.1:</span></div>
<div class="line">./shapeGenerator/contourGenerator -s flower -R 5 -v 3 -k 5 --outputGeometry result -g 0.1</div>
<div class="line"><span class="preprocessor"># Display the results using gnuplot:</span></div>
<div class="line">$gnuplot</div>
<div class="line">[gnuplot> plot [][-5:2]<span class="stringliteral">'res.geom'</span> <span class="keyword">using</span> 1:6 w l t <span class="stringliteral">"curvature"</span></div>
<div class="line">[gnuplot> plot <span class="stringliteral">'res.geom'</span> <span class="keyword">using</span> 2:3 w l t <span class="stringliteral">"contour flower"</span></div>
</div><!-- fragment --><p>You should obtain such a visualization: </p><div class="image">
<img src="resContourGenerator.png" alt=""/>
<div class="caption">
resulting visualisation of generated contour (a) and curvature (b).</div></div>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="contourGenerator_8cpp_source.html">contourGenerator.cpp</a> <a class="el" href="shapeGenerator.html">shapeGenerator</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 Aug 26 2024 21:31:31 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>