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

namespace FREE
{




DefineParameterMacro(AmoebaOptimizerController,AutoInitialSimplex,"AutoInitialSimplex","Determines if the optimizer uses a small default simplex, SimplexDelta will be ignored.");
DefineParameterMacro(AmoebaOptimizerController,SimplexDelta,"SimplexDelta","Starting size of the simplex");
DefineParameterMacro(AmoebaOptimizerController,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(AmoebaOptimizerController,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.");


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

void
AmoebaOptimizerController::
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);
};

void
AmoebaOptimizerController::
ActualizeMainComponent(ComponentType* pMainComponent,
                       SessionComponentCache* pComponentCache, SessionInfo* pSessionInfo,
                                                                                         const unsigned int& iActLevel) const
{
  ComponentSetup* pTransformSetup = pComponentCache->Setup()->GetComponentByIDPath("../"+ComponentID(cComp_MainTransform));
  if (!pTransformSetup) throwCtrlExceptionMacro("","No main transform setup found to gather parameter scales");
  TransformSetupAdaptor adaptor(pTransformSetup);

        bool bAutoSimplex;
        double dSimplexDelta;
  double dParamConvTolerance;
  double dFunctConvTolerance;
  int iNrOfIterations;

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

        pMainComponent->SetAutomaticInitialSimplex(bAutoSimplex);

  ParameterArrayType scales = this->GetTransformScales(pComponentCache,iActLevel);
        ComponentType::ParametersType simplexDelta( scales.size() );

  simplexDelta.Fill( dSimplexDelta );
        pMainComponent->SetInitialSimplexDelta( simplexDelta );

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

  Parameter::Pointer smpDirection = pComponentCache->GetParentCache()->Controller()->GetParameter(pComponentCache->GetParentCache(),OptimizerOwnerControllerInterface::cParam_MinimizeToOptimize);
  if (smpDirection.IsNull()) throwCtrlExceptionMacro("","Cannot retrieve optimization direction via optimizer owner. Parameter \"MinimizeToOptimize\" is unknown. Please ensure valid session and setup");
  bool bMinimize;
  smpDirection->GetParameterValue(bMinimize);
  pMainComponent->SetMaximize( !bMinimize);
};

void
AmoebaOptimizerController::
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.
  {
    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", "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->GetCachedValue()),pEntry->GetRefID()+parameters.Size());
};

} //end of namespace free

---