/*
 #
 #  File        : itkSTMS_ArgumentsAnalysis.h
 #                ( C++ header file - STMS )
 #
 #  Description : STMS lib that implements the STMS filter and clustering.
 #                This file is a part of the STMS Library project.
 #                ( https://www.creatis.insa-lyon.fr/site7/fr/realisations )
 #
 #  [1] S. Mure, Grenier, T., Meier, S., Guttmann, R. G., et Benoit-Cattin, H.,
 #       « Unsupervised spatio-temporal filtering of image sequences. A mean-shift specification »,
 #       Pattern Recognition Letters, vol. 68, Part 1, p. 48 - 55, 2015.
 #
 #  Copyright   : Thomas GRENIER - Simon MURE
 #                ( https://www.creatis.insa-lyon.fr/~grenier/ )
 #
 #  License     : CeCILL C
 #                ( http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.txt )
 #
 #  This software is governed by the CeCILL  license under French law and
 #  abiding by the rules of distribution of free software.  You can  use,
 #  modify and/ or redistribute the software under the terms of the CeCILL
 #  license as circulated by CEA, CNRS and INRIA at the following URL
 #  "http://www.cecill.info".
 #
 #  As a counterpart to the access to the source code and  rights to copy,
 #  modify and redistribute granted by the license, users are provided only
 #  with a limited warranty  and the software's author,  the holder of the
 #  economic rights,  and the successive licensors  have only  limited
 #  liability.
 #
 #  In this respect, the user's attention is drawn to the risks associated
 #  with loading,  using,  modifying and/or developing or reproducing the
 #  software by the user in light of its specific status of free software,
 #  that may mean  that it is complicated to manipulate,  and  that  also
 #  therefore means  that it is reserved for developers  and  experienced
 #  professionals having in-depth computer knowledge. Users are therefore
 #  encouraged to load and test the software's suitability as regards their
 #  requirements in conditions enabling the security of their systems and/or
 #  data to be ensured and,  more generally, to use and operate it in the
 #  same conditions as regards security.
 #
 #  The fact that you are presently reading this means that you have had
 #  knowledge of the CeCILL license and that you accept its terms.
 #
*/
/* Please don't forget to cite our work :
  @article {MURE-15a,
    title = {Unsupervised spatio-temporal filtering of image sequences. A mean-shift specification},
    journal = {Pattern Recognition Letters},
    volume = {68, Part 1},
    year = {2015},
    pages = {48 - 55},
    issn = {0167-8655},
    doi = {http://dx.doi.org/10.1016/j.patrec.2015.07.021},
    url = {http://www.sciencedirect.com/science/article/pii/S0167865515002305},
    author = {S. Mure and T Grenier and Meier, S. and Guttmann, R.G. and H. Benoit-Cattin}
}
*/

#ifndef itkSTMS_ArgumentsAnalysis_H
#define itkSTMS_ArgumentsAnalysis_H

#include <getopt.h>
#include <string>

namespace itkSTMS
{
    static struct option long_options[] =
    {
        {"expDescription", required_argument, 0, 'd'},
        {"imageDimension", required_argument, 0, 'i'},
        {"numTimePoints",  required_argument, 0, 'n'},
        {"startTimePoint", required_argument, 0, 's'},
        {"xScale",         required_argument, 0, 'x'},
        {"yScale",         required_argument, 0, 'y'},
        {"zScale",         required_argument, 0, 'z'},
        {"rScale",         required_argument, 0, 'r'},
        {"epsilon",        required_argument, 0, 'e'},
        {"maxIt",          required_argument, 0, 'm'},
        {"merge",          no_argument      , 0, 'g'},
        {"help",           no_argument      , 0, 'h'},
        {0, 0, 0, 0}
    };

    struct ParamsAnalysisOutputType
    {
        std::string  expDescription;
        float        spScales[3];
        float        rScale;
        float        epsilon;
        unsigned int maxIt;
        unsigned int dim;
        unsigned int numTimePoints;
        unsigned int startTimePoint;
        bool         merge;
        std::string help;
        bool        isOk;
    };


    class itkSTMS_ArgumentsAnalysis{

    public:
        itkSTMS_ArgumentsAnalysis(int argc, char **argv);
        void Update();
        void ParametersDisplay();
        void ParametersAnalysisInfo();
        void CheckProvidedParameters();
        inline ParamsAnalysisOutputType* GetSTMSParams(){ return &readParams; }

    private:
        ParamsAnalysisOutputType readParams;
        int    argc;
        char **argv;

    };
} // end of namespace itkSTMS

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkSTMS_ArgumentsAnalysis.hxx"
#endif

#endif // itkSTMS_ArgumentsAnalysis_H