freESAsymmetricMutationController.cxx

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: freESAsymmetricMutationController.cxx,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.

=========================================================================*/

#include "freESAsymmetricMutationController.h"
#include "freExceptions.h"

namespace FREE
{



DefineParameterMacro(ESAsymmetricMutationController,Gamma,"Gamma","The general control parameter for the shape of the asymmetric distributen. Default value =2; a higher value will enforce the ability of new adaptation, but lower the asymmetric characteristics, thus the ability to adapt a certain direction.");
DefineParameterMacro(ESAsymmetricMutationController,Tau,"Tau","Controls the (individual) step size of the mutation of the strategic parameter variance.");
DefineParameterMacro(ESAsymmetricMutationController,TauGlobal,"TauGlobal","Controls the (global) step size of the mutation of the strategic parameter variance.");
DefineParameterMacro(ESAsymmetricMutationController,Tau_Skewness,"Tau_Skewness","Controls the (individual) step size of the mutation of the strategic parameter skewness.");
DefineParameterMacro(ESAsymmetricMutationController,TauGlobal_Skewness,"TauGlobal_Skewness","Controls the (global) step size of the mutation of the strategic parameter skewness.");
DefineParameterMacro(ESAsymmetricMutationController,InitialSeed,"InitialSeed", "Seed for the variate gernerator.");
DefineParameterMacro(ESAsymmetricMutationController,UseInitialSeed,"UseInitialSeed","Use the initial seed for initializing the variate gernerator for the mutation; otherwise use actual time to initialize.");

ESAsymmetricMutationController::
ESAsymmetricMutationController()
{
  //Profile settings
  this->UpdateControllerID(ControllerID::ESAsymmetricMutationController);
  this->m_Description = "An adaptive normal ES mutations.";
};

void
ESAsymmetricMutationController::
GenerateProfile(CtrlProfile::ControllerProfile& profile,
                const SessionComponentCache* pComponentCache,
                bool bRegardOldSetup) const
{
  Superclass::GenerateProfile(profile,pComponentCache,bRegardOldSetup);

  //Parameters
  profile.Parameters().AddParameter(cParam_Gamma,CtrlProfile::Parameter::PVTDouble,cParamDsc_Gamma,1,"2.0",-1,true);
  profile.Parameters().AddParameter(cParam_Tau,CtrlProfile::Parameter::PVTDouble,cParamDsc_Tau,1,"1.0",-1,true);
  profile.Parameters().AddParameter(cParam_TauGlobal,CtrlProfile::Parameter::PVTDouble,cParamDsc_TauGlobal,1,"1.0",-1,true);
  profile.Parameters().AddParameter(cParam_Tau_Skewness,CtrlProfile::Parameter::PVTDouble,cParamDsc_Tau_Skewness,1,"1.0",-1,true);
  profile.Parameters().AddParameter(cParam_TauGlobal_Skewness,CtrlProfile::Parameter::PVTDouble,cParamDsc_TauGlobal_Skewness,1,"1.0",-1,true);
  profile.Parameters().AddParameter(cParam_InitialSeed,CtrlProfile::Parameter::PVTInteger,cParamDsc_InitialSeed,1,"21021978");
  profile.Parameters().AddParameter(cParam_UseInitialSeed,CtrlProfile::Parameter::PVTBool,cParamDsc_UseInitialSeed,1,"false");
};

void
ESAsymmetricMutationController::
ActualizeMainComponent(ComponentType* pMainComponent,
                       SessionComponentCache* pComponentCache, SessionInfo* pSessionInfo,
                                                                                         const unsigned int& iActLevel) const
{
  Superclass::ActualizeMainComponent(pMainComponent, pComponentCache,
                                     pSessionInfo, iActLevel);

  int iSeed;
        bool bUseSeed;
  double dGamma;
  double dTau;
  double dTauGlobal;
  double dTau_Skewness;
  double dTauGlobal_Skewness;

  try
  {
    SessionAccessor::GetParameterValue(pComponentCache,cParam_InitialSeed,iSeed,0,iActLevel,true);
    SessionAccessor::GetParameterValue(pComponentCache,cParam_UseInitialSeed,bUseSeed,0,iActLevel,true);
    SessionAccessor::GetParameterValue(pComponentCache,cParam_Gamma,dGamma,0,iActLevel,true);
    SessionAccessor::GetParameterValue(pComponentCache,cParam_Tau,dTau,0,iActLevel,true);
    SessionAccessor::GetParameterValue(pComponentCache,cParam_TauGlobal,dTauGlobal,0,iActLevel,true);
    SessionAccessor::GetParameterValue(pComponentCache,cParam_Tau_Skewness,dTau_Skewness,0,iActLevel,true);
    SessionAccessor::GetParameterValue(pComponentCache,cParam_TauGlobal_Skewness,dTauGlobal_Skewness,0,iActLevel,true);
  }
  catchAllNPassMacro("Error while retrieving parameter values.");

        if (bUseSeed)
        {
          pMainComponent->GetRandomGenerator().Initialize(iSeed);
        }
        else
        {
                pMainComponent->GetRandomGenerator().Initialize();
        }

  pMainComponent->SetGamma(dGamma);
  pMainComponent->SetTau(dTau);
  pMainComponent->SetTau_Skewness(dTau_Skewness);
  pMainComponent->SetTauGlobal(dTauGlobal);
  pMainComponent->SetTauGlobal_Skewness(dTauGlobal_Skewness);
};

} //end of namespace free

---