Skip to content

Commit

Permalink
docs(readme): update readme and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@hahnec
hahnec committed Sep 13, 2020
1 parent ab5f6fe commit 2e59178
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 21 deletions.
12 changes: 6 additions & 6 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ This application is meant for researchers, developers, beginners and other fiddl
Results
=======

Camera input
------------
Datesets
--------

.. list-table::
:widths: 8 8
Expand Down Expand Up @@ -99,7 +99,7 @@ Application
.. |gui| raw:: html

<p align="center">
<img src="https://raw.githubusercontent.com/hahnec/plenopticam/develop/docs/img/gui_linux.png" width="66%">
<img src="https://raw.githubusercontent.com/hahnec/plenopticam/master/docs/img/gui_linux.png" width="66%">
<p>

.. note::
Expand Down Expand Up @@ -241,18 +241,18 @@ Further information
:alt: PyPI Downloads

.. |binder| image:: https://img.shields.io/badge/launch-jupyter%20lab-579aca.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
:target: https://mybinder.org/v2/gh/hahnec/plenopticam/develop?urlpath=lab
:target: https://mybinder.org/v2/gh/hahnec/plenopticam/master?urlpath=lab

.. |colab| image:: https://colab.research.google.com/assets/colab-badge.svg?style=flat-square
:target: https://colab.research.google.com/github/hahnec/plenopticam/blob/master/examples/04_illum_demo.ipynb

.. |depth_anim| raw:: html

<img src="https://raw.githubusercontent.com/hahnec/plenopticam/develop/docs/img/depth_anim.gif">
<img src="https://raw.githubusercontent.com/hahnec/plenopticam/master/docs/img/depth_anim.gif">

.. |depth_demo| raw:: html

<img src="https://raw.githubusercontent.com/hahnec/plenopticam/develop/docs/img/depth_demo_lores.png" max-width:"100%">
<img src="https://raw.githubusercontent.com/hahnec/plenopticam/master/docs/img/depth_demo_lores.png" max-width:"100%">

.. |pflug_demo| raw:: html

Expand Down
45 changes: 31 additions & 14 deletions docs/build/html/readme.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,16 @@ <h3>Navigation</h3>
<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.6.0-beta/plenopticam_0.6.0.dmg">macOS</a>, <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.6.0-beta/plenopticam_0.6.0.msi">Win</a> or <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.6.0-beta/plenopticam_0.6.0.tar.gz">Linux</a>) for scientific light field computation with cross-platform compatibility, few dependencies and a lean graphical user interface.
<p><em>PlenoptiCam</em> is an open-source software (<a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.6.1-beta/plenopticam_0.6.1.dmg">macOS</a>, <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.6.1-beta/plenopticam_0.6.1.msi">Win</a> or <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.6.1-beta/plenopticam_0.6.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&amp;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&amp;style=flat-square" /></a></p>
<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-jupyter%20lab-579aca.svg?style=flat-square&amp;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" /></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="camera-input">
<h3><span class="section-number">1.2.1. </span>Camera input<a class="headerlink" href="#camera-input" title="Permalink to this headline"></a></h3>
<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%" />
Expand All @@ -77,13 +77,8 @@ <h3><span class="section-number">1.2.1. </span>Camera input<a class="headerlink"
</tbody>
</table>
</div>
<div class="section" id="depth">
<h3><span class="section-number">1.2.2. </span>Depth<a class="headerlink" href="#depth" title="Permalink to this headline"></a></h3>
<p><img src="https://raw.githubusercontent.com/hahnec/plenopticam/develop/docs/img/depth_anim.gif"></p>
<p>pfm or ply files</p>
</div>
<div class="section" id="color-equalization">
<h3><span class="section-number">1.2.3. </span>Color equalization<a class="headerlink" href="#color-equalization" title="Permalink to this headline"></a></h3>
<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%" />
Expand All @@ -104,13 +99,35 @@ <h3><span class="section-number">1.2.3. </span>Color equalization<a class="heade
</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.6.0-beta/plenopticam_0.6.0.dmg">macOS</a>, <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.6.0-beta/plenopticam_0.6.0.msi">Win</a> or <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.6.0-beta/plenopticam_0.6.0.tar.gz">Linux</a></p></li>
<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.6.1-beta/plenopticam_0.6.1.dmg">macOS</a>, <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.6.1-beta/plenopticam_0.6.1.msi">Win</a> or <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.6.1-beta/plenopticam_0.6.1.tar.gz">Linux</a></p></li>
<li><p>extract archive</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>
Expand Down Expand Up @@ -155,7 +172,7 @@ <h2><span class="section-number">1.4. </span>Usage<a class="headerlink" href="#u
<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/develop/docs/img/gui_linux.png" width="66%">
<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>
Expand Down Expand Up @@ -314,9 +331,9 @@ <h3><a href="index.html">Table of Contents</a></h3>
<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="#camera-input">1.2.1. Camera input</a></li>
<li><a class="reference internal" href="#depth">1.2.2. Depth</a></li>
<li><a class="reference internal" href="#color-equalization">1.2.3. Color equalization</a></li>
<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>
Expand Down
Loading

0 comments on commit 2e59178

Please sign in to comment.