freESMutationBase.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: freESMutationBase.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 __freESMutationBase_h
#define __freESMutationBase_h

#include "freESComponentBase.h"
#include "freESPopulation.h"

#include <itkArray.h>

namespace FREE
{
  namespace ES
  {

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

      //itkNewMacro(Self); //it is an abstract class, so no New method

      itkTypeMacro(MutationBase, ComponentBase);

      typedef typename Superclass::IndividualType   IndividualType;
      typedef typename IndividualType::Pointer      IndividualPointer;
      typedef Population<IndividualType>            PopulationType;

      typedef itk::Array<double>             ScalesType;

      void Mutate(IndividualType* pIndividual, PopulationType* pPopulation) const;

      virtual double MutateValue(const double& value) = 0;

      itkGetMacro(MutateValueScale, double);
      itkSetMacro(MutateValueScale, double);

      void SetGeneralObjectiveScales(const ScalesType & scales);
      itkGetConstReferenceMacro( GeneralObjectiveScales, ScalesType );

    protected:
      MutationBase() ;
      virtual ~MutationBase() ;

      ScalesType m_GeneralObjectiveScales;
      bool m_ScalesInitialized;

      virtual void MutateObjectivParameters(IndividualType* pIndividual, PopulationType* pPopulation) const =0;

      double m_MutateValueScale;

    private:
      MutationBase(Self const&); // Purposely not implemented.

    } ; // end of class

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


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

#endif

---