xdic-dev.github.io/preface.html at main · xdic-dev/xdic-dev.github.io · GitHub

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
156
157
158
159
160
161
162
163
164
165
166


<!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>Preface &mdash; 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="Quick Start" href="quickstart.html" />
    <link rel="prev" title="multiDIC Documentation" href="index.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 current"><a class="current reference internal" href="#">Preface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#how-to-read-this-tutorial">How to read this tutorial</a></li>
<li class="toctree-l2"><a class="reference internal" href="#what-you-will-not-find-in-this-document">What you will NOT find in this document</a></li>
<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#getting-help">Getting Help</a></li>
<li class="toctree-l2"><a class="reference internal" href="#learning">Learning</a></li>
<li class="toctree-l2"><a class="reference internal" href="#miscellaneous">Miscellaneous</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick Start</a></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">Preface</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/preface.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="preface">
<h1>Preface<a class="headerlink" href="#preface" title="Link to this heading">¶</a></h1>
<section id="how-to-read-this-tutorial">
<h2>How to read this tutorial<a class="headerlink" href="#how-to-read-this-tutorial" title="Link to this heading">¶</a></h2>
<p>Welcome to the multiDIC documentation. This tutorial is designed to help users get familiar with the multiDIC software, which enables 3D reconstruction of fingers using multi-camera data. Each section provides progressively deeper insights into how the software works, from basic usage to advanced customization. It’s recommended to start with the <strong>Quick Start</strong> section to get hands-on experience before diving into more complex topics.</p>
</section>
<section id="what-you-will-not-find-in-this-document">
<h2>What you will NOT find in this document<a class="headerlink" href="#what-you-will-not-find-in-this-document" title="Link to this heading">¶</a></h2>
<p>This document focuses on the technical implementation and usage of multiDIC. You will not find:
- Detailed mathematical background behind 3D reconstruction (though external references will be provided).
- Deep dive into MATLAB programming (only what’s necessary for multiDIC usage).
- Guidelines for advanced hardware setups (such as complex multi-camera systems).</p>
</section>
<section id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h2>
<p>To install multiDIC, follow these steps:
1. Clone the repository or download the project from the source.
2. Ensure you have MATLAB installed on your system (version 2020a or later recommended).
3. Add the multiDIC project folder to your MATLAB path.
4. Install any required MATLAB toolboxes such as the Image Processing Toolbox and Parallel Computing Toolbox (as needed for specific features). Mainly ensure [NCorr]() is installed
5. Run a simple test to check everything is set up correctly (use the <cite>runDIC.m</cite> script).</p>
</section>
<section id="getting-help">
<h2>Getting Help<a class="headerlink" href="#getting-help" title="Link to this heading">¶</a></h2>
<p>If you encounter any issues, you can:
- Refer to the <strong>Troubleshooting</strong> section in the <strong>Learn More about multiDIC</strong> chapter.
- Check out the MATLAB documentation for any issues related to general MATLAB commands.
- Contact the developers through the official multiDIC repository or the provided communication channels.</p>
</section>
<section id="learning">
<h2>Learning<a class="headerlink" href="#learning" title="Link to this heading">¶</a></h2>
<p>To get the most out of multiDIC, it’s important to understand the basics of 3D reconstruction, camera calibration, and MATLAB programming. The <strong>Learn More about multiDIC</strong> section will provide additional resources, but here are a few external references that might help you get up to speed:
- MATLAB documentation for image processing and multi-camera setups.
- Academic papers on 3D reconstruction techniques.
- Online tutorials for MATLAB basics (if you’re new to MATLAB).</p>
</section>
<section id="miscellaneous">
<h2>Miscellaneous<a class="headerlink" href="#miscellaneous" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><strong>Acknowledgments</strong>: We thank all contributors who have helped in the development of multiDIC.</p></li>
<li><p><strong>Citation Guidelines</strong>: If you use multiDIC in your research, please cite the following papers and repository:
- [Include citation guidelines here].</p></li>
<li><p><strong>Useful Links</strong>:
- MATLAB Documentation: [MATLAB Documentation Link]
- Related research papers: [Insert links here]</p></li>
</ul>
</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="index.html" class="btn btn-neutral float-left" title="multiDIC Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="quickstart.html" class="btn btn-neutral float-right" title="Quick Start" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; 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>