-
Notifications
You must be signed in to change notification settings - Fork 0
/
Doc3DSDPViewer.html
143 lines (141 loc) · 10.4 KB
/
Doc3DSDPViewer.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
142
143
<!-- 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: 3DSDPViewer</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">3DSDPViewer </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Displays a sequence of 3d discrete points by using QGLviewer.</p>
<p><b>Usage:</b> 3dSDPViewer [OPTIONS] 1 [f] [lineSize] [filterVectors]</p>
<p><b>Allowed</b> <b>options</b> <b>are</b> :</p>
<div class="fragment"><div class="line">Positionals:</div>
<div class="line"> 1 TEXT:FILE REQUIRED input file: sdp (sequence of discrete points).</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 input file: sdp (sequence of discrete points).</div>
<div class="line"> --SDPindex UINT x 3 specify the sdp index (by <span class="keywordflow">default</span> 0,1,2).</div>
<div class="line"> -c,--pointColor INT x 4 set the color of points: r g b a.</div>
<div class="line"> -l,--lineColor INT x 4 set the color of line: r g b a.</div>
<div class="line"> -m,--addMesh TEXT append a mesh (off/obj) to the point set visualization.</div>
<div class="line"> --customColorMesh UINT x 4 set the R, G, B, A components of the colors of the mesh faces (mesh added with option --addMesh).</div>
<div class="line"> --customAlphaMesh UINT set single alpha(A) components of the colors of the mesh faces (mesh added with option --addMesh).</div>
<div class="line"> --importColors <span class="keyword">import</span> point colors from the input file (R G B colors should be by <span class="keywordflow">default</span> at index 3, 4, 5).</div>
<div class="line"> --setColorsIndex UINT x 3 Needs: --importColors</div>
<div class="line"> customize the index of the imported colors in the <a class="codeRef" href="https://dgtal-team.github.io/doc-nightly/namespaceboost.html#a6ef3be04115b85579ddf40d86e3ed4d5">source</a> file (used by --importColor). By <span class="keywordflow">default</span> the initial indexes are 3, 4, 5.</div>
<div class="line"> --importColorLabels <span class="keyword">import</span> color labels from the input file (label index should be by <span class="keywordflow">default</span> at index 3).</div>
<div class="line"> --setColorLabelIndex UINT=3 customize the index of the imported color labels in the <a class="codeRef" href="https://dgtal-team.github.io/doc-nightly/namespaceboost.html#a6ef3be04115b85579ddf40d86e3ed4d5">source</a> file (used by -importColorLabels).</div>
<div class="line"> -f,--filter FLOAT=100 filter input file in order to display only the [arg] percent of the input 3D points (uniformly selected).</div>
<div class="line"> --noPointDisplay usefull <span class="keywordflow">for</span> instance to only display the lines between points.</div>
<div class="line"> --drawLines draw the line between discrete points.</div>
<div class="line"> -x,--scaleX FLOAT=1 set the scale value in the X direction</div>
<div class="line"> -y,--scaleY FLOAT=1 set the scale value in the Y direction</div>
<div class="line"> -z,--scaleZ FLOAT=1 set the scale value in the Z direction</div>
<div class="line"> --sphereResolution UINT=30 defines the sphere resolution (used when the primitive is set to the sphere).</div>
<div class="line"> -s,--sphereRadius FLOAT=0.2 defines the sphere radius (used when the primitive is set to the sphere).</div>
<div class="line"> --sphereRadiusFromInput takes, as sphere radius, the 4th field of the sdp input file.</div>
<div class="line"> --lineSize FLOAT=0.2 defines the line size (used when the --drawLines or --drawVectors option is selected).</div>
<div class="line"> -p,--primitive TEXT:{voxel,glPoints,sphere}=voxel</div>
<div class="line"> set the primitive to display the set of points.</div>
<div class="line"> -v,--drawVectors TEXT SDP vector file: draw a set of vectors from the given file (each vector are determined by two consecutive point given, each point represented by its coordinates on a single line.</div>
<div class="line"> -u,--unitVector FLOAT=0 specifies that the SDP vector file format (of --drawVectors option) should be interpreted as unit vectors (each vector position is be defined from the input point (with input order) with a constant norm defined by [arg]).</div>
<div class="line"> --filterVectors FLOAT=100 filters vector input file in order to display only the [arg] percent of the input vectors (uniformly selected, to be used with option --drawVectors <span class="keywordflow">else</span> no effect).</div>
<div class="line"> --interactiveDisplayVoxCoords by <span class="keyword">using</span> <span class="keyword">this</span> option the coordinates can be displayed after selection (shift+left click on voxel).</div>
<div class="ttc" id="anamespaceboost_html_a6ef3be04115b85579ddf40d86e3ed4d5"><div class="ttname"><a href="https://dgtal-team.github.io/doc-nightly/namespaceboost.html#a6ef3be04115b85579ddf40d86e3ed4d5">boost::source</a></div><div class="ttdeci">graph_traits< DGtal::DigitalSurface< TDigitalSurfaceContainer > >::vertex_descriptor source(typename graph_traits< DGtal::DigitalSurface< TDigitalSurfaceContainer > >::edge_descriptor edge, const DGtal::DigitalSurface< TDigitalSurfaceContainer > &digSurf)</div></div>
</div><!-- fragment --><p><b>Basic</b> <b>example:</b> </p>
<p>You can display a set of 3D points with sphere primitive and lines: </p><div class="fragment"><div class="line">$ 3DSDPViewer $DGtal/tests/samples/sinus3D.dat -p sphere -s 0.3 --drawLines --lineSize 5</div>
</div><!-- fragment --><p>You should obtain such a result:</p>
<div class="image">
<img src="res3DSDPViewer.png" alt=""/>
<div class="caption">
Resulting visualization.</div></div>
<p><b>Example</b> <b>with</b> <b>interactive</b> <b>selection</b> :</p>
<p>This tool can be useful to recover coordinates from a set of voxels. To do it, you have to add the option allowing to activate the interactive selection (with –interactiveDisplayVoxCoords), for instance if you apply: </p><div class="fragment"><div class="line">$ 3dSDPViewer $DGtal/tests/samples/sinus3D.dat --interactiveDisplayVoxCoords</div>
</div><!-- fragment --><p> you should be able to select a voxel by using the SHIFT key and by clicking on a voxel: </p><div class="image">
<img src="res3DSDPViewerInteractive.png" alt=""/>
</div>
<p><b>Visualization</b> <b>of</b> <b>large</b> <b>point</b> <b>set</b> </p>
<p>If you need to display an important number of points, you can use the primitive <em>glPoints</em> instead <em>voxel</em> or <em>sphere</em> (-p glPoints). You will obtain such type of a visualization:</p>
<div class="image">
<img src="res3DSDPViewerGLPoints.png" alt=""/>
</div>
<dl class="section see"><dt>See also</dt><dd>3DSDPViewer.cpp </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>