vImageProcessingModule.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 VIMAGEPROCESSINGMODULE_HH
#define VIMAGEPROCESSINGMODULE_HH 1

#include "gVariables.hh"
#include "oImageDimensionsAndQuantification.hh"
#include "oImageSpace.hh"

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

  // -----------------------------------------------------------------------------------------
  // Public member functions
  public:
    int CheckParameters();
    int Initialize();


  // -----------------------------------------------------------------------------------------
  // Pure virtual public member functions that need to be implemented by children
  public:
    virtual int ReadConfigurationFile(const string& a_configurationFile) = 0;
    virtual int ReadOptionsList(const string& a_optionsList) = 0;
    virtual void ShowHelp() = 0;
    virtual int Process(FLTNB**** a4p_image) = 0;


  // -----------------------------------------------------------------------------------------
  // Pure virtual private member functions that need to be implemented by children
  private:
    virtual int CheckSpecificParameters() = 0;
    virtual int InitializeSpecific() = 0;


  // -----------------------------------------------------------------------------------------
  // Public Get & Set functions
  public:
    inline void SetVerbose(int a_verbose)
           {m_verbose = a_verbose;}
    inline void SetImageDimensionsAndQuantification(oImageDimensionsAndQuantification* ap_ImageDimensionsAndQuantification)
           {mp_ImageDimensionsAndQuantification = ap_ImageDimensionsAndQuantification;}
    inline bool GetAffectTimeDimensionFlag()
           {return m_affectTimeDimensionFlag;}
    inline bool GetAffectRespDimensionFlag()
           {return m_affectRespDimensionFlag;}
    inline bool GetAffectCardDimensionFlag()
           {return m_affectCardDimensionFlag;}


  // -----------------------------------------------------------------------------------------
  // Data members
  protected:
    oImageDimensionsAndQuantification* 
      mp_ImageDimensionsAndQuantification;  
    bool m_affectTimeDimensionFlag;         
    bool m_affectRespDimensionFlag;         
    bool m_affectCardDimensionFlag;         
    bool m_checked;                         
    bool m_initialized;                     
    int m_verbose;                          
};


// ----------------------------------------------------------------------
// Part of code that manages the auto declaration of children classes
// ----------------------------------------------------------------------

// Macro for the function that creates the object
#define FUNCTION_IMAGE_PROCESSING_MODULE(CLASS) \
  static vImageProcessingModule *make_image_processing_module() { return new CLASS(); };

// Macro for the class that links the appropriate function to the map of objects
#define CLASS_IMAGE_PROCESSING_MODULE(NAME,CLASS)                                                                       \
  class NAME##ImageProcessingModuleCreator                                                                              \
  {                                                                                                                     \
    public:                                                                                                             \
      NAME##ImageProcessingModuleCreator()                                                                              \
        { sAddonManager::GetInstance()->mp_listOfImageProcessingModules[#NAME] = CLASS::make_image_processing_module; } \
  };                                                                                                                    \
  static NAME##ImageProcessingModuleCreator ImageProcessingModuleCreator##NAME;

#endif