-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathquickstart.html
More file actions
155 lines (134 loc) · 7.29 KB
/
quickstart.html
File metadata and controls
155 lines (134 loc) · 7.29 KB
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
144
145
146
147
148
149
150
151
152
153
154
155
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Quick Start — MultiDIC 1.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/documentation_options.js?v=f2a433a1"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Learn More about multiDIC" href="learn_more.html" />
<link rel="prev" title="Preface" href="preface.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
MultiDIC
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="preface.html">Preface</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Quick Start</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#installation-instructions">Installation Instructions</a></li>
<li class="toctree-l2"><a class="reference internal" href="#first-steps-with-rundic-m">First Steps with <cite>runDIC.m</cite></a></li>
<li class="toctree-l2"><a class="reference internal" href="#basic-example-for-finger-3d-reconstruction">Basic Example for Finger 3D Reconstruction</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="learn_more.html">Learn More about multiDIC</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev_place.html">Dev Place</a></li>
<li class="toctree-l1"><a class="reference internal" href="parallel_setting.html">Parallel Setting</a></li>
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">MultiDIC</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Quick Start</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/quickstart.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="quick-start">
<h1>Quick Start<a class="headerlink" href="#quick-start" title="Link to this heading">¶</a></h1>
<section id="installation-instructions">
<h2>Installation Instructions<a class="headerlink" href="#installation-instructions" title="Link to this heading">¶</a></h2>
<p>Before you can run multiDIC, follow these steps to install and configure your environment:</p>
<ol class="arabic simple">
<li><p><strong>Download the Project</strong>
You can download the latest version of multiDIC from the repository or extract it from a provided zip file.</p></li>
<li><p><strong>MATLAB Requirements</strong>
Ensure that MATLAB (version 2020a or later) is installed on your machine. You will also need the following MATLAB toolboxes:
- <strong>Image Processing Toolbox</strong>: For processing and analyzing the multi-camera images.
- <strong>Parallel Computing Toolbox</strong> (optional): For improving performance with parallel processing during large datasets or computationally intensive tasks.</p></li>
<li><p><strong>Add multiDIC to MATLAB Path</strong>
Open MATLAB and add the multiDIC project folder (where the <cite>xDIC</cite> folder resides) to the MATLAB path.</p></li>
<li><p><strong>Run a Test Example</strong>
To confirm everything is working, run the basic example:
<code class="docutils literal notranslate"><span class="pre">`matlab</span>
<span class="pre">runDIC;</span>
<span class="pre">`</span></code></p></li>
</ol>
</section>
<section id="first-steps-with-rundic-m">
<h2>First Steps with <cite>runDIC.m</cite><a class="headerlink" href="#first-steps-with-rundic-m" title="Link to this heading">¶</a></h2>
<p>The core script to execute the DIC process is <cite>runDIC.m</cite>. Before running, configure parameters in <cite>config.m</cite> and execute the script:
<code class="docutils literal notranslate"><span class="pre">`matlab</span>
<span class="pre">runDIC;</span>
<span class="pre">`</span></code></p>
</section>
<section id="basic-example-for-finger-3d-reconstruction">
<h2>Basic Example for Finger 3D Reconstruction<a class="headerlink" href="#basic-example-for-finger-3d-reconstruction" title="Link to this heading">¶</a></h2>
<ol class="arabic simple">
<li><p>Prepare the data (images from multiple calibrated cameras).</p></li>
</ol>
<p>2. Run the 3D reconstruction:
<code class="docutils literal notranslate"><span class="pre">`matlab</span>
<span class="pre">runDIC;</span>
<span class="pre">`</span></code>
3. Visualize the results using <cite>plot_multidic_results.m</cite>.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="preface.html" class="btn btn-neutral float-left" title="Preface" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="learn_more.html" class="btn btn-neutral float-right" title="Learn More about multiDIC" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright .</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>