OFISH - Optical Flow with Iso-Spherical Harmonics
Version 1.0, 2014

Lukas Lang (lukas.lang@univie.ac.at)
Computational Science Center, University of Vienna, Austria. http://www.csc.univie.ac.at/

1. Introduction

This is a MATLAB implementation of Optical Flow with Iso-Spherical Harmonics (OFISH) as described in:

L. F. Lang and O. Scherzer. Optical Flow on Evolving Sphere-Like Surfaces,
Inverse Probl. Imaging, 2017.

If you use this software in your work you must cite the abovementioned paper in any resulting publication!


  author     = {Lang, L.~F. and Scherzer, O.},
  title      = {Optical Flow on Evolving Sphere-Like Surfaces},
  journal    = {Inverse Probl. Imaging},
  fjournal   = {Inverse Problems and Imaging},
  year       = {2017}

Preprint available at https://arxiv.org/abs/1506.03358

This software package requires parts of

C. Kirisits, L. F. Lang and O. Scherzer. Decomposition of optical flow on 
the sphere, GEM. Int. J. Geomath., 5(1):117-141, April, 2014

Available at http://dx.doi.org/10.1007/s13137-013-0055-8
Preprint available at https://arxiv.org/abs/1312.4354

2. License & Disclaimer

Copyright 2014 Lukas Lang.

This file is part of OFISH. OFISH is free software: you can redistribute it 
and/or modify it under the terms of the GNU General Public License as 
published by the Free Software Foundation, either version 3 of the License, 
or (at your option) any later version.

OFISH is distributed in the hope that it will be useful, but WITHOUT ANY 
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along 
with OFISH.  If not, see <http://www.gnu.org/licenses/>.

For the full license statement see the file COPYING.

Moreover, this work incorporates source code from the color wheel by 
Deqing Sun, Department of Computer Science, Brown University. The license 
statement can be found in the respective files.

3. Requirements

This software was originally written for and tested with Matlab R2012b.
It has been recently modified to run with R2015a.

Note that this software uses the TriRep class which since R2013a is marked 
as 'will be removed in a future release'. It also used flipdim, which will 
be removed at some point in the future.

See http://www.mathworks.de/de/help/matlab/release-notes.html

The following libraries are required for parts of this sofware:

export_fig: used for producing high quality figures from the results.
URL: http://www.mathworks.com/matlabcentral/fileexchange/23629-exportfig

It requires the code of OFD (Decomposition of Optical Flow on the Sphere).
Download/check it out from https://bitbucket.org/lukaslang/ofd

4. Usage

For easier use we provide a startup script (startup.m), which sets up the 
Matlab search path. It includes required libraries and adds required 
subdirectories. Make sure to download the required packages and to set the 
library paths properly. Then simply run the startup script.

To run the test cases execute

>> runtests('./test')

The following run scripts are included:

- runofish.m (computes the optical flow on evolving sphere-like surfaces)
- runandrenderofish.m (additionally renders and saves the plots)

If you want to reproduce the experiments from the paper run

- experiments/prepare.m (creates and stores the linear system)
- experiments/runofishexperiments.m (runs the experiments)
- experiments/renderofishexperiments.m (renders and saves the plots)

5. Acknowledgements

This package includes the color wheel from http://vision.middlebury.edu/flow/
By courtesy of Deqing Sun, Department of Computer Science, Brown University.

We thank Pia Aanstad from the University of Innsbruck for kindly providing 
the microscopy data.