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

namespace FREE
{




DefineParameterMacro(PowellSOOptimizerController,MaximumLineIteration,"MaximumLineIteration","Maximum number of line search iterations.");
DefineParameterMacro(PowellSOOptimizerController,StepLength,"StepLength","StepLength for the (scaled) spacing of the sampling of parameter space while bracketing the extremum");
DefineParameterMacro(PowellSOOptimizerController,StepTolerance,"StepTolerance","Once the local extreme is known to be within this distance of the current parameter values, optimization terminates.");
DefineParameterMacro(PowellSOOptimizerController,ValueTolerance,"ValueTolerance","Once this current cost function value is known to be within this tolerance of the cost function value at the local extreme, optimization terminates.");

PowellSOOptimizerController::
PowellSOOptimizerController()
{
  //Profile settings
  this->UpdateControllerID(ControllerID::PowellSOOptimizerController);
  this->m_Description = "Optimizes registration setups by Powell optimizer approach using Brent line search.";
};

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

        //Parameters
        profile.Parameters().AddParameter(cParam_Iterations,Parameter::PVTInteger,cParamDsc_Iterations,1,"100");
        profile.Parameters().AddParameter(cParam_MaximumLineIteration,Parameter::PVTInteger,cParamDsc_MaximumLineIteration,1,"100");
  profile.Parameters().AddParameter(cParam_StepLength,Parameter::PVTDouble,cParamDsc_StepLength,1,"1.0");
  profile.Parameters().AddParameter(cParam_StepTolerance,Parameter::PVTDouble,cParamDsc_StepTolerance,1,"0.00001");
  profile.Parameters().AddParameter(cParam_ValueTolerance,Parameter::PVTDouble,cParamDsc_ValueTolerance,1,"0.00001");
};

long
PowellSOOptimizerController::
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;
  try
  {
    SessionAccessor::GetParameterValue(pComponentCache,cParam_Iterations,lResult);
  }
  catchAllNPassMacro("Unknown error while retrieving max interation count.")

  return lResult;
};

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

  double dValueTolerance;
  double dStepTolerance;
  double dStepLength;
  int iNrOfIterations;
  int iLineIteration;

  try
  {
    SessionAccessor::GetParameterValue(pComponentCache,cParam_MaximumLineIteration,iLineIteration);
    SessionAccessor::GetParameterValue(pComponentCache,cParam_StepLength,dStepLength);
    SessionAccessor::GetParameterValue(pComponentCache,cParam_StepTolerance,dStepTolerance);
    SessionAccessor::GetParameterValue(pComponentCache,cParam_ValueTolerance,dValueTolerance);
    SessionAccessor::GetParameterValue(pComponentCache,cParam_Iterations,iNrOfIterations);
  }
  catchAllNPassMacro("Error while retrieving parameter values.");    

  pMainComponent->SetMaximumIteration(iNrOfIterations);
  pMainComponent->SetMaximumLineIteration(iLineIteration);
  pMainComponent->SetStepLength(dStepLength);
  pMainComponent->SetStepTolerance(dStepTolerance);
  pMainComponent->SetValueTolerance(dValueTolerance);

        //get metric "orientation"
  Parameter::Pointer param = SessionAccessor::GetParameterByIDPath(pComponentCache,cIDPParent+IDPath(cComp_MainMetric+std::string("/@")+std::string(cParam_MetricMinimize)));
        bool bMin = true;
        if (param.IsNotNull())
        {
                param->GetParameterValue(bMin);
        }
        pMainComponent->SetMaximize(!bMin);
};

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

  std::string sName = "Position #";
  std::string sIDPath = pMainComponentCache->GetIDPath();
  StatisticValueDefinition* pEntry = rDictionary.GetValueDefinitionByName(sIDPath,sName+"0");
    
  if (!pEntry) //Entry is not recorded yet, so do so.
  {
    std::string sCommment = "Optimizer current position. Meaning depends on chosen transformation";
    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,"GlobalIterationID", "Nr / ID of the global search.");
    rDictionary.AddValueDefinition(sIDPath,"LineIterationID", "Nr / ID of the line search iteration.");
    rDictionary.AddValueDefinition(sIDPath,"OptimizerValue", "Composed value of the current optimizer position");
  }
  
  for (unsigned int i = 0; i<parameters.Size(); i++)
  {
    rStatisticEntry.AddValue(Convert::ToStr(parameters.GetElement(i)),pEntry->GetRefID()+i);
  }

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

} //end of namespace free

---