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

namespace FREE
{



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

void
OnePlusOneEvolutionaryOptimizerController::
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,"0.01",-1,true);
  profile.Parameters().AddParameter("ShrinkFactor",CtrlProfile::Parameter::PVTDouble,"Shrink factor for the search radius.",1,"0.01",-1,true);
  profile.Parameters().AddParameter("InitialRadius",CtrlProfile::Parameter::PVTDouble,"Search radius in parameter space.",1,"1.0",-1,true);
  profile.Parameters().AddParameter("Epsilon",CtrlProfile::Parameter::PVTDouble,"Treshold of the vrobenius_norm for stopping optimization before hitting the maximum iterations.",1,"0.0001",-1,true);
  profile.Parameters().AddParameter(cParam_Iterations,Parameter::PVTInteger,cParamDsc_Iterations,1,"100",-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("VariateGeneratorBase");
        pOption->CheckForInheritance();
};

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

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

void
OnePlusOneEvolutionaryOptimizerController::
ActualizeMainComponent(ComponentType* pMainComponent,
                       SessionComponentCache* pComponentCache, SessionInfo* pSessionInfo,
                                                                                         const unsigned int& iActLevel) const
{
  double dGrowthFactor;
  double dShrinkFactor;
  double dInitialRadius;
  double dEpsilon;
  int iNrOfIterations;

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

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

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

  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
OnePlusOneEvolutionaryOptimizerController::
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());
};

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

} //end of namespace free

---