freOnePlusOneEvolutionarySOOptimizerController.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: freOnePlusOneEvolutionarySOOptimizerController.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 "freOnePlusOneEvolutionarySOOptimizerController.h"

#include "freExceptions.h"
#include "freNormalVariateGeneratorController.h"

namespace FREE
{




OnePlusOneEvolutionarySOOptimizerController::
OnePlusOneEvolutionarySOOptimizerController()
{
  //Profile settings
  this->UpdateControllerID(ControllerID::OnePlusOneEvolutionarySOOptimizerController);
  this->m_Description = "Optimizes registration setups by a 1+1-evolutionary approach.";
};

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

        //Parameters
  profile.Parameters().AddParameter("GrowthFactor",CtrlProfile::Parameter::PVTDouble,"Growth factor for the search radius.",1,"1.05",-1,true);
  profile.Parameters().AddParameter("ShrinkFactor",CtrlProfile::Parameter::PVTDouble,"Shrink factor for the search radius.",1,"0.98",-1,true);
  profile.Parameters().AddParameter("InitialRadius",CtrlProfile::Parameter::PVTDouble,"Search radius in parameter space.",1,"1.01",-1,true);
  profile.Parameters().AddParameter("Epsilon",CtrlProfile::Parameter::PVTDouble,"Treshold of the frobenius_norm for stopping optimization before hitting the maximum iterations.",1,"0.0001",-1,true);
  profile.Parameters().AddParameter(cParam_Iterations,Parameter::PVTInteger,cParamDsc_Iterations,1,"500",-1,true);

  //Subcomponents
  profile.SubComponents().AddSubComponent("VariateGenerator",1,"Normal Variate Generator");

  //Requirements
        CtrlProfile::ProfileOption* pOption;
    //metric
        pOption = profile.Requirements().AddRequirement("VariateGenerator")->AddProfileOption();
        pOption->Inheritance().AddAncestor(ControllerID::VariateGeneratorControllerBase);
        pOption->CheckForInheritance();
};

GenericComponentType*
OnePlusOneEvolutionarySOOptimizerController::
GetSubComponentCasted(ComponentType* pMainComponent, const ComponentID& compID,
                      SessionComponentCache* pMainComponentCache) const
{
        if (compID == "VariateGenerator") throwCtrlExceptionMacro("","1+1 evolutionary optimizer has no getter function for variate generator. Use session to retrieve component.");
        return Superclass::GetSubComponentCasted(pMainComponent, compID, pMainComponentCache);
}; 

void
OnePlusOneEvolutionarySOOptimizerController::
SetSubComponentCasted(GenericComponentType* pSubComponent,
                                                                                                                                                 ComponentType* pMainComponent,
                                                                                                                                                 const ComponentID compID,
                                     SessionComponentCache* pMainComponentCache) const
{
        if (compID == "VariateGenerator") pMainComponent->SetNormalVariateGenerator(dynamic_cast<OnePlusOneEvolutionarySOOptimizer::NormalVariateGeneratorType*>(pSubComponent));
  else Superclass::SetSubComponentCasted(pSubComponent, pMainComponent, compID, pMainComponentCache);
};

long
OnePlusOneEvolutionarySOOptimizerController::
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
OnePlusOneEvolutionarySOOptimizerController::
ActualizeMainComponent(ComponentType* pMainComponent,
                       SessionComponentCache* pComponentCache, SessionInfo* pSessionInfo,
                                                                                         const unsigned int& iActLevel) const
{
        Superclass::ActualizeMainComponent(pMainComponent, pComponentCache,
                                                                                                                                                 pSessionInfo, iActLevel);

  double dGrowthFactor;
  double dShrinkFactor;
  double dInitialRadius;
  double dEpsilon;
  int iNrOfIterations;

  try
  {
    SessionAccessor::GetParameterValue(pComponentCache,"GrowthFactor",dGrowthFactor);
    SessionAccessor::GetParameterValue(pComponentCache,"ShrinkFactor",dShrinkFactor);
    SessionAccessor::GetParameterValue(pComponentCache,"InitialRadius",dInitialRadius);
    SessionAccessor::GetParameterValue(pComponentCache,"Epsilon",dEpsilon);
    SessionAccessor::GetParameterValue(pComponentCache,cParam_Iterations,iNrOfIterations);
  }
  catchAllNPassMacro("Error while retrieving parameter values.");    

  pMainComponent->SetMaximumIteration(iNrOfIterations);
  pMainComponent->SetEpsilon(dEpsilon);
  pMainComponent->Initialize (dInitialRadius, dGrowthFactor, dShrinkFactor);

        //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
OnePlusOneEvolutionarySOOptimizerController::
SetStatisticEntryMainComponent(StatisticEntry& rStatisticEntry,
                                             ComponentType* pMainComponent,
                                             SessionComponentCache* pMainComponentCache,
                                             SessionInfo* pSessionInfo,
                                             StatisticDictionary& rDictionary) const
{
        ParameterArrayType parameters = pMainComponent->GetCurrentChildPosition();

  std::string sName = "Position #";
  std::string sIDPath = pMainComponentCache->GetIDPath();
  std::string sCommment = "Optimizer position of the current child. 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,"Frobius Norm", "Indicates the current search radius of the optimizer");
    rDictionary.AddValueDefinition(sIDPath,"OptimizerChildValue", "Composed value of the current child position");
    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->GetFrobeniusNorm()),pEntry->GetRefID()+parameters.Size());
  rStatisticEntry.AddValue(Convert::ToStr(pMainComponent->GetCurrentChildValue()),pEntry->GetRefID()+parameters.Size()+1);
  rStatisticEntry.AddValue(Convert::ToStr(pMainComponent->GetCurrentValue()),pEntry->GetRefID()+parameters.Size()+2);
};

void
OnePlusOneEvolutionarySOOptimizerController::
SetStatisticEntrySubComponents(StatisticEntry& rStatisticEntry, SessionComponentCache* pComponentCache,
                              SessionInfo* pSessionInfo, StatisticDictionary& rDictionary) const
{
        //there are no subcomponents that should set statistics and function behaviour
        //of superclass raises an exception, because it tries to receive the variate generator
        //as a subcomponent.
};

} //end of namespace free

---