README.md


# Julia codes for “Predictive online optimisation with applications to optical flow”

This version of Julia codes contains the experiments in the manuscript _"Prediction Techniques for Dynamic Imaging with Online Primal-dual Methods"_ built on top of the experiments for the manuscript _“Predictive online optimisation with applications to optical flow”_ by [Tuomo Valkonen](https://tuomov.iki.fi) ([Journal of Mathematical Imaging and Vision](https://link.springer.com/article/10.1007/s10851-020-01000-4)).

## Prerequisites

These codes were written for Julia 1.3. The Julia package prequisites are from November 2019 when our experiments were run, and have not been updated to maintain the same environment we used to do the experiments in the manuscript. You may get Julia from [julialang.org](https://julialang.org/). 

## Usage

Navigate your unix shell to the directory containing this `README.md` and then run:

    $ julia --project=.

The first time doing this, to ensure all the dependencies are installed, run

    $ ]instantiate

Afterwards in the Julia shell, type:

    > using PredictPDPS

This may take a while as Julia precompiles the code. Then, to generate all the experiments in the manuscript _“Predictive online optimisation with applications to optical flow”_, run:

    > batchrun_article()

To see the experiments running visually, and not save the results, run 

    > demo_known1()

or any of `demo_XY()`, where `X`=`known`,`unknown` and `Y`=1,2,3.    

Additionally, to generate all the experiments in the manuscript _"Prediction Techniques for Dynamic Imaging with Online Primal-dual Methods"_, run:

    > batchrun_predictors()

Both will save the results under `img/`.

To see the experiments running visually, and not save the results, run 

    > demo_denoising1()

or

    > demo_pet1()

or any of `demo_denoisingZ()` for image stabilisation experiments and `demo_petZ()` for dynamic PET reconstruction where `Z=1` for Dual Scaling, `Z=2` for Greedy, `Z=3` for No Prediction, `Z=4` for Primal Only, `Z=5` for Proximal, and `Z=6` for Rotation predictors.

See the source code for more details details.

To run the data generation multi-threadeadly parallel to the algorithm, set the `JULIA_NUM_THREADS` environment variable to a number larger than one.