ISET

From VISTA LAB WIKI

(Difference between revisions)
Jump to: navigation, search
(Replaced content with "Image Systems Evaluation Toolbox ISET is a set of Matlab utilities we use to simulate the complete digital imaging pipeline. ISET requires the Matlab Image Processsin...")
 
Line 1: Line 1:
Image Systems Evaluation Toolbox [[ISET]] is a set of Matlab utilities we use to simulate the complete digital imaging pipeline. [[ISET]] requires the Matlab Image Processsing Toolbox.  Relevant papers and an overview of the software, including video tutorials, are at the [http://imageval.com  ImageVal website].
Image Systems Evaluation Toolbox [[ISET]] is a set of Matlab utilities we use to simulate the complete digital imaging pipeline. [[ISET]] requires the Matlab Image Processsing Toolbox.  Relevant papers and an overview of the software, including video tutorials, are at the [http://imageval.com  ImageVal website].
-
 
-
I also keep a manual of the [http://white.stanford.edu/manuals/ISET/ISET/index.html ISET functions] locally.  The software is used routinely in teaching and research at Stanford.
 
-
 
-
[[Main_Page | Vistalab Main Page ]]
 
-
 
-
= Documentation =
 
-
 
-
There is general purpose documentation about [[ISET]].  Most of the documentation is stored on the ImageVal website.
 
-
 
-
* [http://www.imageval.com/public/Products/ISET/Manual/PDF/ISET_Manual.pdf Users Guide]
 
-
* [http://white.stanford.edu/manuals/ISET/ISET/index.html ISET Functions]
 
-
* [http://www.imageval.com/public/Products/ISET/Videos/VideoTours.htm Video Tours]
 
-
* [http://www.imageval.com/public/Products/ISET/ApplicationNotes/ApplicationNotes.htm Application Notes]
 
-
* [http://www.imageval.com/public/Papers/DigitalCameraSimulation_092908.pdf Engineering paper describing ISET]
 
-
 
-
For highly specific documentation about the ongoing developments, we have created an [[ISET Documentation]] page.  There isn't much there yet.  Our plan, however, is to move a lot of the material that is in our SPIE course presentations into that page.  We are just waiting for the time to get it done.
 
-
 
-
= Download  =
 
-
 
-
= Browse the repository =
 
-
 
-
= Installation =
 
-
 
-
= Create a new online manual =
 
-
 
-
= Create a Demo distribution =
 
-
 
-
* The demo version contains only p-files and a few m-file scripts.  We describe how to create the demo version here.
 
-
 
-
* Start the version of Matlab for which you wish to create a demo version. 
 
-
* Make sure the ISET you plan to distribute is the one on your path.
 
-
** change to the ISET directory you plan to distribute
 
-
** type isetPath(pwd) to make this directory your ISET root directory
 
-
** startDir = pwd
 
-
** change to iset-admin
 
-
** run addpath(genpath(pwd)) 
 
-
 
-
* To replace the *.m files that are in ISET-Demo-4.### with *.p files
 
-
** chdir(startDir)
 
-
Type "iePFile(startDir)"; 
 
-
 
-
* We are no longer using SVN - the instructions below are obsolete
 
-
** Export the ISET SVN directory into a new folder. You can do this on a PC by right-clicking and dragging the SVN directory to, say, your desktop. Select the option "SVN Export Versioned Items Here".
 
-
** after creating the pfiles ...
 
-
** Rename the exported ISET directory to be ISET-Demo-4.### where ### is the SVN repository update number.
 
-
 
-
= [[ISET plans | ISET To-do list]] =
 
-
 
-
There is a long list of [[ISET plans]] for new [[ISET]] capabilities; these are getting done slowly over time.
 
-
 
-
There are also elements of the TODO list included in the [[ISET plans]] page.
 
-
 
-
= ISET odds and ends =
 
-
 
-
This material will be moved elsewhere over time.
 
-
 
-
== ZEMAX and ISET ==
 
-
 
-
Read the message at [http://www.zemax.com/kb/articles/31/1/How-to-Install-ZEMAX-for-the-First-Time/Page1.html How to Install Zemax for the First Time].  That page says
 
-
 
-
* When installing ZEMAX on a computer for the first time, you will need to download two files from the Downloads page of our (Zemax) website.
 
-
* The two files that you will need are the [http://www.zemax.com/downloads/ZEMAX_2008-11-10.exe ZEMAX program we paid for] and the [http://www.zemax.com/downloads/Sentinel_Protection_Installer_7.5.0.exe Sentinel key driver].
 
-
 
-
Two important points (we believe).
 
-
 
-
<ol>
 
-
<li>  '''You will have to run the Sentinel key driver BEFORE you install Zemax.'''
 
-
<li>  '''Do not insert the dongle into the USB slot until you have installed Sentinel and Zemax.'''
 
-
</ol>
 
-
 
-
Note: We only have the dongle for an older version of Zemax (November, 2008). We scrolled to the bottom of the page and selected the [http://www.zemax.com/downloads/ZEMAX_2008-11-10.exe 10 November 2008 release] because we only had the dongle for that version. We don't know if later versions work with ISET because we don't have access to these versions.  If you do, let us know
 
-
 
-
After the downloads, further instructions for installing Sentinel Key Driver and then Zemax (on their First Time page) are clear.
 
-
 
-
== Set a lens title ==
 
-
To set the Title of a Zemax lens file  use: 'System | General TAB Title/Notes'
 
-
 
-
== PSF calculation ==
 
-
 
-
FPS is the FFT PSF calculation (Used in Macro.  Fast.  Produces sample size errors.)
 
-
 
-
HPS is the Huygens PSF calculation (slower, more accurate, doesn't have same sampling errors)
 
-
 
-
== Running the ISET-ZEMAX Macro ==
 
-
 
-
To create a set of Zemax data to import for Ray Trace analysis
 
-
 
-
* Get a Zemax lens file
 
-
* Run the ISET_RT_ZEMAX macro
 
-
 
-
To run the macro on your computer, you will need to copy the ISET macro file (ISET_RT_ZEMAX.ZPL) from ISET:
 
-
 
-
fullfile(isetRootPath,'modules','raytrace')
 
-
 
-
to the Macros directory in ZEMAX, say
 
-
 
-
C:\Program Files\ZEMAX\Macros
 
-
 
-
= Coding tips =
 
-
 
-
== Text box colors across platforms ==
 
-
 
-
To keep text box colors the same as the default background use:
 
-
 
-
See [http://www.mathworks.com/access/helpdesk/help/techdoc/index.html?/access/helpdesk/help/techdoc/creating_guis/f15-1012439.html&http://www.google.com/search?rlz=1C1GGLS_en-USUS295US304&sourceid=chrome&ie=UTF-8&q=matlab+background+colors+in+gui Cross-Platform Compatibility]
 
-
 
-
<code>
 
-
defaultBackground = get(0,'defaultUicontrolBackgroundColor'); <br>
 
-
set(figurehandle,'Color',defaultBackground)
 
-
</code>
 
-
 
-
== Platform Dependent Compilation ==
 
-
 
-
First time users sometimes need help with
 
-
 
-
<ol>
 
-
<li> mex files for their platform
 
-
<li> p-file compatibility with their Matlab release
 
-
</ol>
 
-
 
-
Some useful ways to help them are described here.
 
-
 
-
== MEX files ==
 
-
 
-
[[ISET]] relies on two mex-files, md5 and ieGetMACAddress.  These are no longer compatible across platforms.  Because there are so many different platforms, it is difficult to keep up and make sure that a mex file is included in every platform.  One way to verify these two commands is to use the [[ISET]] command '''ieInstall'''.  This will test and verify the mex-file installation.
 
-
 
-
When mex-files fail, they produce a clear error.  We have two commands to help make sure the mex-files are working and the proper type for your architecture.
 
-
 
-
First, it is important to have the Visual Studio C++ libraries on your PC.  There is a Matlab command to install them, and there is an ISET command that invokes the Matlab command.  To do this
 
-
 
-
<ul>
 
-
<li> Run ieVCRedistribution
 
-
<ul>
 
-
 
-
This command will install the Visual Studio C++ libraries.  Try running the broken mex command.  If that works, you should be done.
 
-
 
-
There may also be some platforms that we have not yet compiled a mex-file.
 
-
 
-
<li> fList{1} = 'md5'; ieCompileMex(fList)
 
-
<li> fList{1} = 'ieGetMACAddress'; ieCompileMex(fList)
 
-
<li> This is a program that allows people to compile on their platform.
 
-
<li> If this works, then request the compiled mex files so that we can include them in the next distribution of ISET.
 
-
</ul>
 
-
</ul>
 
-
 
-
== Archived demo distributions ==
 
-
 
-
While [[ISET]] is mainly open source, there are a few key files that we keep hidden because of the need to keep the licensing methods secure.  We use p-files to hide the code in these files.
 
-
 
-
P-files created with Matlab '''thisVer''' often are not compatible with versions of Matlab less than '''thisVer'''.  This means that we need to create [[ISET]] for different versions of Matlab. 
 
-
Thus far, we have put the following versions on our website
 
-
 
-
<ul>
 
-
<li> ISET-3.0-DemoR2007a.zip
 
-
<ul>
 
-
<li>
 
-
http://www.imageval.com/public/Products/ISET/download/DemoVersions/ISET-3.0-DemoR2007a.zip
 
-
password to unzip is 7143694
 
-
</ul>
 
-
<li> ISET-3.0-DemoR2007b.zip
 
-
<ul>
 
-
<li>
 
-
http://www.imageval.com/public/Products/ISET/download/DemoVersions/ISET-3.0-DemoR2007b.zip
 
-
password to unzip is 7143694
 
-
</ul>
 
-
<li> ISET-3.0-DemoR14.zip
 
-
<ul>
 
-
<li>
 
-
http://www.imageval.com/public/Products/ISET/download/DemoVersions/ISET-3.0-DemoR14.zip
 
-
password to unzip is 71436940
 
-
</ul>
 
-
<li> ISET-3.0Demo.zip (should run on Matlab 2008)
 
-
<ul>
 
-
<li>
 
-
http://www.imageval.com/public/Products/ISET/download/DemoVersions/ISET-3.0Demo.zip
 
-
there is no password
 
-
</ul>
 
-
 
-
== Archived distributions ==
 
-
 
-
<ul>
 
-
Matlab 2007a
 
-
<ul>
 
-
<li> http://www.imageval.com/public/Products/ISET/download/ISET_Versions/iset-4.0-Matlab2007a-Rev386.zip
 
-
password to unzip is 32548130
 
-
</ul>
 
-
</ul>
 
-
<ul>
 
-
Matlab 2008a
 
-
<ul>
 
-
<li> http://www.imageval.com/public/Products/ISET/download/ISET_Versions/iset-4.682.zip
 
-
password to unzip is 32548130
 
-
</ul>
 
-
</ul>
 
-
 
-
= Matlab Version Bugs =
 
-
 
-
<ul>
 
-
<li> Matlab2007a
 
-
<ul> <li> Matlab2007a has a bug that caused us to create a unique vcReadImage.m for this version only:     
 
-
In their documentation of try-catch they write: "Due to a bug in the R2007a release, the warning for a catch followed immediately by a single term is thrown as an error, even though the text of the message says that it is a warning. "
 
-
<ul>
 
-
<li>
 
-
We get around this by placing a % sign in front of %ME as in
 
-
<ul>
 
-
<li>  try
 
-
<li>  irradianceE = Quanta2Energy(wave,irradianceP);
 
-
<li>    % Do the calculation.
 
-
<li>  img = RGB2XWFormat(irradianceE);
 
-
<li>    illuminance = (683*binWidth)*img*V;
 
-
<li>    illuminance = XW2RGBFormat(illuminance,sz(1),sz(2));
 
-
<li> catch %ME
 
-
</ul>
 
-
<li>
 
-
 
-
We have experienced cases in which the web() function in Matlab does not open properly with the url, as documented.  This happened in Matlab 2007a using FireFox as a default browser.  To help with those problem cases we return the url the customer should use.  The customer can then copy and paste the url into their browser manually.
 
-
</ul>
 

Latest revision as of 20:39, 22 April 2016

Image Systems Evaluation Toolbox ISET is a set of Matlab utilities we use to simulate the complete digital imaging pipeline. ISET requires the Matlab Image Processsing Toolbox. Relevant papers and an overview of the software, including video tutorials, are at the ImageVal website.

Personal tools