freSetupOptimizationOptimizer.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: freSetupOptimizationOptimizer.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 __freSetupOptimizationOptimizer_h
#define __freSetupOptimizationOptimizer_h

#include "freSetupOptimizationMetric.h"

#include "itkNonLinearOptimizer.h"

namespace FREE
{
  
class ITK_EXPORT SetupOptimizationOptimizer : 
        public itk::NonLinearOptimizer
{
public:
  typedef SetupOptimizationOptimizer                                Self;
  typedef itk::NonLinearOptimizer                                                               Superclass;
  typedef itk::SmartPointer<Self>               Pointer;
  typedef itk::SmartPointer<const Self>         ConstPointer;
  
        typedef SetupOptimizationMetric                                                                 CostFunctionType;
        typedef CostFunctionType::Pointer                                                               CostFunctionPointer;
        typedef CostFunctionType::MeasureType                                           MeasureType;
        typedef CostFunctionType::DecomposedMeasureType DecomposedMeasureType;

  itkTypeMacro( SetupOptimizationOptimizer, NonLinearOptimizer );
 
  virtual void StartOptimization() = 0;

  virtual bool IsStoppable() const;
 
  virtual void StopOptimization();

  virtual bool IsResumeable() const;

  virtual void ResumeOptimization();

  itkGetConstReferenceMacro( CurrentValue, MeasureType );
  itkGetConstReferenceMacro( CurrentDecomposedValue, DecomposedMeasureType );
  itkGetConstReferenceMacro( BestPosition, ParametersType );
  itkGetConstReferenceMacro( BestValue, MeasureType );

        virtual MeasureType  GetValue (const ParametersType &parameters);
        virtual DecomposedMeasureType  GetDecomposedValue (const ParametersType &parameters);

  virtual void SetCostFunction( CostFunctionType * costFunction );
  itkGetConstObjectMacro( CostFunction, CostFunctionType );

protected:
  SetupOptimizationOptimizer();
  virtual ~SetupOptimizationOptimizer() {};
        void PrintSelf(std::ostream& os, itk::Indent indent) const;

private:  
  SetupOptimizationOptimizer(const Self&); //purposely not implemented
  void operator=(const Self&);//purposely not implemented

protected:
  mutable MeasureType          m_CurrentValue;
  mutable DecomposedMeasureType  m_CurrentDecomposedValue;
        mutable ParametersType                   m_BestPosition;
        mutable MeasureType                                      m_BestValue;

        CostFunctionPointer  m_CostFunction;
};

} // end namespace FREE

#endif
    
 

---