freOnePlusOneEvolutionarySOOptimizer.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: freOnePlusOneEvolutionarySOOptimizer.h,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 "freOnePlusOneEvolutionarySOOptimizer.h"
#include "itkCommand.h"
#include "itkEventObject.h"

namespace FREE
{

OnePlusOneEvolutionarySOOptimizer
::OnePlusOneEvolutionarySOOptimizer()
{
        m_ItkOptimizer = ItkOptimizerType::New();
        m_CostFunctionWrapper = ItkSingleValuedCostFunctionWrapper::New();

        this->SetMaximize(false);
        this->SetMaximumIteration(500);
        this->SetGrowthFactor(1.05);
        this->SetShrinkFactor(pow(1.05, -0.25));
        this->SetInitialRadius(1.01);
        this->SetEpsilon((double) 1.5e-4);

        m_IterationObserver = IterationObserver::New();
        m_IterationNotificationEvent = NotificationEvent<Self>::New(this, &Self::OnOptIteration);
        m_IterationObserver->fnOnNotify = m_IterationNotificationEvent;
        m_ItkOptimizer->AddObserver(itk::IterationEvent(), m_IterationObserver);

        m_StartObserver = StartObserver::New();
        m_StartNotificationEvent = NotificationEvent<Self>::New(this, &Self::OnOptStart);
        m_StartObserver->fnOnNotify = m_StartNotificationEvent;
        m_ItkOptimizer->AddObserver(itk::StartEvent(), m_StartObserver);

        m_EndObserver = EndObserver::New();
        m_EndNotificationEvent = NotificationEvent<Self>::New(this, &Self::OnOptEnd);
        m_EndObserver->fnOnNotify = m_EndNotificationEvent;
        m_ItkOptimizer->AddObserver(itk::EndEvent(), m_EndObserver);
}

OnePlusOneEvolutionarySOOptimizer
::~OnePlusOneEvolutionarySOOptimizer()
{
}

void
OnePlusOneEvolutionarySOOptimizer::
SetMaximize(bool maximize)
{
        m_ItkOptimizer->SetMaximize(maximize);
        this->Modified();
};

void
OnePlusOneEvolutionarySOOptimizer::
SetMaximumIteration(unsigned int maximumIteration)
{
        m_ItkOptimizer->SetMaximumIteration(maximumIteration);
        this->Modified();
};

const unsigned int&
OnePlusOneEvolutionarySOOptimizer::
GetMaximumIteration() const
{
        return m_ItkOptimizer->GetMaximumIteration();
};

void
OnePlusOneEvolutionarySOOptimizer::
SetGrowthFactor(double growthFactor)
{
        m_ItkOptimizer->SetGrowthFactor(growthFactor);
        this->Modified();
};

const double&
OnePlusOneEvolutionarySOOptimizer::
GetGrowthFactor() const
{
        return m_ItkOptimizer->GetGrowthFactor();
};

void
OnePlusOneEvolutionarySOOptimizer::
SetShrinkFactor(double shrinkFactor)
{
        m_ItkOptimizer->SetShrinkFactor(shrinkFactor);
        this->Modified();
};

const double&
OnePlusOneEvolutionarySOOptimizer::
GetShrinkFactor() const
{
        return m_ItkOptimizer->GetShrinkFactor();
};

void
OnePlusOneEvolutionarySOOptimizer::
SetInitialRadius(double initialRadius)
{
        m_ItkOptimizer->SetInitialRadius(initialRadius);
        this->Modified();
};

const double&
OnePlusOneEvolutionarySOOptimizer::
GetInitialRadius() const
{
        return m_ItkOptimizer->GetInitialRadius();
};

void
OnePlusOneEvolutionarySOOptimizer::
SetEpsilon(double epsilon)
{
        m_ItkOptimizer->SetEpsilon(epsilon);
        this->Modified();
};

const double&
OnePlusOneEvolutionarySOOptimizer::
GetEpsilon() const
{
        return m_ItkOptimizer->GetEpsilon();
};

const double&
OnePlusOneEvolutionarySOOptimizer::
GetFrobeniusNorm() const
{
        return m_ItkOptimizer->GetFrobeniusNorm();
};

void
OnePlusOneEvolutionarySOOptimizer::
SetCostFunction( CostFunctionType * costFunction )
{
        Superclass::SetCostFunction(costFunction);
        m_CostFunctionWrapper->SetWrappedCostFunction(costFunction);
        m_ItkOptimizer->SetCostFunction(m_CostFunctionWrapper);
};

void
OnePlusOneEvolutionarySOOptimizer::
SetInitialPosition (const ParametersType &param)
{
        Superclass::SetInitialPosition(param);
        m_ItkOptimizer->SetInitialPosition(param);
};

void
OnePlusOneEvolutionarySOOptimizer::
SetNormalVariateGenerator(NormalVariateGeneratorType* generator)
{
        m_ItkOptimizer->SetNormalVariateGenerator(generator);
        this->Modified();
};

void
OnePlusOneEvolutionarySOOptimizer::
Initialize(double initialRadius, double grow, double shrink)
{
        m_ItkOptimizer->Initialize(initialRadius, grow, shrink);
};

void
OnePlusOneEvolutionarySOOptimizer
::PrintSelf(std::ostream& os, itk::Indent indent) const
{
  Superclass::PrintSelf(os,indent);

  os << indent << "Maximum Iteration " << GetMaximumIteration() << std::endl;
  os << indent << "Epsilon           " << GetEpsilon()          << std::endl;
  os << indent << "Initial Radius    " << GetInitialRadius()    << std::endl;
  os << indent << "Growth Fractor    " << GetGrowthFactor()     << std::endl;
  os << indent << "Shrink Fractor    " << GetShrinkFactor()     << std::endl;
  os << indent << "Current Cost      " << this->m_ItkOptimizer->GetCurrentCost()     << std::endl;
        os << indent << "Current Iteration " << this->m_ItkOptimizer->GetCurrentIteration() << std::endl;
}

void
OnePlusOneEvolutionarySOOptimizer
::StartOptimization( void )
{
        this->m_ItkOptimizer->SetScales(this->GetScales());
        this->m_ItkOptimizer->StartOptimization();

        //for 1+1 optimizer the most recent individual is allways the fittest.
        //to achieve proper handling of optimizations with 0 generations
        //(thus no iteration events) the values are also set at the end of
        //the optimization process explicitly.
        this->m_CurrentValue = this->m_ItkOptimizer->GetCurrentCost();
        this->m_CurrentChildValue = this->m_CostFunction->GetCurrentValue();
        this->m_CurrentDecomposedValue = this->m_CostFunction->GetCurrentDecomposedValue();
        this->SetCurrentPosition(this->m_ItkOptimizer->GetCurrentPosition());
        this->m_CurrentChildPosition = this->m_CostFunction->GetCurrentParameters();

        m_BestValue = m_CurrentValue;
        m_BestPosition = this->m_ItkOptimizer->GetCurrentPosition();
}

void
OnePlusOneEvolutionarySOOptimizer
::StopOptimization( void )
{
        this->m_ItkOptimizer->StopOptimization();
}

bool
OnePlusOneEvolutionarySOOptimizer
::IsStoppable() const
{
  return true;
};

OnePlusOneEvolutionarySOOptimizer::ItkOptimizerType * 
OnePlusOneEvolutionarySOOptimizer
::GetItkOptimizer()
{
  return m_ItkOptimizer;
}

void
OnePlusOneEvolutionarySOOptimizer::
OnOptIteration(void* pSender, long threadID)
{
        this->m_CurrentValue = this->m_ItkOptimizer->GetCurrentCost();
        this->m_CurrentChildValue = this->m_CostFunction->GetCurrentValue();
        this->m_CurrentDecomposedValue = this->m_CostFunction->GetCurrentDecomposedValue();
        this->SetCurrentPosition(this->m_ItkOptimizer->GetCurrentPosition());
        this->m_CurrentChildPosition = this->m_CostFunction->GetCurrentParameters();

        m_BestValue = m_CurrentValue;
        m_BestPosition = this->m_ItkOptimizer->GetCurrentPosition();
        
        //and pass the signal to the rest of the world
        this->InvokeEvent( itk::IterationEvent() );
};

void
OnePlusOneEvolutionarySOOptimizer::
OnOptStart(void* pSender, long threadID)
{
        //just pass the signal to the rest of the world
        this->InvokeEvent( itk::StartEvent() );
};
  
void
OnePlusOneEvolutionarySOOptimizer::
OnOptEnd(void* pSender, long threadID)
{
        //just pass the signal to the rest of the world
        this->InvokeEvent( itk::EndEvent() );
};

} // end namespace FREE

---