-
-
Notifications
You must be signed in to change notification settings - Fork 37
/
readme.html
387 lines (380 loc) · 26.2 KB
/
readme.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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>1. PlenoptiCam — PlenoptiCam 0.9.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/sphinxdoc.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="2. User Guide" href="guide.html" />
<link rel="prev" title="PlenoptiCam’s Reference Document" href="index.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="guide.html" title="2. User Guide"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="PlenoptiCam’s Reference Document"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">PlenoptiCam 0.9.1 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">1. </span>PlenoptiCam</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="plenopticam">
<h1><span class="section-number">1. </span>PlenoptiCam<a class="headerlink" href="#plenopticam" title="Permalink to this headline">¶</a></h1>
<div class="section" id="description">
<h2><span class="section-number">1.1. </span>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p><em>PlenoptiCam</em> is an open-source software (<a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.9.1-beta/plenopticam_0.9.1.dmg">macOS</a>, <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.9.1-beta/plenopticam_0.9.1.msi">Win</a> or <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.9.1-beta/plenopticam_0.9.1.tar.gz">Linux</a>) for scientific light field computation with cross-platform compatibility, few dependencies and a lean graphical user interface.
Raw exposures from a plenoptic camera require four-dimensional image alignment in order to be decoded as a light field. Provided software addresses this by its ability to calibrate an image taken by a plenoptic camera and extract sub-aperture images or synthetically focused photographs.
This application is meant for researchers, developers, beginners and other fiddlers who like to experiment with light field technology. Its scope comprises custom-types of plenoptic cameras and is thus not limited to Lytro’s image data.</p>
<p><a class="reference external" href="https://github.com/hahnec/plenopticam/releases/"><img alt="release" src="https://img.shields.io/github/release/hahnec/plenopticam.svg?style=flat-square" /></a> <a class="reference external" href="https://www.gnu.org/licenses/gpl-3.0.en.html"><img alt="License" src="https://img.shields.io/badge/License-GPL%20v3.0-orange.svg?style=flat-square" /></a> <a class="reference external" href="https://travis-ci.com/github/hahnec/plenopticam"><img alt="travis" src="https://img.shields.io/travis/com/hahnec/plenopticam/master?style=flat-square" /></a> <a class="reference external" href="https://coveralls.io/github/hahnec/plenopticam"><img alt="coverage" src="https://img.shields.io/coveralls/github/hahnec/plenopticam?style=flat-square" /></a> <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/"><img alt="Release Downloads" src="https://img.shields.io/github/downloads/hahnec/plenopticam/total?label=Release%20downloads&style=flat-square" /></a> <a class="reference external" href="https://pypi.org/project/plenopticam/"><img alt="PyPI Downloads" src="https://img.shields.io/pypi/dm/plenopticam?label=PyPI%20downloads&style=flat-square" /></a></p>
<p><a class="reference external" href="https://arxiv.org/pdf/2010.11687.pdf"><img alt="arXiv link" src="http://img.shields.io/badge/paper-arxiv.2010.11687-red.svg?style=flat-square" /></a></p>
<p><a class="reference external" href="https://colab.research.google.com/github/hahnec/plenopticam/blob/master/examples/04_illum_demo.ipynb"><img alt="colab" src="https://colab.research.google.com/assets/colab-badge.svg?style=flat-square" style="width: 175px;" /></a></p>
</div>
<div class="section" id="results">
<h2><span class="section-number">1.2. </span>Results<a class="headerlink" href="#results" title="Permalink to this headline">¶</a></h2>
<div class="section" id="datesets">
<h3><span class="section-number">1.2.1. </span>Datesets<a class="headerlink" href="#datesets" title="Permalink to this headline">¶</a></h3>
<table class="colwidths-given docutils align-default">
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p><a class="reference external" href="https://ndownloader.figshare.com/files/5201452"><strong>OpEx dataset</strong></a></p></th>
<th class="head"><p><a class="reference external" href="https://www.irisa.fr/temics/demos/IllumDatasetLF/index.html"><strong>INRIA dataset</strong></a></p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><img src="https://raw.githubusercontent.com/hahnec/plenopticam/master/docs/img/demo_custom.gif" height="187px" max-width:"100%"></p></td>
<td><p><img src="https://raw.githubusercontent.com/hahnec/plenopticam/master/docs/img/demo_illum.gif" height="187px" max-width:"100%"></p></td>
</tr>
<tr class="row-odd"><td><p>Custom-built (png, jpg, bmp files)</p></td>
<td><p>Lytro Illum (lfp, lfr, tar files)</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="https://mybinder.org/v2/gh/hahnec/plenopticam/master?urlpath=lab"><img alt="binder" src="https://img.shields.io/badge/launch-binder-E66581.svg?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFkAAABZCAMAAABi1XidAAAB8lBMVEX///9XmsrmZYH1olJXmsr1olJXmsrmZYH1olJXmsr1olJXmsrmZYH1olL1olJXmsr1olJXmsrmZYH1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olJXmsrmZYH1olL1olL0nFf1olJXmsrmZYH1olJXmsq8dZb1olJXmsrmZYH1olJXmspXmspXmsr1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olLeaIVXmsrmZYH1olL1olL1olJXmsrmZYH1olLna31Xmsr1olJXmsr1olJXmsrmZYH1olLqoVr1olJXmsr1olJXmsrmZYH1olL1olKkfaPobXvviGabgadXmsqThKuofKHmZ4Dobnr1olJXmsr1olJXmspXmsr1olJXmsrfZ4TuhWn1olL1olJXmsqBi7X1olJXmspZmslbmMhbmsdemsVfl8ZgmsNim8Jpk8F0m7R4m7F5nLB6jbh7jbiDirOEibOGnKaMhq+PnaCVg6qWg6qegKaff6WhnpKofKGtnomxeZy3noG6dZi+n3vCcpPDcpPGn3bLb4/Mb47UbIrVa4rYoGjdaIbeaIXhoWHmZYHobXvpcHjqdHXreHLroVrsfG/uhGnuh2bwj2Hxk17yl1vzmljzm1j0nlX1olL3AJXWAAAAbXRSTlMAEBAQHx8gICAuLjAwMDw9PUBAQEpQUFBXV1hgYGBkcHBwcXl8gICAgoiIkJCQlJicnJ2goKCmqK+wsLC4usDAwMjP0NDQ1NbW3Nzg4ODi5+3v8PDw8/T09PX29vb39/f5+fr7+/z8/Pz9/v7+zczCxgAABC5JREFUeAHN1ul3k0UUBvCb1CTVpmpaitAGSLSpSuKCLWpbTKNJFGlcSMAFF63iUmRccNG6gLbuxkXU66JAUef/9LSpmXnyLr3T5AO/rzl5zj137p136BISy44fKJXuGN/d19PUfYeO67Znqtf2KH33Id1psXoFdW30sPZ1sMvs2D060AHqws4FHeJojLZqnw53cmfvg+XR8mC0OEjuxrXEkX5ydeVJLVIlV0e10PXk5k7dYeHu7Cj1j+49uKg7uLU61tGLw1lq27ugQYlclHC4bgv7VQ+TAyj5Zc/UjsPvs1sd5cWryWObtvWT2EPa4rtnWW3JkpjggEpbOsPr7F7EyNewtpBIslA7p43HCsnwooXTEc3UmPmCNn5lrqTJxy6nRmcavGZVt/3Da2pD5NHvsOHJCrdc1G2r3DITpU7yic7w/7Rxnjc0kt5GC4djiv2Sz3Fb2iEZg41/ddsFDoyuYrIkmFehz0HR2thPgQqMyQYb2OtB0WxsZ3BeG3+wpRb1vzl2UYBog8FfGhttFKjtAclnZYrRo9ryG9uG/FZQU4AEg8ZE9LjGMzTmqKXPLnlWVnIlQQTvxJf8ip7VgjZjyVPrjw1te5otM7RmP7xm+sK2Gv9I8Gi++BRbEkR9EBw8zRUcKxwp73xkaLiqQb+kGduJTNHG72zcW9LoJgqQxpP3/Tj//c3yB0tqzaml05/+orHLksVO+95kX7/7qgJvnjlrfr2Ggsyx0eoy9uPzN5SPd86aXggOsEKW2Prz7du3VID3/tzs/sSRs2w7ovVHKtjrX2pd7ZMlTxAYfBAL9jiDwfLkq55Tm7ifhMlTGPyCAs7RFRhn47JnlcB9RM5T97ASuZXIcVNuUDIndpDbdsfrqsOppeXl5Y+XVKdjFCTh+zGaVuj0d9zy05PPK3QzBamxdwtTCrzyg/2Rvf2EstUjordGwa/kx9mSJLr8mLLtCW8HHGJc2R5hS219IiF6PnTusOqcMl57gm0Z8kanKMAQg0qSyuZfn7zItsbGyO9QlnxY0eCuD1XL2ys/MsrQhltE7Ug0uFOzufJFE2PxBo/YAx8XPPdDwWN0MrDRYIZF0mSMKCNHgaIVFoBbNoLJ7tEQDKxGF0kcLQimojCZopv0OkNOyWCCg9XMVAi7ARJzQdM2QUh0gmBozjc3Skg6dSBRqDGYSUOu66Zg+I2fNZs/M3/f/Grl/XnyF1Gw3VKCez0PN5IUfFLqvgUN4C0qNqYs5YhPL+aVZYDE4IpUk57oSFnJm4FyCqqOE0jhY2SMyLFoo56zyo6becOS5UVDdj7Vih0zp+tcMhwRpBeLyqtIjlJKAIZSbI8SGSF3k0pA3mR5tHuwPFoa7N7reoq2bqCsAk1HqCu5uvI1n6JuRXI+S1Mco54YmYTwcn6Aeic+kssXi8XpXC4V3t7/ADuTNKaQJdScAAAAAElFTkSuQmCC" style="width: 175px;" /></a></p></td>
<td><p><a class="reference external" href="https://colab.research.google.com/github/hahnec/plenopticam/blob/master/examples/04_illum_demo.ipynb"><img alt="colab" src="https://colab.research.google.com/assets/colab-badge.svg?style=flat-square" style="width: 175px;" /></a></p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="color-equalization">
<h3><span class="section-number">1.2.2. </span>Color equalization<a class="headerlink" href="#color-equalization" title="Permalink to this headline">¶</a></h3>
<table class="colwidths-given docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Before</p></th>
<th class="head"><p>Target</p></th>
<th class="head"><p>After</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><img src="https://raw.githubusercontent.com/hahnec/color-matcher/master/tests/data/view_animation_7px.gif" width="200px" max-width:"100%"></p></td>
<td><p><img src="https://raw.githubusercontent.com/hahnec/color-matcher/master/tests/data/bee_2.png" width="200px" max-width:"100%"></p></td>
<td><p><img src="https://raw.githubusercontent.com/hahnec/color-matcher/master/tests/data/view_animation_7px_hm-mkl-hm.gif" width="200px" max-width:"100%"></p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="depth">
<h3><span class="section-number">1.2.3. </span>Depth<a class="headerlink" href="#depth" title="Permalink to this headline">¶</a></h3>
<table class="colwidths-given docutils align-default">
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>2-D depth map</p></th>
<th class="head"><p>3-D point cloud</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><img src="https://raw.githubusercontent.com/hahnec/plenopticam/master/docs/img/depth_demo_lores.png" max-width:"100%"></p></td>
<td><p><img src="https://raw.githubusercontent.com/hahnec/plenopticam/master/docs/img/depth_anim.gif"></p></td>
</tr>
<tr class="row-odd"><td><p>pfm file format</p></td>
<td><p>ply file format</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="installation">
<h2><span class="section-number">1.3. </span>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><dl class="simple">
<dt>executable:</dt><dd><ol class="arabic simple">
<li><p>download bundled <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/">apps</a> for <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.9.1-beta/plenopticam_0.9.1.dmg">macOS</a>, <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.9.1-beta/plenopticam_0.9.1.msi">Win</a> or <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.9.1-beta/plenopticam_0.9.1.tar.gz">Linux</a></p></li>
<li><p>run installer / extract archive</p></li>
<li><p>work around <a class="reference external" href="https://stackoverflow.com/a/65488937/10874787"><strong>Windows protection</strong></a> or <a class="reference external" href="https://osxdaily.com/2015/05/04/disable-gatekeeper-command-line-mac-osx/"><strong>macOS unidentified developer</strong></a> issue</p></li>
<li><p>run executable (may take a while on first start-up)</p></li>
<li><p>user interface will show up (see below)</p></li>
</ol>
</dd>
</dl>
</li>
</ul>
<div class="line-block">
<div class="line"><br /></div>
</div>
<ul class="simple">
<li><dl class="simple">
<dt>via pip:</dt><dd><ol class="arabic simple">
<li><p>install with <code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">python3</span> <span class="pre">-m</span> <span class="pre">pip</span> <span class="pre">install</span> <span class="pre">plenopticam</span></code></p></li>
<li><p>type <code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">plenopticam</span> <span class="pre">-g</span></code> to the command line once installation finished</p></li>
</ol>
</dd>
</dl>
</li>
</ul>
<div class="line-block">
<div class="line"><br /></div>
</div>
<ul class="simple">
<li><dl class="simple">
<dt>from source:</dt><dd><ol class="arabic simple">
<li><p>install Python from <a class="reference external" href="https://www.python.org/">https://www.python.org/</a></p></li>
<li><p>download the <a class="reference external" href="https://github.com/hahnec/plenopticam/archive/master.zip">source</a> using <code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">git</span> <span class="pre">clone</span> <span class="pre">https://github.com/hahnec/plenopticam.git</span></code></p></li>
<li><p>go to the root directory <code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">cd</span> <span class="pre">plenopticam</span></code></p></li>
<li><p>load other packages <code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">python3</span> <span class="pre">-m</span> <span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-r</span> <span class="pre">requirements.txt</span></code></p></li>
<li><p>install with <code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">sudo</span> <span class="pre">python3</span> <span class="pre">setup.py</span> <span class="pre">install</span></code> from root directory</p></li>
<li><p>if installation ran smoothly, enter <code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">sudo</span> <span class="pre">plenopticam</span> <span class="pre">-g</span></code> to the command line</p></li>
</ol>
</dd>
</dl>
</li>
</ul>
</div>
<div class="section" id="usage">
<h2><span class="section-number">1.4. </span>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<div class="section" id="application">
<h3><span class="section-number">1.4.1. </span>Application<a class="headerlink" href="#application" title="Permalink to this headline">¶</a></h3>
<p><p align="center">
<img src="https://raw.githubusercontent.com/hahnec/plenopticam/master/docs/img/gui_linux.png" width="66%">
<p></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>“Pick folder” checkbox is useful to point to a directory containing calibration archive files of Lytro Illum cameras.
In such case, the white image calibration file corresponding to the Lytro Illum image is found automatically.</p>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<ol class="arabic simple" start="0">
<li><dl class="simple">
<dt>Download a dataset if you don’t call a plenoptic camera your own, e.g.:</dt><dd><ul class="simple">
<li><p><a class="reference external" href="https://ndownloader.figshare.com/files/5201452"><strong>OpEx dataset</strong></a></p></li>
<li><p><a class="reference external" href="https://www.irisa.fr/temics/demos/IllumDatasetLF/index.html"><strong>INRIA dataset</strong></a></p></li>
</ul>
</dd>
</dl>
</li>
</ol>
<div class="line-block">
<div class="line"><br /></div>
</div>
<ol class="arabic simple">
<li><dl class="simple">
<dt>Choose your light field photograph using upper <strong>Browse</strong> button. Supported file types are:</dt><dd><ul class="simple">
<li><p><em>bmp</em>, <em>jpg</em> or <em>png</em> file from custom-built plenoptic camera</p></li>
<li><p><em>lfr</em>, <em>lfp</em> and <em>raw</em> files from Lytro Illum</p></li>
</ul>
</dd>
</dl>
</li>
</ol>
<div class="line-block">
<div class="line"><br /></div>
</div>
<ol class="arabic simple" start="2">
<li><dl class="simple">
<dt>Choose calibration source data using lower <strong>Browse</strong> button. Supported file types are:</dt><dd><ul class="simple">
<li><p><em>bmp</em>, <em>jpg</em> or <em>png</em> file from custom-built plenoptic camera</p></li>
<li><p><em>caldata-XXX.tar</em> archive or respective <em>raw</em> file from Lytro Illum</p></li>
<li><p>tick “Pick folder” and point to a directory containing all <em>tar</em> files or extracted folders (calibration file will be found automatically)</p></li>
</ul>
</dd>
</dl>
</li>
</ol>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If you are <a class="reference external" href="https://hahnec.github.io/plenopticam/build/html/guide.html#using-your-own-lytro-illum">using your own Lytro Illum</a> camera, you first need to extract camera calibration data as a <em>tar</em>-archive. To do so, please follow the <a class="reference external" href="https://hahnec.github.io/plenopticam/build/html/guide.html">instructions guide</a>.</p>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<ol class="arabic simple" start="3">
<li><dl class="simple">
<dt>Adjust configuration using <strong>Settings</strong> button:</dt><dd><ul class="simple">
<li><p><em>Micro image patch size</em>: default is estimated maximum</p></li>
<li><p><em>Refocusing range</em>: range for shift and sum synthesis</p></li>
<li><p><em>Force re-calibration</em>: option to re-run calibration</p></li>
<li><p><em>Automatic white balance</em>: option for white balancing</p></li>
<li><p><em>Refocus refinement</em>: option for sub-pixel precise refocusing</p></li>
<li><p><em>Scheimpflug</em>: option to mimic tilted sensor</p></li>
</ul>
</dd>
</dl>
</li>
</ol>
<div class="line-block">
<div class="line"><br /></div>
</div>
<ol class="arabic simple" start="4">
<li><p>Press <strong>Process</strong> to start the computation.</p></li>
</ol>
<div class="line-block">
<div class="line"><br /></div>
</div>
</div>
<div class="section" id="command-line">
<h3><span class="section-number">1.4.2. </span>Command Line<a class="headerlink" href="#command-line" title="Permalink to this headline">¶</a></h3>
<p>For computing a stack of light-field images, it may be convenient to iterate through them. This can be done by:</p>
<p><code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">sudo</span> <span class="pre">plenopticam</span> <span class="pre">-f</span> <span class="pre">'/Users/../Folder/'</span> <span class="pre">-c</span> <span class="pre">'Users/../caldata-B5144000XXX.tar'</span></code></p>
<p>with necessary write privileges on Unix Systems. A Windows-equivalent command would be as follows:</p>
<p><code class="docutils literal notranslate"><span class="pre">plenopticam</span> <span class="pre">--file="C:\\..\\Folder\\"</span> <span class="pre">--cali="C:\\..\\caldata-B5144000XXX.tar"</span></code></p>
<p>More information on optional arguments can be found using the help parameter</p>
<p><code class="docutils literal notranslate"><span class="pre">plenopticam</span> <span class="pre">-h</span></code></p>
<p>Results can be found inside a folder named after your light field file which is located in the same directory path.
Depending on provided files and settings, your results folder may contain the following data:</p>
<blockquote>
<div><ul class="simple">
<li><p>sub-aperture images (see <em>viewpoints_xxx</em> folder) and view animation given as gif</p></li>
<li><p>refocused images (see <em>refo_xxx</em> folder) and refocus animation given as gif</p></li>
<li><p>depth map given as pfm and ply file</p></li>
<li><p>raw image file given as tiff</p></li>
<li><p>aligned light field as pkl (pickle) file</p></li>
<li><p>light field metadata as json file (for Lytro files only)</p></li>
<li><p>scheimpflug focus files</p></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="api-usage">
<h3><span class="section-number">1.4.3. </span>API usage<a class="headerlink" href="#api-usage" title="Permalink to this headline">¶</a></h3>
<p>Usage of PlenoptiCam modules is demonstrated in the following Jupyter notebooks:</p>
<p><a class="reference external" href="https://github.com/hahnec/plenopticam/blob/master/examples/01_calib_demo.ipynb">1. Calibration Demo</a></p>
<p><a class="reference external" href="https://github.com/hahnec/plenopticam/blob/master/examples/02_align_demo.ipynb">2. Alignment Demo</a></p>
<p><a class="reference external" href="https://github.com/hahnec/plenopticam/blob/master/examples/03_xtract_demo.ipynb">3. Extraction Demo</a></p>
<p><a class="reference external" href="https://github.com/hahnec/plenopticam/blob/master/examples/04_illum_demo.ipynb">4. Lytro Illum Demo</a></p>
</div>
</div>
<div class="section" id="citation">
<h2><span class="section-number">1.5. </span>Citation<a class="headerlink" href="#citation" title="Permalink to this headline">¶</a></h2>
<div class="highlight-BibTeX notranslate"><div class="highlight"><pre><span></span><span class="nc">@ARTICLE</span><span class="p">{</span><span class="nl">plenopticam</span><span class="p">,</span>
<span class="na">author</span><span class="p">=</span><span class="s">{Hahne, Christopher and Aggoun, Amar}</span><span class="p">,</span>
<span class="na">journal</span><span class="p">=</span><span class="s">{IEEE Transactions on Image Processing}</span><span class="p">,</span>
<span class="na">title</span><span class="p">=</span><span class="s">{PlenoptiCam v1.0: A Light-Field Imaging Framework}</span><span class="p">,</span>
<span class="na">year</span><span class="p">=</span><span class="s">{2021}</span><span class="p">,</span>
<span class="na">volume</span><span class="p">=</span><span class="s">{30}</span><span class="p">,</span>
<span class="na">number</span><span class="p">=</span><span class="s">{}</span><span class="p">,</span>
<span class="na">pages</span><span class="p">=</span><span class="s">{6757-6771}</span><span class="p">,</span>
<span class="na">doi</span><span class="p">=</span><span class="s">{10.1109/TIP.2021.3095671}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="further-information">
<h2><span class="section-number">1.6. </span>Further information<a class="headerlink" href="#further-information" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p>check out PlenoptiCam’s partner project <a class="reference external" href="https://github.com/hahnec/plenoptisign/">PlenoptiSign</a> capable of estimating metric light field geometries</p></li>
<li><p>visit <a class="reference external" href="http://www.plenoptic.info">plenoptic.info</a> for technical details, animated figures and theoretical backgrounds</p></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">1. PlenoptiCam</a><ul>
<li><a class="reference internal" href="#description">1.1. Description</a></li>
<li><a class="reference internal" href="#results">1.2. Results</a><ul>
<li><a class="reference internal" href="#datesets">1.2.1. Datesets</a></li>
<li><a class="reference internal" href="#color-equalization">1.2.2. Color equalization</a></li>
<li><a class="reference internal" href="#depth">1.2.3. Depth</a></li>
</ul>
</li>
<li><a class="reference internal" href="#installation">1.3. Installation</a></li>
<li><a class="reference internal" href="#usage">1.4. Usage</a><ul>
<li><a class="reference internal" href="#application">1.4.1. Application</a></li>
<li><a class="reference internal" href="#command-line">1.4.2. Command Line</a></li>
<li><a class="reference internal" href="#api-usage">1.4.3. API usage</a></li>
</ul>
</li>
<li><a class="reference internal" href="#citation">1.5. Citation</a></li>
<li><a class="reference internal" href="#further-information">1.6. Further information</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">PlenoptiCam’s Reference Document</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="guide.html"
title="next chapter"><span class="section-number">2. </span>User Guide</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/readme.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="guide.html" title="2. User Guide"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="PlenoptiCam’s Reference Document"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">PlenoptiCam 0.9.1 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">1. </span>PlenoptiCam</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2020, Christopher Hahne.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
</div>
</body>
</html>