Lib/PrePostProcessing/itkSTMS_XMLFileParser.h

   1 /*
   2  #
   3  #  File        : itkSTMS_XMLFileParser.h
   4  #                ( C++ header file - STMS )
   5  #
   6  #  Description : STMS lib that implements the STMS filter and clustering.
   7  #                This file is a part of the STMS Library project.
   8  #                ( https://www.creatis.insa-lyon.fr/site7/fr/realisations )
   9  #
  10  #  [1] S. Mure, Grenier, T., Meier, S., Guttmann, R. G., et Benoit-Cattin, H.,
  11  #       « Unsupervised spatio-temporal filtering of image sequences. A mean-shift specification »,
  12  #       Pattern Recognition Letters, vol. 68, Part 1, p. 48 - 55, 2015.
  13  #
  14  #  Copyright   : Thomas GRENIER - Simon MURE
  15  #                ( https://www.creatis.insa-lyon.fr/~grenier/ )
  16  #
  17  #  License     : CeCILL C
  18  #                ( http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.txt )
  19  #
  20  #  This software is governed by the CeCILL  license under French law and
  21  #  abiding by the rules of distribution of free software.  You can  use,
  22  #  modify and/ or redistribute the software under the terms of the CeCILL
  23  #  license as circulated by CEA, CNRS and INRIA at the following URL
  24  #  "http://www.cecill.info".
  25  #
  26  #  As a counterpart to the access to the source code and  rights to copy,
  27  #  modify and redistribute granted by the license, users are provided only
  28  #  with a limited warranty  and the software's author,  the holder of the
  29  #  economic rights,  and the successive licensors  have only  limited
  30  #  liability.
  31  #
  32  #  In this respect, the user's attention is drawn to the risks associated
  33  #  with loading,  using,  modifying and/or developing or reproducing the
  34  #  software by the user in light of its specific status of free software,
  35  #  that may mean  that it is complicated to manipulate,  and  that  also
  36  #  therefore means  that it is reserved for developers  and  experienced
  37  #  professionals having in-depth computer knowledge. Users are therefore
  38  #  encouraged to load and test the software's suitability as regards their
  39  #  requirements in conditions enabling the security of their systems and/or
  40  #  data to be ensured and,  more generally, to use and operate it in the
  41  #  same conditions as regards security.
  42  #
  43  #  The fact that you are presently reading this means that you have had
  44  #  knowledge of the CeCILL license and that you accept its terms.
  45  #
  46 */
  47 /* Please don't forget to cite our work :
  48   @article {MURE-15a,
  49     title = {Unsupervised spatio-temporal filtering of image sequences. A mean-shift specification},
  50     journal = {Pattern Recognition Letters},
  51     volume = {68, Part 1},
  52     year = {2015},
  53     pages = {48 - 55},
  54     issn = {0167-8655},
  55     doi = {http://dx.doi.org/10.1016/j.patrec.2015.07.021},
  56     url = {http://www.sciencedirect.com/science/article/pii/S0167865515002305},
  57     author = {S. Mure and T Grenier and Meier, S. and Guttmann, R.G. and H. Benoit-Cattin}
  58 }
  59 */
  60 #ifndef itkSTMS_XMLFileParser_H
  61 #define itkSTMS_XMLFileParser_H
  62
  63 #include <string>
  64 #include "itkDOMNodeXMLReader.h"
  65 #include "itkFancyString.h"
  66
  67 namespace itkSTMS
  68 {
  69     struct ParserOutputType{
  70         std::string  experimentPath;
  71         std::string  imageExtension;
  72         std::string  outputImageExtension;
  73         std::string  outputClassExtension;
  74         std::string  inputCommonRoot;
  75         std::string  inputFolder;
  76         std::string  maskImage;
  77         std::string  outputFolder;
  78         std::string  outputCommonRoot;
  79         std::string  outputCSV;
  80     };
  81
  82
  83     class itkSTMS_XMLFileParser{
  84     public:
  85         typedef itk::DOMNodeXMLReader          InputType;
  86         typedef typename InputType::Pointer    InputPointer;
  87         typedef typename itk::DOMNode::Pointer NodePointer;
  88
  89         itkSTMS_XMLFileParser();
  90         void Update();
  91
  92         inline void SetFileName(std::string fileName){ this->fileName = fileName; }
  93         inline std::string GetFileName(){ return( this->fileName ); }
  94         inline ParserOutputType* GetXMLParams(){ return( &xmlParams ); }
  95
  96     private:
  97         ParserOutputType xmlParams;
  98         InputPointer     parser;
  99         std::string      fileName;
 100         NodePointer      DomObject, listInput, listOutput;
 101     };
 102 } // end of namespace itkSTMS
 103
 104 #ifndef ITK_MANUAL_INSTANTIATION
 105 #include "itkSTMS_XMLFileParser.hxx"
 106 #endif
 107
 108 #endif // itkSTMS_XMLFileParser_H