FREE::OnePlusOneEvolutionarySOOptimizer Class Reference
[Setup optimization optimizer]

#include <freOnePlusOneEvolutionarySOOptimizer.h>

Inheritance diagram for FREE::OnePlusOneEvolutionarySOOptimizer:

[legend]

Collaboration diagram for FREE::OnePlusOneEvolutionarySOOptimizer:

[legend]

List of all members.

Public Types
typedef OnePlusOneEvolutionarySOOptimizer	Self
typedef SetupOptimizationOptimizer	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef itk::Statistics::RandomVariateGeneratorBase	NormalVariateGeneratorType
typedef itk::OnePlusOneEvolutionaryOptimizer	ItkOptimizerType
typedef ItkOptimizerType::Pointer	ItkOptimizerPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
void	SetMaximize (bool maximize)
virtual void	MaximizeOn ()
virtual void	MaximizeOff ()
void	SetMaximumIteration (unsigned int maximumIteration)
const unsigned int &	GetMaximumIteration () const
void	SetGrowthFactor (double growthFactor)
const double &	GetGrowthFactor () const
void	SetShrinkFactor (double shrinkFactor)
const double &	GetShrinkFactor () const
void	SetInitialRadius (double initialRadius)
const double &	GetInitialRadius () const
void	SetEpsilon (double epsilon)
const double &	GetEpsilon () const
const double &	GetFrobeniusNorm () const
virtual void	SetCostFunction (CostFunctionType *costFunction)
virtual void	SetInitialPosition (const ParametersType &param)
void	SetNormalVariateGenerator (NormalVariateGeneratorType *generator)
virtual const MeasureType &	GetCurrentChildValue () const
virtual const ParametersType &	GetCurrentChildPosition () const
void	Initialize (double initialRadius, double grow=-1, double shrink=-1)
virtual void	StartOptimization (void)
virtual void	StopOptimization ()
virtual bool	IsStoppable () const
ItkOptimizerType *	GetItkOptimizer ()
Static Public Member Functions
static Pointer	New (void)
Protected Types
typedef RegistrationObserverBase < itk::StartEvent >	StartObserver
typedef RegistrationObserverBase < itk::EndEvent >	EndObserver
Protected Member Functions
	OnePlusOneEvolutionarySOOptimizer ()
virtual	~OnePlusOneEvolutionarySOOptimizer ()
void	PrintSelf (std::ostream &os, itk::Indent indent) const
void	OnOptIteration (void *pSender, long threadID)
void	OnOptStart (void *pSender, long threadID)
void	OnOptEnd (void *pSender, long threadID)
Protected Attributes
IterationObserver::Pointer	m_IterationObserver
NotificationEvent < Self >::Pointer	m_IterationNotificationEvent
StartObserver::Pointer	m_StartObserver
NotificationEvent < Self >::Pointer	m_StartNotificationEvent
EndObserver::Pointer	m_EndObserver
NotificationEvent < Self >::Pointer	m_EndNotificationEvent
ItkOptimizerPointer	m_ItkOptimizer
ItkSingleValuedCostFunctionWrapper::Pointer	m_CostFunctionWrapper
MeasureType	m_CurrentChildValue
ParametersType	m_CurrentChildPosition
Private Member Functions
	OnePlusOneEvolutionarySOOptimizer (const Self &)
void	operator= (const Self &)

---

Detailed Description

Encapsulates the itk::OnePlusOneEvolutionaryOptimizer to utilize the optimization strategy for setup optimization.

Definition at line 40 of file freOnePlusOneEvolutionarySOOptimizer.h.

---

Member Typedef Documentation

typedef OnePlusOneEvolutionarySOOptimizer FREE::OnePlusOneEvolutionarySOOptimizer::Self

Standard "Self" typedef.

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 45 of file freOnePlusOneEvolutionarySOOptimizer.h.

typedef SetupOptimizationOptimizer FREE::OnePlusOneEvolutionarySOOptimizer::Superclass

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 46 of file freOnePlusOneEvolutionarySOOptimizer.h.

typedef itk::SmartPointer<Self> FREE::OnePlusOneEvolutionarySOOptimizer::Pointer

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 47 of file freOnePlusOneEvolutionarySOOptimizer.h.

typedef itk::SmartPointer<const Self> FREE::OnePlusOneEvolutionarySOOptimizer::ConstPointer

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 48 of file freOnePlusOneEvolutionarySOOptimizer.h.

typedef itk::Statistics::RandomVariateGeneratorBase FREE::OnePlusOneEvolutionarySOOptimizer::NormalVariateGeneratorType

Normal random variate generator type.

Definition at line 54 of file freOnePlusOneEvolutionarySOOptimizer.h.

typedef itk::OnePlusOneEvolutionaryOptimizer FREE::OnePlusOneEvolutionarySOOptimizer::ItkOptimizerType

Definition at line 110 of file freOnePlusOneEvolutionarySOOptimizer.h.

typedef ItkOptimizerType::Pointer FREE::OnePlusOneEvolutionarySOOptimizer::ItkOptimizerPointer

Definition at line 111 of file freOnePlusOneEvolutionarySOOptimizer.h.

typedef RegistrationObserverBase<itk::StartEvent> FREE::OnePlusOneEvolutionarySOOptimizer::StartObserver [protected]

Definition at line 127 of file freOnePlusOneEvolutionarySOOptimizer.h.

typedef RegistrationObserverBase<itk::EndEvent> FREE::OnePlusOneEvolutionarySOOptimizer::EndObserver [protected]

Definition at line 131 of file freOnePlusOneEvolutionarySOOptimizer.h.

---

Constructor & Destructor Documentation

FREE::OnePlusOneEvolutionarySOOptimizer::OnePlusOneEvolutionarySOOptimizer

(

)

[protected]

Definition at line 31 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References FREE::ItkSingleValuedCostFunctionWrapper::New().

Here is the call graph for this function:

FREE::OnePlusOneEvolutionarySOOptimizer::~OnePlusOneEvolutionarySOOptimizer

(

)

[protected, virtual]

Definition at line 60 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

FREE::OnePlusOneEvolutionarySOOptimizer::OnePlusOneEvolutionarySOOptimizer

(

const Self &

)

[private]

---

Member Function Documentation

virtual const char* FREE::OnePlusOneEvolutionarySOOptimizer::GetNameOfClass

(

)

const [inline, virtual]

Run-time type information (and related methods).

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 51 of file freOnePlusOneEvolutionarySOOptimizer.h.

static Pointer FREE::OnePlusOneEvolutionarySOOptimizer::New

(

void

)

[inline, static]

Method for creation through the object factory.

Definition at line 54 of file freOnePlusOneEvolutionarySOOptimizer.h.

virtual ::itk::LightObject::Pointer FREE::OnePlusOneEvolutionarySOOptimizer::CreateAnother

(

void

)

const [inline, virtual]

Definition at line 54 of file freOnePlusOneEvolutionarySOOptimizer.h.

void FREE::OnePlusOneEvolutionarySOOptimizer::SetMaximize

(

bool

maximize

)

Set if the Optimizer should maximize the metric

Definition at line 66 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References m_ItkOptimizer.

virtual void FREE::OnePlusOneEvolutionarySOOptimizer::MaximizeOn

(

)

[inline, virtual]

Definition at line 61 of file freOnePlusOneEvolutionarySOOptimizer.h.

virtual void FREE::OnePlusOneEvolutionarySOOptimizer::MaximizeOff

(

)

[inline, virtual]

Definition at line 61 of file freOnePlusOneEvolutionarySOOptimizer.h.

void FREE::OnePlusOneEvolutionarySOOptimizer::SetMaximumIteration

(

unsigned int

maximumIteration

)

Set/Get maximum iteration limit.

Definition at line 74 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References m_ItkOptimizer.

const unsigned int & FREE::OnePlusOneEvolutionarySOOptimizer::GetMaximumIteration

(

)

const

Definition at line 82 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References m_ItkOptimizer.

Referenced by PrintSelf().

void FREE::OnePlusOneEvolutionarySOOptimizer::SetGrowthFactor

(

double

growthFactor

)

Set/Get the search radius grow factor in parameter space.

Definition at line 89 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References m_ItkOptimizer.

const double & FREE::OnePlusOneEvolutionarySOOptimizer::GetGrowthFactor

(

)

const

Definition at line 97 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References m_ItkOptimizer.

Referenced by PrintSelf().

void FREE::OnePlusOneEvolutionarySOOptimizer::SetShrinkFactor

(

double

shrinkFactor

)

Set/Get the search radius shrink factor.

Definition at line 104 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References m_ItkOptimizer.

const double & FREE::OnePlusOneEvolutionarySOOptimizer::GetShrinkFactor

(

)

const

Definition at line 112 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References m_ItkOptimizer.

Referenced by PrintSelf().

void FREE::OnePlusOneEvolutionarySOOptimizer::SetInitialRadius

(

double

initialRadius

)

Set/Get initial search radius in parameter space

Definition at line 119 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References m_ItkOptimizer.

const double & FREE::OnePlusOneEvolutionarySOOptimizer::GetInitialRadius

(

)

const

Definition at line 127 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References m_ItkOptimizer.

Referenced by PrintSelf().

void FREE::OnePlusOneEvolutionarySOOptimizer::SetEpsilon

(

double

epsilon

)

Set/Get the minimal size of search radius (frobenius_norm of covariance matrix).

Definition at line 134 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References m_ItkOptimizer.

const double & FREE::OnePlusOneEvolutionarySOOptimizer::GetEpsilon

(

)

const

Definition at line 142 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References m_ItkOptimizer.

Referenced by PrintSelf().

const double & FREE::OnePlusOneEvolutionarySOOptimizer::GetFrobeniusNorm

(

)

const

Get the current Frobenius norm of covariance matrix

Definition at line 149 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References m_ItkOptimizer.

void FREE::OnePlusOneEvolutionarySOOptimizer::SetCostFunction

(

CostFunctionType *

costFunction

)

[virtual]

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 156 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References m_CostFunctionWrapper, m_ItkOptimizer, and FREE::SetupOptimizationOptimizer::SetCostFunction().

Here is the call graph for this function:

void FREE::OnePlusOneEvolutionarySOOptimizer::SetInitialPosition

(

const ParametersType &

param

)

[virtual]

Definition at line 165 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References m_ItkOptimizer.

void FREE::OnePlusOneEvolutionarySOOptimizer::SetNormalVariateGenerator

(

NormalVariateGeneratorType *

generator

)

Definition at line 173 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References m_ItkOptimizer.

virtual const MeasureType& FREE::OnePlusOneEvolutionarySOOptimizer::GetCurrentChildValue

(

)

const [inline, virtual]

Definition at line 93 of file freOnePlusOneEvolutionarySOOptimizer.h.

virtual const ParametersType& FREE::OnePlusOneEvolutionarySOOptimizer::GetCurrentChildPosition

(

)

const [inline, virtual]

Definition at line 94 of file freOnePlusOneEvolutionarySOOptimizer.h.

void FREE::OnePlusOneEvolutionarySOOptimizer::Initialize	(	double	initialRadius,
		double	grow = -1,
		double	shrink = -1
	)

Initializes the optimizer. Before running this optimizer, this function should have been called.

initialRadius: search radius in parameter space grow: search radius grow factor shrink: searhc radius shrink factor

Definition at line 181 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References m_ItkOptimizer.

void FREE::OnePlusOneEvolutionarySOOptimizer::StartOptimization

(

void

)

[virtual]

Implements FREE::SetupOptimizationOptimizer.

Definition at line 203 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References FREE::SetupOptimizationOptimizer::m_BestPosition, FREE::SetupOptimizationOptimizer::m_BestValue, FREE::SetupOptimizationOptimizer::m_CostFunction, m_CurrentChildPosition, m_CurrentChildValue, FREE::SetupOptimizationOptimizer::m_CurrentDecomposedValue, FREE::SetupOptimizationOptimizer::m_CurrentValue, and m_ItkOptimizer.

void FREE::OnePlusOneEvolutionarySOOptimizer::StopOptimization

(

void

)

[virtual]

Stops the ongoing optimization process.

Returns:

Indicates of the optimizer was sucessfully stopped.

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 224 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References m_ItkOptimizer.

bool FREE::OnePlusOneEvolutionarySOOptimizer::IsStoppable

(

)

const [virtual]

Indicates if the optimizer can be stopped.

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 231 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

OnePlusOneEvolutionarySOOptimizer::ItkOptimizerType * FREE::OnePlusOneEvolutionarySOOptimizer::GetItkOptimizer

(

)

Definition at line 238 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References m_ItkOptimizer.

void FREE::OnePlusOneEvolutionarySOOptimizer::PrintSelf	(	std::ostream &	os,
		itk::Indent	indent
	)			const [protected]

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 188 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References GetEpsilon(), GetGrowthFactor(), GetInitialRadius(), GetMaximumIteration(), GetShrinkFactor(), m_ItkOptimizer, and FREE::SetupOptimizationOptimizer::PrintSelf().

Here is the call graph for this function:

void FREE::OnePlusOneEvolutionarySOOptimizer::OnOptIteration	(	void *	pSender,
		long	threadID
	)			[protected]

Definition at line 245 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

References FREE::SetupOptimizationOptimizer::m_BestPosition, FREE::SetupOptimizationOptimizer::m_BestValue, FREE::SetupOptimizationOptimizer::m_CostFunction, m_CurrentChildPosition, m_CurrentChildValue, FREE::SetupOptimizationOptimizer::m_CurrentDecomposedValue, FREE::SetupOptimizationOptimizer::m_CurrentValue, and m_ItkOptimizer.

void FREE::OnePlusOneEvolutionarySOOptimizer::OnOptStart	(	void *	pSender,
		long	threadID
	)			[protected]

Definition at line 262 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

void FREE::OnePlusOneEvolutionarySOOptimizer::OnOptEnd	(	void *	pSender,
		long	threadID
	)			[protected]

Definition at line 270 of file freOnePlusOneEvolutionarySOOptimizer.cxx.

void FREE::OnePlusOneEvolutionarySOOptimizer::operator=

(

const Self &

)

[private]

---

Member Data Documentation

IterationObserver::Pointer FREE::OnePlusOneEvolutionarySOOptimizer::m_IterationObserver [protected]

Definition at line 124 of file freOnePlusOneEvolutionarySOOptimizer.h.

NotificationEvent<Self>::Pointer FREE::OnePlusOneEvolutionarySOOptimizer::m_IterationNotificationEvent [protected]

Definition at line 125 of file freOnePlusOneEvolutionarySOOptimizer.h.

StartObserver::Pointer FREE::OnePlusOneEvolutionarySOOptimizer::m_StartObserver [protected]

Definition at line 128 of file freOnePlusOneEvolutionarySOOptimizer.h.

NotificationEvent<Self>::Pointer FREE::OnePlusOneEvolutionarySOOptimizer::m_StartNotificationEvent [protected]

Definition at line 129 of file freOnePlusOneEvolutionarySOOptimizer.h.

EndObserver::Pointer FREE::OnePlusOneEvolutionarySOOptimizer::m_EndObserver [protected]

Definition at line 132 of file freOnePlusOneEvolutionarySOOptimizer.h.

NotificationEvent<Self>::Pointer FREE::OnePlusOneEvolutionarySOOptimizer::m_EndNotificationEvent [protected]

Definition at line 133 of file freOnePlusOneEvolutionarySOOptimizer.h.

ItkOptimizerPointer FREE::OnePlusOneEvolutionarySOOptimizer::m_ItkOptimizer [protected]

Definition at line 135 of file freOnePlusOneEvolutionarySOOptimizer.h.

Referenced by GetEpsilon(), GetFrobeniusNorm(), GetGrowthFactor(), GetInitialRadius(), GetItkOptimizer(), GetMaximumIteration(), GetShrinkFactor(), Initialize(), OnOptIteration(), PrintSelf(), SetCostFunction(), SetEpsilon(), SetGrowthFactor(), SetInitialPosition(), SetInitialRadius(), SetMaximize(), SetMaximumIteration(), SetNormalVariateGenerator(), SetShrinkFactor(), StartOptimization(), and StopOptimization().

ItkSingleValuedCostFunctionWrapper::Pointer FREE::OnePlusOneEvolutionarySOOptimizer::m_CostFunctionWrapper [protected]

Definition at line 136 of file freOnePlusOneEvolutionarySOOptimizer.h.

Referenced by SetCostFunction().

MeasureType FREE::OnePlusOneEvolutionarySOOptimizer::m_CurrentChildValue [mutable, protected]

Definition at line 138 of file freOnePlusOneEvolutionarySOOptimizer.h.

Referenced by OnOptIteration(), and StartOptimization().

ParametersType FREE::OnePlusOneEvolutionarySOOptimizer::m_CurrentChildPosition [mutable, protected]

Definition at line 139 of file freOnePlusOneEvolutionarySOOptimizer.h.

Referenced by OnOptIteration(), and StartOptimization().

---

The documentation for this class was generated from the following files:

• freOnePlusOneEvolutionarySOOptimizer.h
• freOnePlusOneEvolutionarySOOptimizer.cxx

---