NAME
        stratus.exe

SYNOPSIS 

        ./stratus.exe --version;
        ./stratus.exe --help;
        ./stratus.exe [--alpha ALPHA] [--opt-theta THETA] --im-pfx-map IM(1)… IM(n)\
	--im-sift S(1)… S(n);

DESCRIPTION
        This software is an algorithm dedicated to the vibility estimation of a
        satellite time series. Given a gray level time series it provides,
        Boolean times series indicating the visibily (mainly the opaque clouds,
        haze and shadow). To increase the estimate quality it is recommended to
        sub-pixel register first the time series.

MANDATORY
        --im-pfx-map IM(1)… IM(n)
              The output file names.
			 
        --im-sift S(1)… S(n)
              An input time series. It should represents a gray level time
              series.  This series will be used to compute the opaque cloud time
              series.
			  
OPTIONS
        --alpha ALPHA
              SIFT distance threshold. Default value is set to 0.2, takes values
              in [0, +1].
			  
        --opt-theta THETA
              Threshold, in pixels, used to remove the surface outliers. Default
              value is set to 300. It takes values in [0, +oo].

        --version
              display the program version
			  
        --help
              display the help

		
EXAMPLES
        ./stratus.exe --im-pfx-map im1.tif im2.tif…  --im-sift test_data/* \
         --opt-alpha 0.2;
              General syntax.
			  
        ./stratus.exe \
        --im-pfx-map $(mkdir output_data && pfx=$(ls test_data/*) && \
        echo ${pfx//test_data/output_data}) --im-sift test_data/* \
         --opt-alpha 0.2;
              Specific to the Linux bash syntax.
			  
REFERENCES
        Reference to the IPOL article :

        This algorithm was designed for the publication entitled :
        «Visibility detector for time series of spectrally limited satellite
        imagers.»
		
COPYRIGHT PATENT AND LICENSE INFORMATION
        THIS program is written by Tristan Dagobert. All the files
        are distributed under the terms of CeCILL-C License, except
        for the following contributions :

        - abstract_dsf.c, abstract_dsf.h, ccproc.c, ccproc.h :
          Enric Meinhardt-Llopis.
          These files are distributed under the terms of the GNU Affero General
          Public License.
          WARNING ! Some code, useless for the current purpose, was removed
          from the original code.
  
        - lib_description.c, lib_discrete.c, lib_keypoint.c lib_matching.c,
          lib_scalespace.c, lib_sift.c, lib_sift_anatomy.c, lib_util.c,
          lib_description.h, lib_discrete.h, lib_keypoint.h, lib_matching.h,
          lib_scalespace.h, lib_sift.h, lib_sift_anatomy.h, lib_util.h,
          linalg.c, linalg.h :
          Ives Rey-Otero.
          These files are distributed redistribute it under the terms of
          the simplified BSD License.
          WARNING ! Two updates were added to the original code of the file
          lib_sift.c to fix memory leaks. 
		  
        - iio.c, iio.h by :
          Enric Meinhardt-Llopis, Gabriele Facciolo, Carlo de Franchis,
          Juan Cardelino.
          These files are distributed under the terms of the GNU Affero General
          Public License.

AUTHORS
        Tristan Dagobert    <tristan.dagobert@cmla.ens-cachan.fr>,
                            <tdagobert@hotmail.com>

VERSION
        2020/05/05      1.0

        Location of future releases and updates : http://www.ipol.im

CHANGES
        In the program since it was first published in IPOL. No changes.

CONFIGURATION 
        Libraries required to compile and use the program.

        This software requires :
        - PNG, TIF, JPEG libraries

        Compilation instructions

        Before compiling, please check the Makefile in order to program the
        right paths for external libraries. 

        To compile, type :
        make exe [MYDEBUG=1];

        This will produce the executable : stratus.exe

		To test with a small series, type :
		make test;

		To clean, type :
		make clean;
NOTES
        The input and output images should be of all types supported by the iio
        library.