oDeformationManager.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 ODEFORMATIONMANAGER_HH
#define ODEFORMATIONMANAGER_HH 1

#include "gVariables.hh"
#include "vDeformation.hh"
#include "vDataFile.hh"

// =====================================================================
// ---------------------------------------------------------------------
// ---------------------------------------------------------------------
// =====================================================================
#define DEF_RESP_MOT 0

#define DEF_CARD_MOT 1

#define DEF_IPAT_MOT 2

#define DEF_DUAL_MOT 3

class vDataFile;



class oDeformationManager
{
  // Constructor & Destructor
  public:
    oDeformationManager();
    
    ~oDeformationManager();


  // -------------------------------------------------------------------
  // Public member functions
  public:
    int CheckParameters();
    int Initialize();
    void InstantiateImageForDeformation(oImageSpace* ap_Image);
    void DeallocateImageForDeformation(oImageSpace* ap_Image);
    int InitImageForDeformation(oImageSpace* ap_Image);


  // -------------------------------------------------------------------
  // Public Get & Set functions
  public:
    inline void SetVerbose(int a_verboseLevel)
           {m_verbose = a_verboseLevel;}
    inline void SetDataMode(int a_dataMode)
           {m_dataMode = a_dataMode;}
    inline void SetImageDimensionsAndQuantification(oImageDimensionsAndQuantification* ap_ImageDimensionsAndQuantification) 
                                                   {mp_ID = ap_ImageDimensionsAndQuantification;}
    inline void SetOptions(const string& a_options) 
           {m_options = a_options;}
           
    inline void SetNbTransformations(int a_nbTransformations) 
           {m_nbTransformations = a_nbTransformations;}

    void SetMotionType(int a_motionType);
    
    inline bool UseDeformationResp()
           {return m_UseDeformationResp;}
    inline bool UseDeformationCard()
           {return m_UseDeformationCard;}
    inline bool UseDeformationInv()
           {return m_UseDeformationIPat;}
    inline int GetNbSensImagesRespDeformation(int a_value) 
           {if (UseDeformationResp()
            ||  UseDeformationInv() ) return 0;
            else                      return a_value;}
    inline int GetNbSensImagesCardDeformation(int a_value) 
           {if (UseDeformationCard()) return 0; else return a_value;}

    #ifdef CASTOR_OMP

    inline void SetDeformationRequirement(INTNB a_th)
           {mp_deformationRequirement[a_th] = true;}
    inline bool GetDeformationRequirement(INTNB a_th)
           {return mp_deformationRequirement[a_th];}
    bool AllThreadsRequireDeformation();
    void UnsetDeformationRequirements();
    #endif

  // -------------------------------------------------------------------
    // Deformation functions
    //int ApplyDeformationForSensitivityGeneration(oImageSpace* ap_Image, int a_defDirection, int fr, int rg, int cg);
    int ApplyDeformationForSensitivityGeneration(oImageSpace* ap_Image, int a_defDirection, int idx, int fr, int rg, int cg);
    int ApplyDeformationsToBackwardImage(oImageSpace* ap_Image);
    int PerformDeformation(oImageSpace* ap_Image);
    int TestDeformationOnImage(FLTNB* ap_inputImage, FLTNB* ap_outputImage, int a_direction, int a_defIdx);

  // -------------------------------------------------------------------
  // Private member functions
  private:
    int ParseOptionsAndInitializeDeformations();


  // -------------------------------------------------------------------
  // Data members
  private:
    // Image dimensions
    oImageDimensionsAndQuantification* mp_ID; 
    // Options for each deformation type
    string m_options;                     
    // Deformation objects and associated bool
    vDeformation* mp_Deformation;         
    bool m_UseDeformationResp;                
    bool m_UseDeformationCard;                
    bool m_UseDeformationIPat;                
    // Variable indicating the current gate/index of the motion
    int m_curMotIdx;                          
    // Number of gates for cyclic motion
    int m_nbTransformations;                  
    // Verbose level
    int m_verbose;                            
    // Data mode
    int m_dataMode;                           
    // Has been checked ?
    bool m_checked;                           
    // Has been initialized ?
    bool m_initialized;                       
    #ifdef CASTOR_OMP
    bool* mp_deformationRequirement;              
    #endif
};

#endif