freEvolutionaryStrategyOptimizerBase.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: freEvolutionaryStrategyOptimizerBase.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 __freEvolutionaryStrategyOptimizerBase_h
#define __freEvolutionaryStrategyOptimizerBase_h

#include <itkSingleValuedNonLinearOptimizer.h>

namespace FREE
{
  namespace ES
  {

    class ITK_EXPORT EvolutionaryStrategyOptimizerBase: 
      public itk::SingleValuedNonLinearOptimizer
    {
    public:
      typedef EvolutionaryStrategyOptimizerBase     Self ;
      typedef itk::SingleValuedNonLinearOptimizer      Superclass;
      typedef itk::SmartPointer<Self>                  Pointer;
      typedef itk::SmartPointer<const Self>            ConstPointer;

      itkTypeMacro(EvolutionaryStrategyOptimizerBase, SingleValuedNonLinearOptimizer );

      typedef  itk::SingleValuedCostFunction         CostFunctionType;
      typedef  CostFunctionType::Pointer        CostFunctionPointer;

      itkSetMacro( MaximumIteration, unsigned int );
      itkGetConstReferenceMacro( MaximumIteration, unsigned int );

      itkGetConstReferenceMacro( CurrentCost, MeasureType );
      MeasureType GetValue() const { return this->GetCurrentCost(); }

      itkGetConstReferenceMacro( CurrentIteration, unsigned int) ;

      itkSetMacro( Maximize, bool );
      itkGetConstMacro( Maximize, bool );
      itkBooleanMacro( Maximize );
      bool GetMinimize( ) const
        { return !m_Maximize; }
      void SetMinimize(bool v)
        { this->SetMaximize(!v); }
      void    MinimizeOn(void) 
        { SetMaximize( false ); }
      void    MinimizeOff(void) 
        { SetMaximize( true ); }

      virtual void StartOptimization() = 0;

      virtual void StopOptimization() 
      { m_Stop = true ; }

      virtual void ResumeOptimization();

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

      bool m_Stop ;

      bool m_Started;

      unsigned int m_CurrentIteration ;

      MeasureType       m_CurrentCost;

    private:
      unsigned int m_MaximumIteration ;

      bool m_Maximize;
    } ; // end of class

  } // end of namespace ES
} // end of namespace FREE

#endif

---