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


namespace FREE
{



GradientDescentOptimizerController::
GradientDescentOptimizerController()
{
  //Profile settings
  this->UpdateControllerID(ControllerID::GradientDescentOptimizerController);
  this->m_Description = "Optimizes by a gradient descent approach.";
};

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

        //Parameters
  profile.Parameters().AddParameter(cParam_LearningRate,CtrlProfile::Parameter::PVTDouble,cParamDsc_LearningRate,1,"20",-1,true);
  profile.Parameters().AddParameter(cParam_Iterations,Parameter::PVTULong,cParamDsc_Iterations,1,"100",-1,true);
};

void
GradientDescentOptimizerController::
ActualizeMainComponent(ComponentType* pMainComponent,
                       SessionComponentCache* pComponentCache, SessionInfo* pSessionInfo,
                                                                                         const unsigned int& iActLevel) const
{
  unsigned long lNrOfIterations;
  double dLearningRate;
  try
  {
    SessionAccessor::GetParameterValue(pComponentCache,cParam_Iterations,lNrOfIterations,0,iActLevel,true);
    SessionAccessor::GetParameterValue(pComponentCache,cParam_LearningRate,dLearningRate,0,iActLevel,true);
  }
  catchAllNPassMacro("Error while retrieving parameter values.");

  ParameterArrayType scales = this->GetTransformScales(pComponentCache,iActLevel);
  pMainComponent->SetScales(scales);

  pMainComponent->SetNumberOfIterations(lNrOfIterations);
  pMainComponent->SetLearningRate(dLearningRate);

  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
GradientDescentOptimizerController::
SetStatisticEntryMainComponent(StatisticEntry& rStatisticEntry,
                                             ComponentType* pMainComponent,
                                             SessionComponentCache* pMainComponentCache,
                                             SessionInfo* pSessionInfo,
                                             StatisticDictionary& rDictionary) const
{
  Superclass::SetStatisticEntryMainComponent(rStatisticEntry, pMainComponent, pMainComponentCache,
                                            pSessionInfo, rDictionary);
  std::string sName = "OptimizerValue";
  std::string sIDPath = pMainComponentCache->GetIDPath();
  StatisticValueDefinition* pEntry = rDictionary.GetValueDefinitionByName(sIDPath, sName);
    
  if (!pEntry) //Entry is not recorded yet, so do so.
  {
    pEntry = rDictionary.AddValueDefinition(sName, sIDPath, "Value of the optimizer");
  }

  rStatisticEntry.AddValue(Convert::ToStr(pMainComponent->GetValue()),pEntry->GetRefID());
};

GradientDescentOptimizerController::MeasuresType
GradientDescentOptimizerController::
GetCurrentValue(ComponentType* pOptimizer) const
{
        MeasuresType values(1);
        values.Fill(pOptimizer->GetValue());
        return values;
};

} //end of namespace free

---