oOptimizerManager.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 OOPTIMIZERMANAGER_HH
#define OOPTIMIZERMANAGER_HH 1

#include "gVariables.hh"
#include "vOptimizer.hh"
#include "vPenalty.hh"
#include "oImageSpace.hh"
#include "vDataFile.hh"

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


  // -------------------------------------------------------------------
  // Public member functions
  public:
    int CheckParameters();
    int Initialize();
    int PreDataUpdateStep();
    int PreImageUpdateStep();
    int DataUpdateStep( oProjectionLine* ap_Line, vEvent* ap_Event,
                        int a_bed, int a_timeFrame, int a_respGate, int a_cardGate,
                        int a_thread );
    int ImageUpdateStep();


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


  // -------------------------------------------------------------------
  // Public Get & Set functions
  public:
    inline void SetVerbose(int a_verboseLevel)
           {m_verbose = a_verboseLevel;}
    inline void SetOptionsOptimizer(const string& a_optionsOptimizer)
           {m_optionsOptimizer = a_optionsOptimizer;}
    inline void SetNumbersOfIterationsAndSubsets(int a_nbIterations, int* ap_nbSubsets)
           {mp_Optimizer->SetNumbersOfIterationsAndSubsets(a_nbIterations,ap_nbSubsets);}
    inline void SetCurrentIteration(int a_currentIteration)
           {mp_Optimizer->SetCurrentIteration(a_currentIteration);}
    inline void SetCurrentSubset(int a_currentSubset)
           {mp_Optimizer->SetCurrentSubset(a_currentSubset);}
    inline void SetOptionsPenalty(const string& a_optionsPenalty, FLTNB a_penaltyStrength)
           {m_optionsPenalty = a_optionsPenalty; m_penaltyStrength = a_penaltyStrength;}
    inline void SetImageDimensionsAndQuantification(oImageDimensionsAndQuantification* ap_ImageDimensionsAndQuantification)
           {mp_ImageDimensionsAndQuantification = ap_ImageDimensionsAndQuantification;}
    inline void SetImageSpace(oImageSpace* ap_ImageSpace)
           {mp_ImageSpace = ap_ImageSpace;}
    inline void SetNbTOFBins(int a_nbTOFBins)
           {m_nbTOFBins = a_nbTOFBins;}
    inline void SetDataMode(int a_dataMode)
           {m_dataMode = a_dataMode;}
    inline void SetDataType(int a_dataType)
           {m_dataType = a_dataType;}
    inline void SetDataSpec(int a_dataSpec)
           {m_dataSpec = a_dataSpec;}
    inline void SetOptimizerFOMFlag(bool a_optimizerFOMFlag)
           {m_optimizerFOMFlag = a_optimizerFOMFlag;}
    inline void SetOptimizerImageStatFlag(bool a_optimizerImageStatFlag)
           {m_optimizerImageStatFlag = a_optimizerImageStatFlag;}
    inline int GetNbBackwardImages()
           {return mp_Optimizer->GetNbBackwardImages();}
    inline FLTNB GetInitialValue()
           {return mp_Optimizer->GetInitialValue();}
    inline bool GetNeedGlobalSensitivity()
           {return mp_Optimizer->GetNeedGlobalSensitivity();}

    vOptimizer* GetOptimizer() {return mp_Optimizer;}
    
  // -------------------------------------------------------------------
  // Data members
  private:
    oImageDimensionsAndQuantification* 
      mp_ImageDimensionsAndQuantification; 
    oImageSpace* mp_ImageSpace;            
    int m_dataMode;                        
    int m_dataType;                        
    int m_dataSpec;                        
    int m_nbTOFBins;                       
    string m_optionsOptimizer;             
    string m_optionsPenalty;               
    FLTNB m_penaltyStrength;               
    bool m_optimizerFOMFlag;               
    bool m_optimizerImageStatFlag;         
    vOptimizer* mp_Optimizer;              
    vPenalty* mp_Penalty;                  
    int m_verbose;                         
};

#endif