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

namespace FREE
{


DefineParameterMacro(ExhaustiveOptimizerController, StepLength, "StepLength", "Steplength of each step in each direction.");
DefineParameterMacro(ExhaustiveOptimizerController, NumberOfSteps, "NumberOfSteps", "Number of steps in each dimension along each direction. Thus there will be (2*NumberOfSteps)+1 steps in each dimension. One value per parameter.");

ExhaustiveOptimizerController::
ExhaustiveOptimizerController()
{
  //Profile settings
  this->UpdateControllerID(ControllerID::ExhaustiveOptimizerController);
  this->m_Description = "Optimizes by an exhaustive search along the specified grid.";
};

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

        //Parameters
  profile.Parameters().AddParameter(cParam_StepLength,CtrlProfile::Parameter::PVTDouble,cParamDsc_StepLength,1,"1",-1,true);
  profile.Parameters().AddParameter(cParam_NumberOfSteps,Parameter::PVTULong,cParamDsc_NumberOfSteps,1,"10",-1,true);
};

ExhaustiveOptimizerController::
~ExhaustiveOptimizerController()
{
};

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

  try
  {
    SessionAccessor::GetParameterValue(pComponentCache,cParam_StepLength,dStepLength,0,iActLevel,true);
  }
  catchAllNPassMacro("Error while retrieving parameter values.");
  pMainComponent->SetStepLength(dStepLength);

  ComponentType::StepsType steps;
  
  Parameter::Pointer smpSteps = SessionAccessor::GetParameter(pComponentCache,cParam_NumberOfSteps);
  if (smpSteps.IsNull()) throwCtrlExceptionMacro("","Error; missing Parameter, cannot get "<<cParam_NumberOfSteps<<".");
  if (smpSteps->LayerCount()==0) throwCtrlExceptionMacro("","Error; parameter "<<cParam_NumberOfSteps<<" has no layer. Please check if the setup is valid.");
  unsigned int i = iActLevel;
  if (i>=smpSteps->LayerCount()) i = smpSteps->LayerCount()-1;
  steps = Convert::ParameterLayerToArray<ComponentType::StepsType>(*(smpSteps->GetParameterLayer(i)));
  pMainComponent->SetNumberOfSteps(steps);

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

void
ExhaustiveOptimizerController::
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, "Current value of the optimizer");
  }

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

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

} //end of namespace free

---