freEvolutionaryStrategyOptimizer.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: freEvolutionaryStrategyOptimizer.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 __freEvolutionaryStrategyOptimizer_h
#define __freEvolutionaryStrategyOptimizer_h

#include "freEvolutionaryStrategyOptimizerBase.h"

#include "freESPopulation.h"
#include "freESParentSelectorBase.h"
#include "freESRecombinatorBase.h"
#include "freESMutationBase.h"
#include "freESSelectionBase.h"

namespace FREE
{
  namespace ES
  {

    itkEventMacro( NewChildEvent, itk::AnyEvent );

    itkEventMacro( NewChildGenerationEvent, NewChildEvent );

    itkEventMacro( NewChildEvaluationEvent, NewChildEvent );

    itkEventMacro( InvalidChildEvaluationEvent, NewChildEvent );

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

      itkNewMacro(Self);

      itkTypeMacro(EvolutionaryStrategyOptimizer, EvolutionaryStrategyOptimizerBase );

      typedef TIndividual                                  IndividualType;
      typedef typename IndividualType::Pointer             IndividualPointer;
      typedef typename IndividualType::ObjectiveValueType  ObjectiveValueType;
      typedef typename IndividualType::IndividualIDType    IndividualIDType;
      typedef std::vector<IndividualIDType>                IndividualSelectionType;
      typedef std::map<IndividualIDType,IndividualSelectionType>  HeritageMapType;

      typedef Population<IndividualType>                   PopulationType;
      typedef typename PopulationType::Pointer             PopulationPointer;

      typedef itk::SingleValuedCostFunction                CostFunctionType;
      typedef typename CostFunctionType::Pointer           CostFunctionPointer;
      typedef typename CostFunctionType::ParametersType    CostFunctionParametersType;

      typedef ParentSelectorBase<IndividualType>           ParentSelectorType;
      typedef typename ParentSelectorType::Pointer         ParentSelectorPointer;

      typedef RecombinatorBase<IndividualType>             RecombinatorType;
      typedef typename RecombinatorType::Pointer           RecombinatorPointer;

      typedef MutationBase<IndividualType>                 MutationType;
      typedef typename MutationType::Pointer               MutationPointer;

      typedef SelectionBase<IndividualType>                SelectionType;
      typedef typename SelectionType::Pointer              SelectionPointer;


      itkSetMacro( NumberOfParents, unsigned long );
      itkGetConstMacro( NumberOfParents, unsigned long );

      itkSetMacro( NumberOfChildren, unsigned long );
      itkGetConstMacro( NumberOfChildren, unsigned long );

      itkSetMacro( MutateIntitialPopulation, bool );
      itkGetConstMacro( MutateIntitialPopulation, bool );

      itkSetMacro( Threshold, ObjectiveValueType );
      itkGetConstMacro( Threshold, ObjectiveValueType );
     
      virtual void SetParentSelector( ParentSelectorType * pParentSelector );
      itkGetConstObjectMacro( ParentSelector, ParentSelectorType );
      itkGetObjectMacro( ParentSelector, ParentSelectorType );

      virtual void SetRecombinator( RecombinatorType * pRecombinator );
      itkGetConstObjectMacro( Recombinator, RecombinatorType );
      itkGetObjectMacro( Recombinator, RecombinatorType );

      virtual void SetMutation( MutationType * pMutation );
      itkGetConstObjectMacro( Mutation, MutationType );
      itkGetObjectMacro( Mutation, MutationType );

      virtual void SetSelection( SelectionType * pSelection );
      itkGetConstObjectMacro( Selection, SelectionType );
      itkGetObjectMacro( Selection, SelectionType );

      itkGetConstObjectMacro( Population, PopulationType );
      itkGetObjectMacro( Population, PopulationType );

      itkGetConstObjectMacro( CurrentChild, IndividualType );
      itkGetObjectMacro( CurrentChild, IndividualType );

      const IndividualType* GetBestIndividualEver() const;
      const IndividualType* GetBestIndividual() const;

      virtual void Initialize(const PopulationType& population);

      virtual void Initialize();

      virtual void StartOptimization();

      virtual void ResumeOptimization(); 

      const HeritageMapType& GetRecentParentSelections() const;

      const PopulationPointer& GetRecentPopulationSelections() const;

      const PopulationPointer& GetNewChildren() const;

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

      virtual void EvaluatePopulation(PopulationType* pPopulation) const;
      virtual void EvaluateIndividual(IndividualType* pIndividual) const;

      virtual IndividualPointer FindBestIndividual(PopulationType* pPopulation);

      virtual void SetBestIndividual(PopulationType* pPopulation);

      virtual CostFunctionParametersType ConvertIndividualToParameter(const IndividualType* pIndividual) const;

    private:
      ParentSelectorPointer m_ParentSelector;

      RecombinatorPointer m_Recombinator;

      MutationPointer m_Mutation;

      SelectionPointer m_Selection;

      PopulationPointer m_Population;

      bool m_PopulationIsInitialized;

      bool m_MutateIntitialPopulation;

      unsigned long m_NumberOfParents;

      unsigned long m_NumberOfChildren;

      ObjectiveValueType m_Threshold;

      mutable HeritageMapType m_ParentSelections;

      mutable PopulationPointer m_SelectionVictims;

      mutable PopulationPointer m_NewChildren;

      /* Pointer to the new child is currently processed within the optimization loop
       * Normaly this pointer is only valid (!Null) when the NewChildGenerationEvent
       * was raised */
      mutable IndividualPointer m_CurrentChild;

    } ; // end of class

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

#ifndef ITK_MANUAL_INSTANTIATION
#include "freEvolutionaryStrategyOptimizer.txx"
#endif

#endif

---