From 00e87ee879d8a5ba0454992d22ece3852a3a21c3 Mon Sep 17 00:00:00 2001 From: hahnec Date: Sun, 4 Oct 2020 23:47:57 +0200 Subject: [PATCH] feat(ver): update docs --- docs/build/html/.buildinfo | 2 +- .../html/_static/documentation_options.js | 2 +- docs/build/html/genindex.html | 6 +++--- docs/build/html/guide.html | 6 +++--- docs/build/html/index.html | 6 +++--- docs/build/html/readme.html | 20 +++++++++---------- docs/build/html/search.html | 6 +++--- docs/build/html/searchindex.js | 2 +- 8 files changed, 24 insertions(+), 26 deletions(-) diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index 9222e15..334d7a7 100644 --- a/docs/build/html/.buildinfo +++ b/docs/build/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 1680b80925954530f56495e93ff9445b +config: 8b695858485b6f391813a3bdde6cc8a3 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js index 1be82db..977fc65 100644 --- a/docs/build/html/_static/documentation_options.js +++ b/docs/build/html/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '0.6.1', + VERSION: '0.6.2', LANGUAGE: 'None', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index ccc169f..538713f 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -5,7 +5,7 @@ - Index — PlenoptiCam 0.6.1 documentation + Index — PlenoptiCam 0.6.2 documentation @@ -22,7 +22,7 @@

Navigation

  • index
    • -
  • PlenoptiCam 0.6.1 documentation »
    • +
  • PlenoptiCam 0.6.2 documentation »
  • Index
    • @@ -66,7 +66,7 @@

    Navigation

  • index
    • -
  • PlenoptiCam 0.6.1 documentation »
    • +
  • PlenoptiCam 0.6.2 documentation »
  • Index
    • diff --git a/docs/build/html/guide.html b/docs/build/html/guide.html index 1177a71..cd9a55c 100644 --- a/docs/build/html/guide.html +++ b/docs/build/html/guide.html @@ -5,7 +5,7 @@ - 2. User Guide — PlenoptiCam 0.6.1 documentation + 2. User Guide — PlenoptiCam 0.6.2 documentation @@ -26,7 +26,7 @@

    Navigation

  • previous |
    • -
  • PlenoptiCam 0.6.1 documentation »
    • +
  • PlenoptiCam 0.6.2 documentation »
  • 2. User Guide
    • @@ -148,7 +148,7 @@

    Navigation

  • previous |
    • -
  • PlenoptiCam 0.6.1 documentation »
    • +
  • PlenoptiCam 0.6.2 documentation »
  • 2. User Guide
    • diff --git a/docs/build/html/index.html b/docs/build/html/index.html index 555bc5f..595eace 100644 --- a/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -5,7 +5,7 @@ - PlenoptiCam’s Reference Document — PlenoptiCam 0.6.1 documentation + PlenoptiCam’s Reference Document — PlenoptiCam 0.6.2 documentation @@ -26,7 +26,7 @@

    Navigation

  • next |
    • -
  • PlenoptiCam 0.6.1 documentation »
    • +
  • PlenoptiCam 0.6.2 documentation »
  • PlenoptiCam’s Reference Document
    • @@ -97,7 +97,7 @@

    Navigation

  • next |
    • -
  • PlenoptiCam 0.6.1 documentation »
    • +
  • PlenoptiCam 0.6.2 documentation »
  • PlenoptiCam’s Reference Document
    • diff --git a/docs/build/html/readme.html b/docs/build/html/readme.html index ecaaaec..2ac5661 100644 --- a/docs/build/html/readme.html +++ b/docs/build/html/readme.html @@ -5,7 +5,7 @@ - 1. PlenoptiCam — PlenoptiCam 0.6.1 documentation + 1. PlenoptiCam — PlenoptiCam 0.6.2 documentation @@ -30,7 +30,7 @@

    Navigation

  • previous |
    • -
  • PlenoptiCam 0.6.1 documentation »
    • +
  • PlenoptiCam 0.6.2 documentation »
  • 1. PlenoptiCam
    • @@ -44,11 +44,11 @@

    Navigation

    1. PlenoptiCam

    1.1. Description

    -

    PlenoptiCam is an open-source software (macOS, Win or Linux) for scientific light field computation with cross-platform compatibility, few dependencies and a lean graphical user interface. +

    PlenoptiCam is an open-source software (macOS, Win or Linux) 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.

    release License travis coverage Release Downloads PyPI Downloads

    -

    binder

    +

    binder

    1.2. Results

    @@ -71,8 +71,8 @@

    1.2.1. Datesets

    Custom-built (png, jpg, bmp files)

    Lytro Illum (lfp, lfr, tar files)

    -

    binder

    -

    colab

    +

    binder

    +

    colab

    @@ -127,7 +127,7 @@

    1.3. Installation
  • executable:
      -

    1. download bundled apps for macOS, Win or Linux

      2. +

    2. download bundled apps for macOS, Win or Linux

    3. extract archive

    4. run executable (may take a while on first start-up)

    5. user interface will show up (see below)

      6. @@ -200,7 +200,6 @@

      1.4.1. ApplicationChoose your light field photograph using upper Browse button. Supported file types are:

      • bmp, jpg or png file from custom-built plenoptic camera

      • lfr, lfp and raw files from Lytro Illum

        • -

      • Lytro 1st Generation (to come)

    @@ -215,7 +214,6 @@

    1.4.1. Application

    bmp, jpg or png file from custom-built plenoptic camera

  • caldata-XXX.tar archive or respective raw file from Lytro Illum

  • tick “Pick folder” and point to a directory containing all tar files or extracted folders (calibration file will be found automatically)

    • -

  • Lytro 1st Generation (to come)

    • @@ -223,7 +221,7 @@

    1.4.1. Application

    Note

    -

    If you are using your own Lytro Illum camera, you first need to extract camera calibration data as a tar archive. To do so, please follow the instructions guide.

    +

    If you are using your own Lytro Illum camera, you first need to extract camera calibration data as a tar-archive. To do so, please follow the instructions guide.


    @@ -392,7 +390,7 @@

    Navigation

  • previous |
    • -
  • PlenoptiCam 0.6.1 documentation »
    • +
  • PlenoptiCam 0.6.2 documentation »
  • 1. PlenoptiCam
    • diff --git a/docs/build/html/search.html b/docs/build/html/search.html index ce36c13..9a22b52 100644 --- a/docs/build/html/search.html +++ b/docs/build/html/search.html @@ -5,7 +5,7 @@ - Search — PlenoptiCam 0.6.1 documentation + Search — PlenoptiCam 0.6.2 documentation @@ -27,7 +27,7 @@

    Navigation

  • index
    • -
  • PlenoptiCam 0.6.1 documentation »
    • +
  • PlenoptiCam 0.6.2 documentation »
  • Search

    • @@ -75,7 +75,7 @@

    Navigation

  • index
    • -
  • PlenoptiCam 0.6.1 documentation »
    • +
  • PlenoptiCam 0.6.2 documentation »
  • Search
    • diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 6e068d0..5b150e5 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["guide","index","readme"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,"sphinx.ext.todo":2,sphinx:56},filenames:["guide.rst","index.rst","readme.rst"],objects:{},objnames:{},objtypes:{},terms:{"1st":2,"case":2,"default":[0,2],"int":2,"while":2,For:2,Its:2,One:0,Using:1,Vis:2,abil:2,acquir:0,address:2,adjust:2,after:2,align:2,all:2,anim:2,apertur:2,app:[0,2],appli:0,appropri:2,archiv:[0,2],argument:2,automat:[0,2],b5144000xxx:2,background:2,balanc:[0,2],baselin:2,bedfordshir:[],befor:2,beginn:2,below:2,bibtex:2,bmp:2,brows:[0,2],built:2,bundl:2,button:[0,2],caldata:2,cali:2,calibr:[0,2],call:2,camera:[0,2],can:2,capabl:2,captur:[],card:0,channel:0,check:[0,2],checkbox:2,choos:2,christoph:2,cite:2,clone:2,cloud:2,com:2,come:2,comp:2,compat:2,compris:2,comput:2,configur:2,contain:2,content:0,conveni:2,copi:0,correspond:2,credit:1,crop:0,cross:2,custom:2,data:[0,2],dataset:2,decod:2,depend:2,depth:[],descript:[0,1],desir:0,detail:2,detect:0,develop:2,dimension:[0,2],directori:2,distanc:2,don:2,done:2,download:2,downward:0,enabl:0,enter:2,entir:0,equival:2,estim:2,execut:2,experi:2,exposur:2,extract:2,few:2,fiddler:2,field:[0,2],figur:2,file:[0,2],filenam:0,find:2,finish:2,first:2,focu:[0,2],focus:2,folder:[0,2],follow:[0,2],forc:[0,2],format:2,found:2,four:2,fp7:2,from:[0,2],gener:[0,2],geometri:[0,2],get:0,gif:2,git:2,github:2,given:2,grant:2,graphic:2,guid:[1,2],hahn:2,hahnec:2,help:2,horizont:0,http:2,ict:2,illum:[1,2],imag:[0,2],imit:0,impact:0,info:2,inria:2,insid:2,instal:1,institut:2,instruct:2,interfac:2,irac:2,iter:2,its:2,jpg:2,json:2,just:0,keep:0,lean:2,lfp:2,lfr:[0,2],light:[0,2],like:[0,2],limit:2,linux:2,load:2,locat:2,lower:2,lytro:[1,2],maco:2,mai:2,map:2,maximum:[0,2],meant:2,menu:0,metadata:[0,2],metric:2,micro:[0,2],mimic:2,more:2,name:2,necessari:2,need:2,normal:0,note:0,off:0,onc:[0,2],onli:2,open:2,opex:2,opticsexpress:2,option:2,order:[0,2],org:2,origin:0,other:2,out:2,output:0,overrid:0,own:[1,2],packag:2,pair:0,paramet:[0,2],parent:0,partner:2,patch:[0,2],path:[0,2],pfm:2,photograph:2,pick:[0,2],pickl:2,pip:2,pixel:[0,2],pkl:2,platform:2,pleas:2,plenopt:[0,2],plenopticam:0,plenoptisign:2,plm:[],ply:2,png:2,point:[0,2],precis:[0,2],press:[0,2],privileg:2,process:[0,2],project:2,properti:0,provid:[0,2],python3:2,python:2,ran:2,rang:2,raw:2,readi:0,redo:0,reduc:0,refin:[0,2],refo_xxx:2,refocu:[0,2],refocus:[0,2],remov:0,requir:2,research:2,respect:2,result:1,root:2,run:2,same:2,scheimpflug:[0,2],scientif:2,scope:2,see:[0,2],select:0,sensor:[0,2],set:[1,2],setup:2,shift:2,show:2,size:[0,2],skew:0,smoothli:2,softwar:2,sourc:[0,2],specif:0,stack:2,standard:2,start:[0,2],step:0,store:0,sub:[0,2],sudo:2,sum:2,support:2,synthesi:2,synthet:2,system:2,take:2,taken:2,tar:[0,2],target:2,technic:2,technolog:2,them:2,theoret:2,thi:2,through:2,thu:2,tick:2,tiff:2,tilt:[0,2],transfer:0,triangul:2,txt:2,type:2,under:2,univ:[],unix:2,upper:2,upward:0,usag:1,use:0,useful:2,user:[1,2],using:[0,2],vari:0,vertic:0,via:[0,2],view:2,viewpoints_xxx:2,visit:2,where:0,whether:0,which:2,white:[0,2],who:2,win:2,window:2,work:2,would:2,write:2,www:2,xxx:[0,2],you:[0,2],your:[1,2]},titles:["2. User Guide","PlenoptiCam\u2019s Reference Document","1. PlenoptiCam"],titleterms:{Using:0,applic:2,camera:[],citat:2,color:2,command:2,contributor:2,credit:2,data:[],dateset:2,depth:2,descript:2,document:1,equal:2,further:2,guid:0,illum:0,inform:2,input:[],instal:2,line:2,lytro:0,output:[],own:0,plenopticam:[1,2],refer:1,result:2,set:0,sponsor:2,type:[],usag:2,user:0,your:0}}) \ No newline at end of file +Search.setIndex({docnames:["guide","index","readme"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,"sphinx.ext.todo":2,sphinx:56},filenames:["guide.rst","index.rst","readme.rst"],objects:{},objnames:{},objtypes:{},terms:{"1st":[],"case":2,"default":[0,2],"int":2,"while":2,For:2,Its:2,One:0,Using:1,Vis:2,abil:2,acquir:0,address:2,adjust:2,after:2,align:2,all:2,anim:2,apertur:2,app:[0,2],appli:0,appropri:2,archiv:[0,2],argument:2,automat:[0,2],b5144000xxx:2,background:2,balanc:[0,2],baselin:2,bedfordshir:[],befor:2,beginn:2,below:2,bibtex:2,bmp:2,brows:[0,2],built:2,bundl:2,button:[0,2],caldata:2,cali:2,calibr:[0,2],call:2,camera:[0,2],can:2,capabl:2,captur:[],card:0,channel:0,check:[0,2],checkbox:2,choos:2,christoph:2,cite:2,clone:2,cloud:2,com:2,come:[],comp:2,compat:2,compris:2,comput:2,configur:2,contain:2,content:0,conveni:2,copi:0,correspond:2,credit:1,crop:0,cross:2,custom:2,data:[0,2],dataset:2,decod:2,depend:2,depth:[],descript:[0,1],desir:0,detail:2,detect:0,develop:2,dimension:[0,2],directori:2,distanc:2,don:2,done:2,download:2,downward:0,enabl:0,enter:2,entir:0,equival:2,estim:2,execut:2,experi:2,exposur:2,extract:2,few:2,fiddler:2,field:[0,2],figur:2,file:[0,2],filenam:0,find:2,finish:2,first:2,focu:[0,2],focus:2,folder:[0,2],follow:[0,2],forc:[0,2],format:2,found:2,four:2,fp7:2,from:[0,2],gener:0,geometri:[0,2],get:0,gif:2,git:2,github:2,given:2,grant:2,graphic:2,guid:[1,2],hahn:2,hahnec:2,help:2,horizont:0,http:2,ict:2,illum:[1,2],imag:[0,2],imit:0,impact:0,info:2,inria:2,insid:2,instal:1,institut:2,instruct:2,interfac:2,irac:2,iter:2,its:2,jpg:2,json:2,just:0,keep:0,lean:2,lfp:2,lfr:[0,2],light:[0,2],like:[0,2],limit:2,linux:2,load:2,locat:2,lower:2,lytro:[1,2],maco:2,mai:2,map:2,maximum:[0,2],meant:2,menu:0,metadata:[0,2],metric:2,micro:[0,2],mimic:2,more:2,name:2,necessari:2,need:2,normal:0,note:0,off:0,onc:[0,2],onli:2,open:2,opex:2,opticsexpress:2,option:2,order:[0,2],org:2,origin:0,other:2,out:2,output:0,overrid:0,own:[1,2],packag:2,pair:0,paramet:[0,2],parent:0,partner:2,patch:[0,2],path:[0,2],pfm:2,photograph:2,pick:[0,2],pickl:2,pip:2,pixel:[0,2],pkl:2,platform:2,pleas:2,plenopt:[0,2],plenopticam:0,plenoptisign:2,plm:[],ply:2,png:2,point:[0,2],precis:[0,2],press:[0,2],privileg:2,process:[0,2],project:2,properti:0,provid:[0,2],python3:2,python:2,ran:2,rang:2,raw:2,readi:0,redo:0,reduc:0,refin:[0,2],refo_xxx:2,refocu:[0,2],refocus:[0,2],remov:0,requir:2,research:2,respect:2,result:1,root:2,run:2,same:2,scheimpflug:[0,2],scientif:2,scope:2,see:[0,2],select:0,sensor:[0,2],set:[1,2],setup:2,shift:2,show:2,size:[0,2],skew:0,smoothli:2,softwar:2,sourc:[0,2],specif:0,stack:2,standard:2,start:[0,2],step:0,store:0,sub:[0,2],sudo:2,sum:2,support:2,synthesi:2,synthet:2,system:2,take:2,taken:2,tar:[0,2],target:2,technic:2,technolog:2,them:2,theoret:2,thi:2,through:2,thu:2,tick:2,tiff:2,tilt:[0,2],transfer:0,triangul:2,txt:2,type:2,under:2,univ:[],unix:2,upper:2,upward:0,usag:1,use:0,useful:2,user:[1,2],using:[0,2],vari:0,vertic:0,via:[0,2],view:2,viewpoints_xxx:2,visit:2,where:0,whether:0,which:2,white:[0,2],who:2,win:2,window:2,work:2,would:2,write:2,www:2,xxx:[0,2],you:[0,2],your:[1,2]},titles:["2. User Guide","PlenoptiCam\u2019s Reference Document","1. PlenoptiCam"],titleterms:{Using:0,applic:2,camera:[],citat:2,color:2,command:2,contributor:2,credit:2,data:[],dateset:2,depth:2,descript:2,document:1,equal:2,further:2,guid:0,illum:0,inform:2,input:[],instal:2,line:2,lytro:0,output:[],own:0,plenopticam:[1,2],refer:1,result:2,set:0,sponsor:2,type:[],usag:2,user:0,your:0}}) \ No newline at end of file