freAmoebaSOOptimizerController.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: freAmoebaSOOptimizerController.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 "freAmoebaSOOptimizerController.h"
#include "freExceptions.h"

namespace FREE
{




DefineParameterMacro(AmoebaSOOptimizerController,AutoInitialSimplex,"AutoInitialSimplex","Determines if the optimizer uses a small default simplex, SimplexDelta will be ignored.");
DefineParameterMacro(AmoebaSOOptimizerController,SimplexDelta,"SimplexDelta","Starting size of the simplex");
DefineParameterMacro(AmoebaSOOptimizerController,ParamConvTolerance,"ParamConvTolerance","Parameter convergence tolerance is the simplex diameter treshold. Optimation stopps if when the simplex diameter and the function convergence falls below their tresholds.");
DefineParameterMacro(AmoebaSOOptimizerController,FunctConvTolerance,"FunctConvTolerance","Function convergence tolerance is the function convergence treshold. Optimation stopps if when the simplex diameter and the function convergence falls below their tresholds.");

AmoebaSOOptimizerController::
AmoebaSOOptimizerController()
{
  //Profile settings
  this->UpdateControllerID(ControllerID::AmoebaSOOptimizerController);
  this->m_Description = "Optimizes by an amoeba optimizer (simplex) approach.";
};

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

        //Parameters
  profile.Parameters().AddParameter(cParam_AutoInitialSimplex,CtrlProfile::Parameter::PVTBool,cParamDsc_AutoInitialSimplex,1,"true",-1,true);
  profile.Parameters().AddParameter(cParam_SimplexDelta,CtrlProfile::Parameter::PVTDouble,cParamDsc_SimplexDelta,1,"5",-1,true);
  profile.Parameters().AddParameter(cParam_ParamConvTolerance,CtrlProfile::Parameter::PVTDouble,cParamDsc_ParamConvTolerance,1,"1e-8",-1,true);
  profile.Parameters().AddParameter(cParam_FunctConvTolerance,CtrlProfile::Parameter::PVTDouble,cParamDsc_FunctConvTolerance,1,"1e-4",-1,true);
  profile.Parameters().AddParameter(cParam_Iterations,Parameter::PVTInteger,cParamDsc_Iterations,1,"500",-1,true);
};

long
AmoebaSOOptimizerController::
GetMaxIterationCount(const SessionComponentCache* pComponentCache, unsigned int iResolutionLevel) const
{
        if (!pComponentCache) throwCtrlExceptionMacro("","Passed pComponentCache is NULL.");
        if (!pComponentCache->SetupIsAssigned()) throwCtrlExceptionMacro("","Cache has no setup assigned.");

  long lResult = 1;
  SessionAccessor::GetParameterValue(pComponentCache,cParam_Iterations,lResult);

  return lResult;
};

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

        bool bAutoSimplex;
        ComponentType::ParametersType simplexDelta;
  double dParamConvTolerance;
  double dFunctConvTolerance;
  int iNrOfIterations;

  try
  {
    SessionAccessor::GetParameterValue(pComponentCache,cParam_AutoInitialSimplex,bAutoSimplex);
    SessionAccessor::GetParameterValue(pComponentCache,cParam_ParamConvTolerance,dParamConvTolerance);
    SessionAccessor::GetParameterValue(pComponentCache,cParam_FunctConvTolerance,dFunctConvTolerance);
    SessionAccessor::GetParameterValue(pComponentCache,cParam_Iterations,iNrOfIterations);
  }
  catchAllNPassMacro("Error while retrieving parameter values.");    

  Parameter::Pointer smpParameter = SessionAccessor::GetParameter(pComponentCache,cParam_SimplexDelta);
  if (smpParameter.IsNull()) throwExceptionMacro("Missing parameter: " << cParam_SimplexDelta);
        simplexDelta = Convert::ParameterLayerToArray<ComponentType::ParametersType>(*(smpParameter->GetParameterLayer(0)));

        pMainComponent->SetAutomaticInitialSimplex(bAutoSimplex);
        pMainComponent->SetInitialSimplexDelta( simplexDelta );

  pMainComponent->SetParametersConvergenceTolerance(dParamConvTolerance);
  pMainComponent->SetFunctionConvergenceTolerance(dFunctConvTolerance);
  pMainComponent->SetMaximumNumberOfIterations(iNrOfIterations);
};

void
AmoebaSOOptimizerController::
SetStatisticEntryMainComponent(StatisticEntry& rStatisticEntry,
                                             ComponentType* pMainComponent,
                                             SessionComponentCache* pMainComponentCache,
                                             SessionInfo* pSessionInfo,
                                             StatisticDictionary& rDictionary) const
{
  ParameterArrayType parameters = pMainComponent->GetCachedCurrentPosition();

  std::string sName = "Position #";
  std::string sIDPath = pMainComponentCache->GetIDPath();
  std::string sCommment = "Optimizer position. Meaning depends on chosen transformation";
  StatisticValueDefinition* pEntry = rDictionary.GetValueDefinitionByName(sIDPath,sName+"0");
    
  if (!pEntry) //Entry is not recorded yet, so do so.
  {
    std::string sName = "Position #";
    pEntry = rDictionary.AddValueDefinition(sIDPath,sName+"0", sCommment);
    for (unsigned int i = 1; i<parameters.Size(); i++)
    {
      rDictionary.AddValueDefinition(sIDPath,sName+Convert::ToStr(i),sCommment);
    }

    rDictionary.AddValueDefinition(sIDPath,"OptimizerValue", "Composed value of the optimizer");
  }
  
  for (unsigned int i = 0; i<parameters.Size(); i++)
  {
    rStatisticEntry.AddValue(Convert::ToStr(parameters.GetElement(i)),pEntry->GetRefID()+i);
  }

  rStatisticEntry.AddValue(Convert::ToStr(pMainComponent->GetCurrentValue()),pEntry->GetRefID()+parameters.Size());
};

} //end of namespace free

---