code/include/optimizer/iOptimizerTemplate.hh

Go to the documentation of this file.

#ifndef IOPTIMIZERTEMPLATE_HH
#define IOPTIMIZERTEMPLATE_HH 1

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

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


  // -----------------------------------------------------------------------------------------
  // 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(iOptimizerTemplate)
    int ReadConfigurationFile(const string& a_configurationFile);
    int ReadOptionsList(const string& a_optionsList);

  // -------------------------------------------------------------------
  // Private member functions (virtual in vOptimizer)
  private:
  
    int PreImageUpdateSpecificStep();

  // -----------------------------------------------------------------------------------------
  // Private member functions (pure virtual in vOptimizer)
  private:
    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* ap_newImageValue,
                                      FLTNB a_sensitivity, FLTNB* ap_correctionValues,
                                      INTNB a_voxel, int a_tbf = -1, int a_rbf = -1, int a_cbf = -1 );


  // -----------------------------------------------------------------------------------------
  // Data members
  private:

};


// 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(template,iOptimizerTemplate)

#endif