vImageConvolver.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-2019 all CASToR contributors listed below:

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

This is CASToR version 3.0.
*/

#ifndef VIMAGECONVOLVER_HH
#define VIMAGECONVOLVER_HH 1

#include "gVariables.hh"
#include "gOptions.hh"

class oImageSpace;
class oImageDimensionsAndQuantification;

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


  // -----------------------------------------------------------------------------------------
  // Public member functions
  public:
    int CheckParameters();
    int Initialize();
    int ApplyConvolution(FLTNB* ap_image);
    int ApplyConvolutionTranspose(FLTNB* ap_image);


  // -----------------------------------------------------------------------------------------
  // Private member functions
  private:
    void CopyToPaddedImage(FLTNB* ap_inputImage);
    virtual int Convolve(FLTNB* ap_outputImage);
    virtual int ConvolveTranspose(FLTNB* ap_outputImage);


  // -----------------------------------------------------------------------------------------
  // Pure virtual public member functions that need to be implemented by children
  public:
    virtual int ReadConfigurationFile(const string& a_fileOptions) = 0;
    virtual int ReadOptionsList(const string& a_listOptions) = 0;
    virtual void ShowHelp() = 0;


  // -----------------------------------------------------------------------------------------
  // Pure virtual private member functions that need to be implemented by children
  private:
    virtual int CheckSpecificParameters() = 0;
    virtual int BuildConvolutionKernel() = 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;}

  // -----------------------------------------------------------------------------------------
  // Data members
  protected:
    // Standards
    oImageDimensionsAndQuantification* 
      mp_ImageDimensionsAndQuantification; 
    int m_verbose;                         
    // Booleans
    bool m_checked;        
    bool m_initialized;    
    bool m_stationary;     
    // Padded image
    FLTNB* mp_paddedImage; 
    INTNB m_offsetX;       
    INTNB m_offsetY;       
    INTNB m_offsetZ;       
    INTNB m_dimPadX;       
    INTNB m_dimPadY;       
    INTNB m_dimPadZ;       
    INTNB m_dimPadXY;      
    INTNB m_dimPadXYZ;     
    // Convolution kernel
    INTNB m_nbKernels;     
    INTNB* mp_dimKernelX;  
    INTNB* mp_dimKernelY;  
    INTNB* mp_dimKernelZ;  
    FLTNB** m2p_kernel;    
};


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

// Macro for the function that creates the object
#define FUNCTION_IMAGE_CONVOLVER(CLASS) \
  static vImageConvolver *make_image_convolver() { return new CLASS(); };

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

#endif