oIterativeAlgorithm.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 OITERATIVEALGORITHM_HH
#define OITERATIVEALGORITHM_HH 1

#include "gVariables.hh"
#include "oImageDimensionsAndQuantification.hh"
#include "oProjectorManager.hh"
#include "oImageConvolverManager.hh"
#include "oImageProcessingManager.hh"
#include "oOptimizerManager.hh"
#include "oDeformationManager.hh"
#include "oDynamicModelManager.hh"
#include "oImageSpace.hh"
#include "vDataFile.hh"
#include "sChronoManager.hh"



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



  // -------------------------------------------------------------------
  // Public member functions
  public:
    int Iterate();
    int IterateCPU();
    #ifdef CASTOR_GPU

    int IterateGPU();
    #endif

    inline void SetSaveSensitivityHistoFlag(bool a_saveSensitivityHistoFlag) {m_saveSensitivityHistoFlag = a_saveSensitivityHistoFlag;}
    inline void SetSaveSubsetImageFlag(bool a_saveImageAfterSubsets) {m_saveImageAfterSubsets = a_saveImageAfterSubsets;}
    inline void SetOptimizerManager(oOptimizerManager* ap_OptimizerManager) {mp_OptimizerManager = ap_OptimizerManager;}
    inline void SetImageDimensionsAndQuantification(oImageDimensionsAndQuantification* ap_ImageDimensionsAndQuantification) {mp_ID = ap_ImageDimensionsAndQuantification;};
    inline void SetImageSpace(oImageSpace* ap_ImageSpace) {mp_ImageSpace = ap_ImageSpace;};
    inline void SetProjectorManager(oProjectorManager* ap_ProjectorManager) {mp_ProjectorManager = ap_ProjectorManager;};
    inline void SetImageConvolverManager(oImageConvolverManager* ap_ImageConvolverManager) {mp_ImageConvolverManager = ap_ImageConvolverManager;}
    inline void SetImageProcessingManager(oImageProcessingManager* ap_ImageProcessingManager) {mp_ImageProcessingManager = ap_ImageProcessingManager;}
    inline void SetDynamicModelManager(oDynamicModelManager* ap_DynamicModelManager) {mp_DynamicModelManager = ap_DynamicModelManager;}
    inline void SetDeformationManager(oDeformationManager* ap_DeformationManager) {mp_DeformationManager = ap_DeformationManager;}
    inline void SetDataFile(vDataFile** a2p_DataFile) {m2p_DataFile = a2p_DataFile;};
    inline void SetGPUflag(bool a_flagGPU) {m_flagGPU = a_flagGPU;};
    inline void SetVerbose(int a_verboseLevel) {m_verbose = a_verboseLevel;};
    inline void SetNbBeds(int a_nbBeds) {m_nbBeds = a_nbBeds;};
    inline void SetPathInitImage(string a_pathToInitialImage) {m_pathToInitialImg = a_pathToInitialImage;};
    inline void SetPathToAttenuationImage(string a_pathToAttenuationImage) {m_pathToAtnImg = a_pathToAttenuationImage;};
    inline void SetPathToSensitivityImage(string a_pathToSensitivityImage) {m_pathToSensitivityImg = a_pathToSensitivityImage;};
    inline void SetPathToMultiModalImage(vector<string> a_pathToMultiModalImage) {m_pathToMultiModalImg = a_pathToMultiModalImage;};
    inline void SetPathToMaskImage(string a_pathToMaskImage) {m_pathToMaskImg = a_pathToMaskImage;};
    int SetNbIterationsAndSubsets(const string& a_nbIterationsSubsets);
    int SetOutputIterations(const string& a_outputIterations);
    virtual int InitSpecificOptions(string a_specificOptions);



  // -------------------------------------------------------------------
  // Protected member functions
  protected:
    virtual int StepBeforeIterationLoop();
    virtual int StepAfterIterationLoop();
    virtual int StepBeforeSubsetLoop(int a_iteration);
    virtual int StepAfterSubsetLoop(int a_iteration);
    virtual int StepPreProcessInsideSubsetLoop(int a_iteration, int a_subset);
    virtual int StepPostProcessInsideSubsetLoop(int a_iteration, int a_subset);
    virtual int StepInnerLoopInsideSubsetLoop(int a_iteration, int a_subset, int a_bed);



  // -------------------------------------------------------------------
  // ----- Functions related to OpenMP barrier -----
    void ThreadBarrierIncrement();
    bool ThreadBarrierFlag();
    bool ThreadBarrierCheck();
    void ThreadBarrierSetOff();
    void ThreadBarrierSetOn();



  // -------------------------------------------------------------------
  // Data members
  protected:
    int m_nbIterations;                                 
    int* mp_nbSubsets;                                  
    bool* mp_outputIterations;                          
    int m_verbose;                                      
    bool m_flagGPU;                                     
    oImageDimensionsAndQuantification* mp_ID;           
    vDataFile** m2p_DataFile;                           
    oProjectorManager* mp_ProjectorManager;             
    oOptimizerManager* mp_OptimizerManager;             
    oDeformationManager* mp_DeformationManager;         
    oDynamicModelManager* mp_DynamicModelManager;       
    oImageSpace* mp_ImageSpace;                         
    oImageConvolverManager* mp_ImageConvolverManager;   
    oImageProcessingManager* mp_ImageProcessingManager; 
    int m_nbBeds;                                       
    string m_pathToInitialImg;                          
    string m_pathToAtnImg;                              
    string m_pathToSensitivityImg;                      
    vector<string> m_pathToMultiModalImg;               
    string m_pathToMaskImg;                             
    bool m_saveSensitivityHistoFlag;                    
    bool m_saveImageAfterSubsets;                       
    bool m_generalizedImplementation;                   
};

#endif