FREE::SPSASOOptimizer Class Reference
[Setup optimization optimizer]

#include <freSPSASOOptimizer.h>

Inheritance diagram for FREE::SPSASOOptimizer:

[legend]

Collaboration diagram for FREE::SPSASOOptimizer:

[legend]

List of all members.

Public Types
typedef SPSASOOptimizer	Self
typedef SetupOptimizationOptimizer	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef itk::SPSAOptimizer	ItkOptimizerType
typedef ItkOptimizerType::Pointer	ItkOptimizerPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual void	GuessParameters (unsigned long numberOfGradientEstimates, double initialStepSize)
virtual void	SetValueUpdateRate (const long _arg)
virtual long	GetValueUpdateRate () const
virtual unsigned long	GetCurrentIteration () const
virtual itk::SPSAOptimizer::StopConditionType	GetStopCondition () const
virtual double	GetLearningRate () const
virtual double	GetGradientMagnitude () const
virtual const itk::SPSAOptimizer::DerivativeType &	GetGradient () const
virtual void	Seta (const double _arg)
virtual double	Geta () const
virtual void	Setc (const double _arg)
virtual double	Getc () const
virtual void	SetA (const double _arg)
virtual double	GetA () const
virtual void	SetAlpha (const double _arg)
virtual double	GetAlpha () const
virtual void	SetGamma (const double _arg)
virtual double	GetGamma () const
virtual bool	GetMaximize () const
virtual void	SetMaximize (const bool _arg)
void	MaximizeOn ()
void	MaximizeOff ()
bool	GetMinimize () const
void	SetMinimize (bool v)
void	MinimizeOn ()
void	MinimizeOff ()
virtual void	SetNumberOfPerturbations (const unsigned long _arg)
virtual unsigned long	GetNumberOfPerturbations () const
virtual double	GetStateOfConvergence () const
virtual void	SetStateOfConvergenceDecayRate (const double _arg)
virtual double	GetStateOfConvergenceDecayRate () const
virtual void	SetMinimumNumberOfIterations (const unsigned long _arg)
virtual unsigned long	GetMinimumNumberOfIterations () const
virtual void	SetMaximumNumberOfIterations (const unsigned long _arg)
virtual unsigned long	GetMaximumNumberOfIterations () const
virtual void	SetTolerance (const double _arg)
virtual double	GetTolerance () const
virtual void	SetCostFunction (CostFunctionType *costFunction)
virtual void	SetInitialPosition (const ParametersType &param)
virtual void	StartOptimization (void)
virtual bool	IsStoppable () const
virtual void	StopOptimization ()
virtual bool	IsResumeable () const
virtual void	ResumeOptimization ()
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
	SPSASOOptimizer ()
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
long	m_ValueUpdateRate
Private Member Functions
	SPSASOOptimizer (const Self &)
void	operator= (const Self &)

---

Detailed Description

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

Definition at line 59 of file freSPSASOOptimizer.h.

---

Member Typedef Documentation

typedef SPSASOOptimizer FREE::SPSASOOptimizer::Self

Standard "Self" typedef.

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 64 of file freSPSASOOptimizer.h.

typedef SetupOptimizationOptimizer FREE::SPSASOOptimizer::Superclass

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 65 of file freSPSASOOptimizer.h.

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

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 66 of file freSPSASOOptimizer.h.

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

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 67 of file freSPSASOOptimizer.h.

typedef itk::SPSAOptimizer FREE::SPSASOOptimizer::ItkOptimizerType

Definition at line 162 of file freSPSASOOptimizer.h.

typedef ItkOptimizerType::Pointer FREE::SPSASOOptimizer::ItkOptimizerPointer

Definition at line 163 of file freSPSASOOptimizer.h.

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

Definition at line 178 of file freSPSASOOptimizer.h.

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

Definition at line 182 of file freSPSASOOptimizer.h.

---

Constructor & Destructor Documentation

FREE::SPSASOOptimizer::SPSASOOptimizer

(

)

[protected]

Definition at line 31 of file freSPSASOOptimizer.cxx.

References FREE::ItkSingleValuedCostFunctionWrapper::New().

Here is the call graph for this function:

FREE::SPSASOOptimizer::SPSASOOptimizer

(

const Self &

)

[private]

---

Member Function Documentation

virtual const char* FREE::SPSASOOptimizer::GetNameOfClass

(

)

const [inline, virtual]

Run-time type information (and related methods).

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 70 of file freSPSASOOptimizer.h.

static Pointer FREE::SPSASOOptimizer::New

(

void

)

[inline, static]

Method for creation through the object factory.

Definition at line 73 of file freSPSASOOptimizer.h.

virtual ::itk::LightObject::Pointer FREE::SPSASOOptimizer::CreateAnother

(

void

)

const [inline, virtual]

Definition at line 73 of file freSPSASOOptimizer.h.

void FREE::SPSASOOptimizer::GuessParameters	(	unsigned long	numberOfGradientEstimates,
		double	initialStepSize
	)			[virtual]

Definition at line 58 of file freSPSASOOptimizer.cxx.

References m_ItkOptimizer.

virtual void FREE::SPSASOOptimizer::SetValueUpdateRate

(

const long

_arg

)

[inline, virtual]

Set/Get a.

Definition at line 79 of file freSPSASOOptimizer.h.

virtual long FREE::SPSASOOptimizer::GetValueUpdateRate

(

)

const [inline, virtual]

Definition at line 80 of file freSPSASOOptimizer.h.

virtual unsigned long FREE::SPSASOOptimizer::GetCurrentIteration

(

)

const [inline, virtual]

Get the current iteration number.

Definition at line 83 of file freSPSASOOptimizer.h.

virtual itk::SPSAOptimizer::StopConditionType FREE::SPSASOOptimizer::GetStopCondition

(

)

const [inline, virtual]

Get Stop condition.

Definition at line 85 of file freSPSASOOptimizer.h.

virtual double FREE::SPSASOOptimizer::GetLearningRate

(

)

const [inline, virtual]

Get the current LearningRate (a_k)

Definition at line 87 of file freSPSASOOptimizer.h.

virtual double FREE::SPSASOOptimizer::GetGradientMagnitude

(

)

const [inline, virtual]

Get the GradientMagnitude of the latest computed gradient

Definition at line 89 of file freSPSASOOptimizer.h.

virtual const itk::SPSAOptimizer::DerivativeType& FREE::SPSASOOptimizer::GetGradient

(

)

const [inline, virtual]

Get the latest computed gradient

Definition at line 91 of file freSPSASOOptimizer.h.

virtual void FREE::SPSASOOptimizer::Seta

(

const double

_arg

)

[inline, virtual]

Set/Get a.

Definition at line 94 of file freSPSASOOptimizer.h.

virtual double FREE::SPSASOOptimizer::Geta

(

)

const [inline, virtual]

Definition at line 95 of file freSPSASOOptimizer.h.

virtual void FREE::SPSASOOptimizer::Setc

(

const double

_arg

)

[inline, virtual]

Set/Get c.

Definition at line 98 of file freSPSASOOptimizer.h.

virtual double FREE::SPSASOOptimizer::Getc

(

)

const [inline, virtual]

Definition at line 99 of file freSPSASOOptimizer.h.

virtual void FREE::SPSASOOptimizer::SetA

(

const double

_arg

)

[inline, virtual]

Set/Get A.

Definition at line 102 of file freSPSASOOptimizer.h.

virtual double FREE::SPSASOOptimizer::GetA

(

)

const [inline, virtual]

Definition at line 103 of file freSPSASOOptimizer.h.

virtual void FREE::SPSASOOptimizer::SetAlpha

(

const double

_arg

)

[inline, virtual]

Set/Get alpha.

Definition at line 106 of file freSPSASOOptimizer.h.

virtual double FREE::SPSASOOptimizer::GetAlpha

(

)

const [inline, virtual]

Definition at line 107 of file freSPSASOOptimizer.h.

virtual void FREE::SPSASOOptimizer::SetGamma

(

const double

_arg

)

[inline, virtual]

Set/Get gamma.

Definition at line 110 of file freSPSASOOptimizer.h.

virtual double FREE::SPSASOOptimizer::GetGamma

(

)

const [inline, virtual]

Definition at line 111 of file freSPSASOOptimizer.h.

virtual bool FREE::SPSASOOptimizer::GetMaximize

(

)

const [inline, virtual]

Methods to configure the cost function.

Definition at line 114 of file freSPSASOOptimizer.h.

virtual void FREE::SPSASOOptimizer::SetMaximize

(

const bool

_arg

)

[inline, virtual]

Definition at line 115 of file freSPSASOOptimizer.h.

void FREE::SPSASOOptimizer::MaximizeOn

(

)

[inline]

Definition at line 116 of file freSPSASOOptimizer.h.

void FREE::SPSASOOptimizer::MaximizeOff

(

)

[inline]

Definition at line 118 of file freSPSASOOptimizer.h.

bool FREE::SPSASOOptimizer::GetMinimize

(

)

const [inline]

Definition at line 120 of file freSPSASOOptimizer.h.

void FREE::SPSASOOptimizer::SetMinimize

(

bool

v

)

[inline]

Definition at line 122 of file freSPSASOOptimizer.h.

void FREE::SPSASOOptimizer::MinimizeOn

(

)

[inline]

Definition at line 124 of file freSPSASOOptimizer.h.

void FREE::SPSASOOptimizer::MinimizeOff

(

)

[inline]

Definition at line 126 of file freSPSASOOptimizer.h.

virtual void FREE::SPSASOOptimizer::SetNumberOfPerturbations

(

const unsigned long

_arg

)

[inline, virtual]

Definition at line 129 of file freSPSASOOptimizer.h.

virtual unsigned long FREE::SPSASOOptimizer::GetNumberOfPerturbations

(

)

const [inline, virtual]

Definition at line 130 of file freSPSASOOptimizer.h.

virtual double FREE::SPSASOOptimizer::GetStateOfConvergence

(

)

const [inline, virtual]

Definition at line 132 of file freSPSASOOptimizer.h.

virtual void FREE::SPSASOOptimizer::SetStateOfConvergenceDecayRate

(

const double

_arg

)

[inline, virtual]

Set/Get StateOfConvergenceDecayRate (number between 0 and 1).

Definition at line 135 of file freSPSASOOptimizer.h.

virtual double FREE::SPSASOOptimizer::GetStateOfConvergenceDecayRate

(

)

const [inline, virtual]

Definition at line 136 of file freSPSASOOptimizer.h.

virtual void FREE::SPSASOOptimizer::SetMinimumNumberOfIterations

(

const unsigned long

_arg

)

[inline, virtual]

Set/Get the minimum number of iterations

Definition at line 139 of file freSPSASOOptimizer.h.

virtual unsigned long FREE::SPSASOOptimizer::GetMinimumNumberOfIterations

(

)

const [inline, virtual]

Definition at line 140 of file freSPSASOOptimizer.h.

virtual void FREE::SPSASOOptimizer::SetMaximumNumberOfIterations

(

const unsigned long

_arg

)

[inline, virtual]

Set/Get the maximum number of iterations.

Definition at line 143 of file freSPSASOOptimizer.h.

virtual unsigned long FREE::SPSASOOptimizer::GetMaximumNumberOfIterations

(

)

const [inline, virtual]

Definition at line 144 of file freSPSASOOptimizer.h.

virtual void FREE::SPSASOOptimizer::SetTolerance

(

const double

_arg

)

[inline, virtual]

Set/Get Tolerance

Definition at line 147 of file freSPSASOOptimizer.h.

virtual double FREE::SPSASOOptimizer::GetTolerance

(

)

const [inline, virtual]

Definition at line 148 of file freSPSASOOptimizer.h.

void FREE::SPSASOOptimizer::SetCostFunction

(

CostFunctionType *

costFunction

)

[virtual]

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 66 of file freSPSASOOptimizer.cxx.

References m_CostFunctionWrapper, and m_ItkOptimizer.

void FREE::SPSASOOptimizer::SetInitialPosition

(

const ParametersType &

param

)

[virtual]

Definition at line 75 of file freSPSASOOptimizer.cxx.

References m_ItkOptimizer.

void FREE::SPSASOOptimizer::StartOptimization

(

void

)

[virtual]

Implements FREE::SetupOptimizationOptimizer.

Definition at line 110 of file freSPSASOOptimizer.cxx.

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

bool FREE::SPSASOOptimizer::IsStoppable

(

)

const [virtual]

Indicates if the optimizer can be stopped.

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 124 of file freSPSASOOptimizer.cxx.

void FREE::SPSASOOptimizer::StopOptimization

(

void

)

[virtual]

Stops the ongoing optimization process.

Returns:

Indicates of the optimizer was sucessfully stopped.

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 132 of file freSPSASOOptimizer.cxx.

References m_ItkOptimizer.

bool FREE::SPSASOOptimizer::IsResumeable

(

)

const [virtual]

Indicates if the managed optimizer can resume the optimization once stopped.

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 139 of file freSPSASOOptimizer.cxx.

void FREE::SPSASOOptimizer::ResumeOptimization

(

)

[virtual]

Resumes the ongoing optimization process.

Returns:

Indicates of the optimizer has sucessfully resumed the optimization.

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 146 of file freSPSASOOptimizer.cxx.

References m_ItkOptimizer.

SPSASOOptimizer::ItkOptimizerType * FREE::SPSASOOptimizer::GetItkOptimizer

(

)

Definition at line 153 of file freSPSASOOptimizer.cxx.

References m_ItkOptimizer.

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

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 83 of file freSPSASOOptimizer.cxx.

References FREE::SetupOptimizationOptimizer::GetCurrentValue(), m_ItkOptimizer, and m_ValueUpdateRate.

Here is the call graph for this function:

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

Definition at line 160 of file freSPSASOOptimizer.cxx.

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

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

Definition at line 181 of file freSPSASOOptimizer.cxx.

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

Definition at line 189 of file freSPSASOOptimizer.cxx.

void FREE::SPSASOOptimizer::operator=

(

const Self &

)

[private]

Reimplemented from FREE::SetupOptimizationOptimizer.

---

Member Data Documentation

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

Definition at line 175 of file freSPSASOOptimizer.h.

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

Definition at line 176 of file freSPSASOOptimizer.h.

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

Definition at line 179 of file freSPSASOOptimizer.h.

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

Definition at line 180 of file freSPSASOOptimizer.h.

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

Definition at line 183 of file freSPSASOOptimizer.h.

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

Definition at line 184 of file freSPSASOOptimizer.h.

ItkOptimizerPointer FREE::SPSASOOptimizer::m_ItkOptimizer [protected]

Definition at line 186 of file freSPSASOOptimizer.h.

Referenced by GetItkOptimizer(), GuessParameters(), OnOptIteration(), PrintSelf(), ResumeOptimization(), SetCostFunction(), SetInitialPosition(), StartOptimization(), and StopOptimization().

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

Definition at line 187 of file freSPSASOOptimizer.h.

Referenced by SetCostFunction().

long FREE::SPSASOOptimizer::m_ValueUpdateRate [protected]

Definition at line 189 of file freSPSASOOptimizer.h.

Referenced by OnOptIteration(), and PrintSelf().

---

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

• freSPSASOOptimizer.h
• freSPSASOOptimizer.cxx

---