-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
181 lines (160 loc) · 10.1 KB
/
index.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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<!DOCTYPE html>
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to the Image_Alignment documentation ! — Image Alignment 2024.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Introduction" href="user_guide/intro.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="#" class="icon icon-home">
Image Alignment
<img src="_static/logo.png" class="logo" alt="Logo"/>
</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">GUI Mode</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="user_guide/intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/visualization.html">Visualization</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/parameters.html">Files selection / Parameters settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/registration.html">Registration algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/processing.html">Processing</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/application.html">Workflow</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Scripting Mode</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="user_guide/scripting.html">Scripting</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/modules.html">images_alignment</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="#">Image Alignment</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="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Welcome to the Image_Alignment documentation !</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.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="welcome-to-the-image-alignment-documentation">
<h1>Welcome to the Image_Alignment documentation !<a class="headerlink" href="#welcome-to-the-image-alignment-documentation" title="Permalink to this heading"></a></h1>
<p><strong>Images_Alignment</strong> is an application dedicated to ease the images alignment using affine transformation matrices calculated either from the <a class="reference external" href="https://github.com/glichtner/pystackreg)">pyStackReg</a> or <a class="reference external" href="https://scikit-image.org/docs/stable/auto_examples/features_detection/plot_sift.html">SIFT</a> algorithm, a combined approach, or from a user driven approach (specifying manually the matching points).</p>
<p>Once the parameters have been set, they can be automatically applied to a set of images as part of a workflow.</p>
<p><strong>This documentation mainly focuses on using the application in GUI mode.</strong></p>
<p>For a <strong>scripting mode usage</strong>, please refer to the final section of this documentation.</p>
<section id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this heading"></a></h2>
<p>Assuming you have a python environment which is activated in a terminal, the application can be installed thanks the <code class="docutils literal notranslate"><span class="pre">pip</span></code> command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">git</span><span class="o">+</span><span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">CEA</span><span class="o">-</span><span class="n">MetroCarac</span><span class="o">/</span><span class="n">images_alignment</span><span class="o">.</span><span class="n">git</span>
</pre></div>
</div>
<p>Once installed, the application can be launched directly from a terminal (with the previous python environment activated), by:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">images_alignment</span>
</pre></div>
</div>
</section>
<section id="tests-execution">
<h2>Tests execution<a class="headerlink" href="#tests-execution" title="Permalink to this heading"></a></h2>
<p>For developers, the full package including examples and tests can be installed via:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">CEA</span><span class="o">-</span><span class="n">MetroCarac</span><span class="o">/</span><span class="n">images_alignment</span><span class="o">.</span><span class="n">git</span>
<span class="n">cd</span> <span class="n">images_alignment</span>
<span class="n">pip</span> <span class="n">install</span> <span class="o">.</span>
</pre></div>
</div>
<p>The tests can be executed via the following commands:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">pytest</span>
<span class="n">pytest</span> <span class="n">tests</span>
</pre></div>
</div>
</section>
<section id="image-alignment-documentation">
<h2>Image_Alignment documentation<a class="headerlink" href="#image-alignment-documentation" title="Permalink to this heading"></a></h2>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">GUI Mode</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="user_guide/intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/visualization.html">Visualization</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/parameters.html">Files selection / Parameters settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/registration.html">Registration algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/processing.html">Processing</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/application.html">Workflow</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Scripting Mode</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="user_guide/scripting.html">Scripting</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/modules.html">images_alignment</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/images_alignment.html">images_alignment package</a></li>
</ul>
</li>
</ul>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="user_guide/intro.html" class="btn btn-neutral float-right" title="Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2024, SMCP-PFNC.</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>