ObjectiveFunction.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
 
 
 
//----------
// includes
//----------
#include "Supremo.h"
#include <memory>
#include "SupremoUtils.h"
 
 
 
//----------------------
// Forward declarations
//----------------------
class CorrespondenceModel;
class Transformation;
 
 
 
 
class ObjectiveFunction{
public:
 
  typedef float PrecisionType;
  typedef std::vector< std::vector<PrecisionType> > SurrogateSignalType;
 
  ObjectiveFunction();
 
 
  ~ObjectiveFunction();
 
 
  PrecisionType GetValue( const PrecisionType* parametersIn );
 
 
  void GetGradient( const PrecisionType* parametersIn, PrecisionType* gradientOut, bool normaliseGradient = false );
 
 
  std::vector<nifti_image*> GetGradientAsImage( const PrecisionType* parametersIn, bool normaliseGradient = false );
 
 
  unsigned int GetNumberOfParameters();
 
 
  PrecisionType GetMaxStepSize();
 
 
  void SetCorrespondenceModel( const std::shared_ptr<CorrespondenceModel>& correspondenceModelIn );
 
 
  void SetSimilarityMeasure( const std::shared_ptr<ImageSimilarity>& imageSimilarityIn);
 
 
  void SetSurrogateSignals( const SurrogateSignalType & surrSignalsIn );
 
 
  void SetReferenceStateImage( nifti_image* refStateImgIn );
 
 
  void SetDynamicImages( const std::vector<nifti_image*>& dynamicImagesIn );
 
  void SetImageAcquisition( const std::shared_ptr<ImageAcquisition>& imageAcquisitionIn );
 
private:
  std::shared_ptr<CorrespondenceModel> correspondenceModel;   
  std::shared_ptr<ImageSimilarity>  imageSimilarity;          
  SurrogateSignalType surrogateSignals;                       
  nifti_image* referenceStateImage;                           
  std::vector<nifti_image*> dynamicImages;                    
  PrecisionType similarityWeight;                             
  std::shared_ptr<ImageAcquisition> imageAcquisition;         
};