iImageProcessingTemplate.hh

Go to the documentation of this file.

/*
This file is part of CASToR.

    CASToR is free software: you can redistribute it and/or modify it under the
    terms of the GNU General Public License as published by the Free Software
    Foundation, either version 3 of the License, or (at your option) any later
    version.

    CASToR is distributed in the hope that it will be useful, but WITHOUT ANY
    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
    details.

    You should have received a copy of the GNU General Public License along with
    CASToR (in file GNU_GPL.TXT). If not, see <http://www.gnu.org/licenses/>.

Copyright 2017-2018 all CASToR contributors listed below:

    --> current contributors: Thibaut MERLIN, Simon STUTE, Didier BENOIT, Claude COMTAT, Marina FILIPOVIC, Mael MILLARDET
    --> past contributors: Valentin VIELZEUF

This is CASToR version 2.0.
*/

#ifndef IIMAGEPROCESSINGTEMPLATE_HH
#define IIMAGEPROCESSINGTEMPLATE_HH 1

#include "gVariables.hh"
#include "gOptions.hh"
#include "oImageSpace.hh"
#include "vImageProcessingModule.hh"
#include "sAddonManager.hh"

class iImageProcessingTemplate : public vImageProcessingModule
{
  // -----------------------------------------------------------------------------------------
  // Constructor & Destructor
  public:
    iImageProcessingTemplate();
    ~iImageProcessingTemplate();


  // -----------------------------------------------------------------------------------------
  // Public member functions
  public:
    // Function for automatic insertion (put the class name as the parameter and do NOT add semi-colon at the end of the line)
    FUNCTION_IMAGE_PROCESSING_MODULE(iImageProcessingTemplate)
    int ReadConfigurationFile(const string& a_configurationFile);
    int ReadOptionsList(const string& a_optionsList);
    void ShowHelp();
    int Process(FLTNB**** a4p_image);


  // -----------------------------------------------------------------------------------------
  // Private member functions
  private:
    int CheckSpecificParameters();
    int InitializeSpecific();


  // -----------------------------------------------------------------------------------------
  // Data members
  protected:
    // Declare here any members useful for this specific module
};


// Class for automatic insertion (set here the visible image processing module's name as the first parameter,
// put the class name as the second parameter and do NOT add semi-colon at the end of the line)
CLASS_IMAGE_PROCESSING_MODULE(template,iImageProcessingTemplate)

#endif