vDeformation.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 VDEFORMATION_HH
#define VDEFORMATION_HH 1

#include "gVariables.hh"

// These definitions are used to simply discriminate between forward and backward deformation
#define FORWARD_DEFORMATION  0
#define BACKWARD_DEFORMATION 1

class oImageSpace;
class oImageDimensionsAndQuantification;

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


  // -----------------------------------------------------------------------------------------
  // Public member functions
  public:
    inline void SetImageDimensionsAndQuantification( oImageDimensionsAndQuantification* ap_ImageDimensionsAndQuantification )
           {mp_ID = ap_ImageDimensionsAndQuantification;}
    inline void SetVerbose( int a_verbose )
           {m_verbose = a_verbose;}
    inline void SetNbTransformations( int a_nbTransformations )
           {m_nbTransformations = a_nbTransformations;}
    virtual int CheckParameters();
    virtual int CheckSpecificParameters() = 0;
    virtual int ReadAndCheckConfigurationFile( const string& a_fileOptions ) = 0;
    virtual int ReadAndCheckOptionsList( const string& a_listOptions ) = 0;
    virtual int Initialize() = 0;
    virtual void ShowHelp() = 0;


  // -----------------------------------------------------------------------------------------
  // Reconstruction deformation function
  public:
    virtual int PerformDeformation( oImageSpace* ap_Image, int a_defIdx, int a_fr, int a_rimg, int a_cimg );

    
    virtual int PerformHistoSensitivityDeformation( oImageSpace* ap_Image, int a_defIdx, int fr, int rimg, int cimg );
    virtual int ApplyDeformationsToBackwardImage( oImageSpace* ap_Image, int a_fr, int a_defIdx );
    virtual int ApplyDeformationsToHistoSensitivityImage( oImageSpace* ap_Image, int a_fr, int a_defIdx );
    virtual int PerformSensitivityDeformation( oImageSpace* ap_Image, int a_defDirection, int a_defIdx, int fr, int rg, int cg );
    virtual int ApplyDeformations( FLTNB* ap_inputImage, FLTNB* ap_outputImage, int a_direction, int a_defIdx ) = 0;
    
    
    /*
      \fn Tlerp
      \param ap_inputImage : input image matrix 
      \param ap_outputImage : output image matrix
      \param iov : index of the voxel to interpolate in the output image
      \param iiv : index of the input image central voxel for interpolation
      \param dx : x-axis difference between output voxel cartesian position after transformation and center of estimated vox position
      \param dy : y-axis difference between output voxel cartesian position after transformation and center of estimated vox position
      \param dz : z-axis difference between output voxel cartesian position after transformation and center of estimated vox position
      \brief This function performs a trilinear interpolation for a specific voxel
      \todo : perhaps use padded image in order to avoid if statements
      \return 0 if success, other value otherwise.
    */
    int Tlerp(HPFLTNB *ap_inputImage, HPFLTNB *ap_outputImage, uint32_t iov, uint32_t iiv, FLTNB dX, FLTNB dY, FLTNB dZ);
    
    
    
    
  // -----------------------------------------------------------------------------------------
  // Data members
  protected:
    oImageDimensionsAndQuantification* mp_ID; 
    int m_verbose;                            
    int m_nbTransformations;                  
    int m_checked;                            
    int m_initialized;                        
};


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

// Macro for the function that creates the object
#define FUNCTION_DEFORMATION(CLASS) \
  static vDeformation *make_deformation() { return new CLASS(); };

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

#endif