freSetupOptimizationProcessor.h

Go to the documentation of this file.

/*=========================================================================

  Program:   F.R.E.E. - flexible registration evaluation engine
  Version:   v.1.0.0
  Date:      $Date: 2006/09/01 12:00:00 $
  Module:    $RCSfile: freSetupOptimizationProcessor.h,v $
  Language:  C++


  Copyright (c) 2007 Ralf o Floca (Department of Medical Informatics,
  Institute for Medical Biometry and Informatics, University of Heidelberg,
  Germany). All rights reserved.
  See FREECopyright.txt or http://www.mi.med.uni-hd.de/free/copyright.htm
  for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __freSetupOptimizationProcessor_h
#define __freSetupOptimizationProcessor_h

#include "freElementals.h"
#include "freSetup.h"
#include "freExceptions.h"
#include "freRegistrationEvents.h"
#include "freSetupOptimizationEvents.h"
#include "freSetupTransform.h"
#include "freSetupOptimizationMetric.h"
#include "freSetupOptimizationOptimizer.h"

#include "itkObject.h"

namespace FREE
{

class SetupOptimizationProcessor : public itk::Object
{
public:  
  typedef SetupOptimizationProcessor  Self;
  typedef itk::Object Superclass;
  typedef itk::SmartPointer<Self>        Pointer;
  typedef itk::SmartPointer<const Self>  ConstPointer;
  
  typedef SetupTransform TransformType;
  typedef TransformType::Pointer TransformPointer;
  typedef SetupOptimizationMetric MetricType;
  typedef MetricType::Pointer MetricPointer;
  typedef SetupOptimizationOptimizer OptimizerType;
  typedef OptimizerType::Pointer OptimizerPointer;

        typedef TransformType::ParametersType ParametersType;
        typedef MetricType::MeasureType MeasureType;

  itkTypeMacro( SetupOptimizationProcessor, itk::Object );

  itkNewMacro( Self );

  RegistrationProgressEventBase::Pointer fnOnProgress;

  SetOpIterationEventBase::Pointer fnOnNextIteration;

  ProgressEventBase::Pointer fnOnMetricComputationProgress;

  ProgressEventBase::Pointer fnOnEvaluationDone;

  ProgressEventBase::Pointer fnOnEvaluationProgress;

  ProgressEventBase::Pointer fnOnNextAdaptation;

  ProgressEventBase::Pointer fnOnEvaluationFailed;

  Setup* GetSetup();
  void SetSetup(Setup* pSetup);

  Adaptation::AdaptationList* GetAdaptationList();
  void SetAdaptationList(Adaptation::AdaptationList* pAdaptations);

  itkGetObjectMacro(Transform,TransformType);
  itkSetObjectMacro(Transform,TransformType);

  itkGetObjectMacro(Metric,MetricType);
  itkSetObjectMacro(Metric,MetricType);

  itkGetObjectMacro(Optimizer,OptimizerType);
  itkSetObjectMacro(Optimizer,OptimizerType);

        itkGetConstReferenceMacro(FinalParameters, ParametersType);
        itkGetConstReferenceMacro(FinalMeasure, MeasureType);

  const Setup* GetFinalSetup () const { return m_smpFinalSetup; };

  virtual const long GetMaxIterationCount() const;

        const long GetCurrentIterationCount() const;

  bool OptimizationIsFinished() const {return this->m_bOptimizationDone;};

  void StartOptimization();

  void ResumeOptimization();
  bool OptimizationIsResumable();
  void StopOptimization();
  bool OptimizationIsStoppable();

protected:
  SetupOptimizationProcessor();

  virtual ~SetupOptimizationProcessor();

  void ComputeOptimization();

  long m_lCurIteration;

  bool m_bOptimizationDone;
        bool m_bOptimizationStarted;

  Adaptation::AdaptationList::Pointer           m_smpAdaptations;

  Setup::Pointer                                  m_smpSetup;

  TransformPointer                                      m_Transform;
  MetricPointer                                                 m_Metric;
  OptimizerPointer                                      m_Optimizer;

  Setup::Pointer                                                m_smpFinalSetup;
        TransformType::ParametersType m_FinalParameters;
        MetricType::MeasureType                         m_FinalMeasure;

  void OnNewIteration(void* pSender, long threadID);

  void OnEvaluationProgress(const long status, const std::string& sComment, void* pSender, long threadID);
};

}//End of Namespace free

#endif

---