Optimiser.h

// ====================================================================================================   
//                                                                                                        
//   SuPReMo: Surrogate Parameterised Respiratory Motion Model                                            
//            An implementation of the generalised motion modelling and image registration framework      
//                                                                                                        
//   Copyright (c) University College London (UCL). All rights reserved.                                  
//                                                                                                        
//   This software is distributed WITHOUT ANY WARRANTY; without even                                      
//   the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR                                  
//   PURPOSE.                                                                                             
//                                                                                                        
//   See LICENSE.txt in the top level directory for details.                                              
//                                                                                                        
// ====================================================================================================   
 
 
 
 
#pragma once
 
#include <memory>
#include <iostream>
 
// forward declarations
class ObjectiveFunction;
 
 
class Optimiser
{
public:
  typedef float PrecisionType;
  
  Optimiser();
 
  virtual ~Optimiser();
  
  void SetObjectiveFunction( std::shared_ptr<ObjectiveFunction>& objectiveFunctionIn );
  
  virtual void Optimise( PrecisionType* startingPoint ) = 0;
  
  virtual void Initialise() = 0;
 
  PrecisionType GetBestObjectiveFunctionValue();
  
  PrecisionType GetInitialObjectiveFunctionValue();
 
  PrecisionType* GetBestPoint();
 
  void ResetCurrentIterationNumber();
 
  inline void SetMaxIterations( unsigned int maxIterations ) 
  {
    this->maxNumberOfIterations = maxIterations;
  }
 
  void SetPreviouslyEvaluatedObjectiveFunctionValue( PrecisionType objectiveFunctionValue );
 
 
  void SetOutputIntermediateGradientFolder( const std::string & outputFolderIn, const std::string & outPrefix ) 
  {
    this->outputIntermediateGradientFolder = outputFolderIn;
    this->outputIntermediateGradientPrefix = outPrefix;
  }
 
 
protected:
  
  void inline MoveCurrentPointAlongGradient( PrecisionType stepSize );
  
  void PerformLineSearch( PrecisionType maxLength, PrecisionType smallLength, PrecisionType& startLength );
  
  PrecisionType currentObjectiveFunctionValue;           
  PrecisionType bestObjectiveFunctionValue;              
  PrecisionType initialObjectiveFunctionValue;           
  unsigned int currentIterationNumber;                   
  unsigned int maxNumberOfIterations;                    
  const unsigned int maxNumberOfLineIterations;          
  PrecisionType maxLineSearchStepSize;                   
  PrecisionType minLineSearchStepSize;                   
  unsigned int numberOfIterationsPerformed;              
  unsigned int numberOfDOFs;                             
  std::shared_ptr<ObjectiveFunction> objectiveFunction;  
  PrecisionType* gradient;                               
  PrecisionType* currentPoint;                           
  PrecisionType* bestPoint;                              
  PrecisionType preEvaluatedObjectiveFunctionValue;      
  bool usePreEvaluatedEvaluatedObjectiveFunctionValue;   
  std::string outputIntermediateGradientFolder;          
  std::string outputIntermediateGradientPrefix;          
};