iOptimizerADMMLim.hh

Go to the documentation of this file.

#ifndef iOptimizerADMMLim_HH
#define iOptimizerADMMLim_HH 1

#include "gVariables.hh"
#include "sAddonManager.hh"
#include "vOptimizer.hh"
#include "iPenaltyMarkovRandomField.hh"

#define ADMMLIM_NOT_ADAPTIVE 0
#define ADMMLIM_ADAPTIVE_ALPHA 1
#define ADMMLIM_ADAPTIVE_ALPHA_AND_TAU 2
#define ADMMLIM_NOT_DEFINED -1

#define ADMMLIM_DO_NOT_SAVE_SINOGRAMS 0
#define ADMMLIM_SAVE_SINOGRAMS 1

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


  // -------------------------------------------------------------------
  // Public member functions
  public:
    // Function for automatic insertion (put the class name as the parameter and do not add semi-column at the end of the line)
    FUNCTION_OPTIMIZER(iOptimizerADMMLim)
    int ReadConfigurationFile(const string& a_configurationFile);
    int ReadOptionsList(const string& a_optionsList);
    
    virtual int DataStep4Optional( oProjectionLine* ap_Line, vEvent* ap_Event,
                                   int a_bed, int a_timeFrame, int a_respGate, int a_cardGate,
                                   int a_thread );
    virtual int DataStep5ComputeCorrections( oProjectionLine* ap_Line, vEvent* ap_Event,
                                             int a_bed, int a_timeFrame, int a_respGate, int a_cardGate,
                                             int a_thread );
    virtual int DataStep6Optional( oProjectionLine* ap_Line, vEvent* ap_Event,
                                   int a_bed, int a_timeFrame, int a_respGate, int a_cardGate,
                                   int a_thread );
  
  // -------------------------------------------------------------------
  // Private member functions (virtual in vOptimizer)
  private:
    virtual int PreDataUpdateSpecificStep();
    int PreImageUpdateSpecificStep();
    void ShowHelpSpecific();
    int CheckSpecificParameters();
    int InitializeSpecific();
    int SensitivitySpecificOperations( FLTNB a_data, FLTNB a_forwardModel, FLTNB* ap_weight,
                                       FLTNB a_multiplicativeCorrections, FLTNB a_additiveCorrections, FLTNB a_blankValue,
                                       FLTNB a_quantificationFactor, oProjectionLine* ap_Line );
    int DataSpaceSpecificOperations( FLTNB a_data, FLTNB a_forwardModel, FLTNB* ap_backwardValues,
                                     FLTNB a_multiplicativeCorrections, FLTNB a_additiveCorrections, FLTNB a_blankValue,
                                     FLTNB a_quantificationFactor, oProjectionLine* ap_Line);
    int ImageSpaceSpecificOperations( FLTNB a_currentImageValue, FLTNB* apImageValue,
                                      FLTNB a_sensitivity, FLTNB* ap_correctionValues,
                                      INTNB a_voxel, int a_tbf = -1, int a_rbf = -1, int a_cbf = -1 );
    virtual int ImageUpdateStep();

  // -------------------------------------------------------------------
  // Data members
  private:
    FLTNB**** m4p_firstDerivativePenaltyImage;     
    // Variables to compute u and v in DataStep6
    FLTNB** m2p_rBackgroundEvents;                 
    FLTNB** m2p_yData;                             
    // Variables involved in adaptive alpha and tau computation
    FLTNB m_alpha;                                 
    FLTNB m_previousAlpha;                         
    FLTNB m_tau;                                   
    FLTNB m_mu;                                    
    FLTNB m_tauMax;                                
    FLTNB m_xi;                                    
    // All stored vectors (those linked to gradient, sinograms u, v and Ax)
    FLTNB**** m4p_currentGrad;                     
    FLTNB**** m4p_currentGradFrameGates;           
    FLTNB** m2p_toWrite_uk;                        
    FLTNB** m2p_toWrite_vk;                        
    FLTNB** m2p_vectorAx;                          
    // Vector norms
    HPFLTNB* mp_gradSquareNorm;                    
    HPFLTNB* mp_projGradSquareNorm;                
    HPFLTNB* mp_penaltyGradSquareNorm;             
    FLTNB m_relativePrimalSquareNorm;              
    FLTNB m_relativeDualSquareNorm;                
    HPFLTNB* mp_primalSquareNorm;                  
    HPFLTNB* mp_squareNorm_Ax;                     
    HPFLTNB* mp_squareNorm_v;                      
    // General variables
    int m_adaptiveParameters;                      
    FLTNB m_stoppingCriterionValue;                
    int m_saveSinogramsUAndV;                      
    int m_criterionReachedIteration;               
    bool m_criterionReachedIsPassed;               
    int m_firstIteration;                          
    bool m_firstIterationIsPassed;                 
    bool u_and_v_from_user;                        
};


// Class for automatic insertion (set here the visible optimizer's name as the first parameter,
// put the class name as the second parameter and do NOT add semi-colon at the end of the line)
CLASS_OPTIMIZER(ADMMLim,iOptimizerADMMLim)

#endif