CorrespondenceModel.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 <vector>
#include <iostream>
#include "Supremo.h"
#include "Transformation.h"
 
 
class CorrespondenceModel{
public:
 
  typedef float PrecisionType;
  typedef std::vector<PrecisionType> SurrogateSignalType;
  
  CorrespondenceModel( unsigned int numberOfSurrogateSignalsIn, 
                       std::shared_ptr<Transformation> transformationIn );
 
  ~CorrespondenceModel();
 
  //PrecisionType* GetTransformParamsFromSurrogateSignal( PrecisionType* surrogateSignalIn );
 
  std::shared_ptr<Transformation> GetTransformationFromSurrogateSignal( const SurrogateSignalType & surrogateSignalIn );
 
  PrecisionType* GetParameters();
 
  void SetParameters( const PrecisionType* parametersIn );
 
 
  void SetParameters( const std::vector<nifti_image*>& parameterImagesIn );
 
 
  PrecisionType GetMaxParameterLength( PrecisionType* parametersIn );
 
  inline unsigned int GetNumberOfParameters() { return this->numberOfModelParameters; };
 
  void GetTransformationParameterGradientWRTModelParameters( PrecisionType* transformationGradientIn,
                                                             const SurrogateSignalType & surrogateSignalIn,
                                                             PrecisionType* correspondenceModelGradientOut );
 
  void InitialiseLevel( unsigned int levelIn );
 
  std::shared_ptr<Transformation> GetTransformation();
  
  std::vector<nifti_image*> GetCorrespondenceModelAsImage();
 
  void SaveCurrentModelParametersForRecovery();
 
 
  void RecoverSavedModelParameters();
 
 
private:
  void ClearRecoveryModelParameters();
 
  unsigned int numberOfSurrogateSignals;          
  unsigned int numberOfTransformationParameters;  
  unsigned int numberOfModelParameters;           
  std::shared_ptr<Transformation> transform;      
  PrecisionType* modelParameters;                 
  PrecisionType* recoveryModelParameters;         
};