# Readme file for The Flutter Shutter Density Estimator. Basic use :

Use script_snapshot, script_test to reproduce the
examples presented in the paper. (It requires Gnuplot.)
It compiles and run the program with adequate
parameters.

./flutter_density_estimator input.txt output.txt flag_log_scale

# ABOUT

* Author  : This software was written by Yohann Tendero <tendero@math.ucla.edu>
* Licence   : GPL v3+, see GPLv3.txt


#TO REPRODUCE THE EXAMPLES OF THE PAPER
One can use one of the script 

./script_experiments

to reproduce the examples of the paper.

THE SCRIPT NEED GNUPLOT TO PROCUDE THE PLOTS.



# OVERVIEW

This source code provides in implementation of the algorithm described
in the paper "The Flutter Shutter Code Calculator" (IPOL).

* the executable file is flutter_density_estimator

This program reads and writes text files.

The files that contains the flutter shutter codes are
documented in list_references_for_code_files.

- Compilation.
Automated compilation requires the make program.



# COMPILATION
1. Download the code package and extract it. Go to that directory.

2. Compile the source code (on Unix/Linux/Mac OS).
Run make


# USAGE

flutter_density_estimator Input.txt Output.txt flag_log_scale`

* Input.txt: text file containing the flutter shutter code :
one coefficient per line no coma or semicolumn at the end of each line.
* Provided examples test:
snapshot.txt, agrawal1.txt, agrawal2.txt, mccloskey.txt.
* Output.txt: text file to store the estimated probability density \rho(v) for
which the flutter code is optimal. First column : v, second \rho(v).
* flag_log_scale 0 to store \rho(v) 1 to store log(1+\rho(v))

example : ./flutter_density_estimator snapshot.txt output_snapshot.txt 0


"VERSION
Sofware version 2.


# ABOUT THIS FILE

Copyright 2014 IPOL Image Processing On Line http://www.ipol.im/
Author: This software was written by Yohann Tendero <tendero@cmla.ens-cachan.fr>
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.  This file is offered as-is,
without any warranty.