freExhaustiveSOOptimizer.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: freExhaustiveSOOptimizer.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 __freExhaustiveSOOptimizer_h
#define __freExhaustiveSOOptimizer_h

#include "freSetupOptimizationOptimizer.h"

namespace FREE
{
  
class ITK_EXPORT ExhaustiveSOOptimizer : 
        public SetupOptimizationOptimizer
{
public:
  typedef ExhaustiveSOOptimizer                         Self;
  typedef SetupOptimizationOptimizer                                                                            Superclass;
  typedef itk::SmartPointer<Self>                    Pointer;
  typedef itk::SmartPointer<const Self>              ConstPointer;
  
        typedef itk::Array< unsigned long > StepsType;
        typedef itk::Array< long >              ParameterAxisType;
        typedef itk::Array< unsigned long > AxisTypeType;

  itkTypeMacro( ExhaustiveSOOptimizer, SetupOptimizationOptimizer );

  itkNewMacro(Self);

  virtual void    StartOptimization( void );

  void StartWalking( void );
  void ResumeWalking( void );
  void StopWalking( void );
  
  virtual bool IsStoppable() const;
  virtual void StopOptimization();

  virtual bool IsResumeable() const;
  virtual void ResumeOptimization();

        unsigned int GetAxisCount() const;

        itkSetMacro( StepLength, double );
  itkSetMacro( NumberOfSteps, StepsType );
  itkSetMacro( ParameterAxis, ParameterAxisType );
  itkSetMacro( AxisType, AxisTypeType );
        itkSetMacro( MinimumIsBest, bool );
        itkGetMacro( MinimumIsBest, bool );

  itkGetConstReferenceMacro( StepLength, double );
  itkGetConstReferenceMacro( NumberOfSteps, StepsType );
  itkGetConstReferenceMacro( ParameterAxis, ParameterAxisType );
  itkGetConstReferenceMacro( MaximumMetricValue, MeasureType );
  itkGetConstReferenceMacro( MinimumMetricValue, MeasureType );
  itkGetConstReferenceMacro( MaximumDecomposedMetricValue, DecomposedMeasureType );
  itkGetConstReferenceMacro( MinimumDecomposedMetricValue, DecomposedMeasureType );
  itkGetConstReferenceMacro( MinimumMetricValuePosition, ParametersType );
  itkGetConstReferenceMacro( MaximumMetricValuePosition, ParametersType );
  itkGetConstReferenceMacro( CurrentIndex, ParametersType );
  itkGetConstReferenceMacro( MaximumNumberOfIterations, unsigned long );

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

  void AdvanceOneStep( void );
  void IncrementIndex( ParametersType & param );

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

protected:
  StepsType            m_NumberOfSteps;
  unsigned long        m_CurrentIteration;
  bool                 m_Stop;
  unsigned int         m_CurrentParameter;
  double               m_StepLength; 
  ParametersType       m_CurrentIndex;
  unsigned long        m_MaximumNumberOfIterations;
  MeasureType          m_MaximumMetricValue;
  MeasureType          m_MinimumMetricValue;
  DecomposedMeasureType  m_MaximumDecomposedMetricValue;
  DecomposedMeasureType  m_MinimumDecomposedMetricValue;
  ParametersType       m_MinimumMetricValuePosition;
  ParametersType       m_MaximumMetricValuePosition;
  ParameterAxisType    m_ParameterAxis;
        AxisTypeType                             m_AxisType;
        bool                                                             m_MinimumIsBest;
};

} // end namespace FREE



#endif
    
 

---