FREE::PowellSOOptimizer Class Reference
[Setup optimization optimizer]

#include <frePowellSOOptimizer.h>

Inheritance diagram for FREE::PowellSOOptimizer:

[legend]

Collaboration diagram for FREE::PowellSOOptimizer:

[legend]

List of all members.

Public Types
typedef PowellSOOptimizer	Self
typedef SetupOptimizationOptimizer	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef itk::PowellOptimizer	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 iMaximumIteration)
const unsigned int	GetMaximumIteration () const
void	SetMaximumLineIteration (unsigned int iMaximumLineIteration)
const unsigned int	GetMaximumLineIteration () const
void	SetStepLength (double dStepLength)
const double &	GetStepLength () const
void	SetStepTolerance (double dStepTolerance)
const double &	GetStepTolerance () const
void	SetValueTolerance (double dValueTolerance)
const double &	GetValueTolerance () const
virtual void	SetCostFunction (CostFunctionType *costFunction)
virtual void	SetInitialPosition (const ParametersType &param)
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
	PowellSOOptimizer ()
virtual	~PowellSOOptimizer ()
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
Private Member Functions
	PowellSOOptimizer (const Self &)
void	operator= (const Self &)

---

Detailed Description

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

Definition at line 39 of file frePowellSOOptimizer.h.

---

Member Typedef Documentation

typedef PowellSOOptimizer FREE::PowellSOOptimizer::Self

Standard "Self" typedef.

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 44 of file frePowellSOOptimizer.h.

typedef SetupOptimizationOptimizer FREE::PowellSOOptimizer::Superclass

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 45 of file frePowellSOOptimizer.h.

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

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 46 of file frePowellSOOptimizer.h.

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

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 47 of file frePowellSOOptimizer.h.

typedef itk::PowellOptimizer FREE::PowellSOOptimizer::ItkOptimizerType

Definition at line 89 of file frePowellSOOptimizer.h.

typedef ItkOptimizerType::Pointer FREE::PowellSOOptimizer::ItkOptimizerPointer

Definition at line 90 of file frePowellSOOptimizer.h.

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

Definition at line 106 of file frePowellSOOptimizer.h.

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

Definition at line 110 of file frePowellSOOptimizer.h.

---

Constructor & Destructor Documentation

FREE::PowellSOOptimizer::PowellSOOptimizer

(

)

[protected]

Definition at line 31 of file frePowellSOOptimizer.cxx.

References FREE::ItkSingleValuedCostFunctionWrapper::New().

Here is the call graph for this function:

FREE::PowellSOOptimizer::~PowellSOOptimizer

(

)

[protected, virtual]

Definition at line 60 of file frePowellSOOptimizer.cxx.

FREE::PowellSOOptimizer::PowellSOOptimizer

(

const Self &

)

[private]

---

Member Function Documentation

virtual const char* FREE::PowellSOOptimizer::GetNameOfClass

(

)

const [inline, virtual]

Run-time type information (and related methods).

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 50 of file frePowellSOOptimizer.h.

static Pointer FREE::PowellSOOptimizer::New

(

void

)

[inline, static]

Method for creation through the object factory.

Definition at line 53 of file frePowellSOOptimizer.h.

virtual ::itk::LightObject::Pointer FREE::PowellSOOptimizer::CreateAnother

(

void

)

const [inline, virtual]

Definition at line 53 of file frePowellSOOptimizer.h.

void FREE::PowellSOOptimizer::SetMaximize

(

bool

maximize

)

Set if the Optimizer should maximize the metric

Definition at line 66 of file frePowellSOOptimizer.cxx.

References m_ItkOptimizer.

virtual void FREE::PowellSOOptimizer::MaximizeOn

(

)

[inline, virtual]

Definition at line 57 of file frePowellSOOptimizer.h.

virtual void FREE::PowellSOOptimizer::MaximizeOff

(

)

[inline, virtual]

Definition at line 57 of file frePowellSOOptimizer.h.

void FREE::PowellSOOptimizer::SetMaximumIteration

(

unsigned int

iMaximumIteration

)

Set/Get maximum iteration limit.

Definition at line 74 of file frePowellSOOptimizer.cxx.

References m_ItkOptimizer.

const unsigned int FREE::PowellSOOptimizer::GetMaximumIteration

(

)

const

Definition at line 82 of file frePowellSOOptimizer.cxx.

References m_ItkOptimizer.

void FREE::PowellSOOptimizer::SetMaximumLineIteration

(

unsigned int

iMaximumLineIteration

)

Set/Get maximum iteration limit.

Definition at line 89 of file frePowellSOOptimizer.cxx.

References m_ItkOptimizer.

const unsigned int FREE::PowellSOOptimizer::GetMaximumLineIteration

(

)

const

Definition at line 97 of file frePowellSOOptimizer.cxx.

References m_ItkOptimizer.

void FREE::PowellSOOptimizer::SetStepLength

(

double

dStepLength

)

Set/Get the step length of the initial bracket.

Definition at line 104 of file frePowellSOOptimizer.cxx.

References m_ItkOptimizer.

const double & FREE::PowellSOOptimizer::GetStepLength

(

)

const

Definition at line 112 of file frePowellSOOptimizer.cxx.

References m_ItkOptimizer.

void FREE::PowellSOOptimizer::SetStepTolerance

(

double

dStepTolerance

)

Set/Get the search radius shrink factor.

Definition at line 119 of file frePowellSOOptimizer.cxx.

References m_ItkOptimizer.

const double & FREE::PowellSOOptimizer::GetStepTolerance

(

)

const

Definition at line 127 of file frePowellSOOptimizer.cxx.

References m_ItkOptimizer.

void FREE::PowellSOOptimizer::SetValueTolerance

(

double

dValueTolerance

)

Set/Get the search radius shrink factor.

Definition at line 134 of file frePowellSOOptimizer.cxx.

References m_ItkOptimizer.

const double & FREE::PowellSOOptimizer::GetValueTolerance

(

)

const

Definition at line 142 of file frePowellSOOptimizer.cxx.

References m_ItkOptimizer.

void FREE::PowellSOOptimizer::SetCostFunction

(

CostFunctionType *

costFunction

)

[virtual]

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 149 of file frePowellSOOptimizer.cxx.

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

Here is the call graph for this function:

void FREE::PowellSOOptimizer::SetInitialPosition

(

const ParametersType &

param

)

[virtual]

Definition at line 158 of file frePowellSOOptimizer.cxx.

References m_ItkOptimizer.

void FREE::PowellSOOptimizer::StartOptimization

(

void

)

[virtual]

Implements FREE::SetupOptimizationOptimizer.

Definition at line 182 of file frePowellSOOptimizer.cxx.

References m_ItkOptimizer.

void FREE::PowellSOOptimizer::StopOptimization

(

void

)

[virtual]

Stops the ongoing optimization process.

Returns:

Indicates of the optimizer was sucessfully stopped.

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 190 of file frePowellSOOptimizer.cxx.

References m_ItkOptimizer.

bool FREE::PowellSOOptimizer::IsStoppable

(

)

const [virtual]

Indicates if the optimizer can be stopped.

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 197 of file frePowellSOOptimizer.cxx.

PowellSOOptimizer::ItkOptimizerType * FREE::PowellSOOptimizer::GetItkOptimizer

(

)

Definition at line 205 of file frePowellSOOptimizer.cxx.

References m_ItkOptimizer.

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

Reimplemented from FREE::SetupOptimizationOptimizer.

Definition at line 166 of file frePowellSOOptimizer.cxx.

References m_ItkOptimizer, and FREE::SetupOptimizationOptimizer::PrintSelf().

Here is the call graph for this function:

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

Definition at line 212 of file frePowellSOOptimizer.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.

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

Definition at line 228 of file frePowellSOOptimizer.cxx.

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

Definition at line 236 of file frePowellSOOptimizer.cxx.

void FREE::PowellSOOptimizer::operator=

(

const Self &

)

[private]

---

Member Data Documentation

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

Definition at line 103 of file frePowellSOOptimizer.h.

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

Definition at line 104 of file frePowellSOOptimizer.h.

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

Definition at line 107 of file frePowellSOOptimizer.h.

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

Definition at line 108 of file frePowellSOOptimizer.h.

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

Definition at line 111 of file frePowellSOOptimizer.h.

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

Definition at line 112 of file frePowellSOOptimizer.h.

ItkOptimizerPointer FREE::PowellSOOptimizer::m_ItkOptimizer [protected]

Definition at line 114 of file frePowellSOOptimizer.h.

Referenced by GetItkOptimizer(), GetMaximumIteration(), GetMaximumLineIteration(), GetStepLength(), GetStepTolerance(), GetValueTolerance(), OnOptIteration(), PrintSelf(), SetCostFunction(), SetInitialPosition(), SetMaximize(), SetMaximumIteration(), SetMaximumLineIteration(), SetStepLength(), SetStepTolerance(), SetValueTolerance(), StartOptimization(), and StopOptimization().

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

Definition at line 115 of file frePowellSOOptimizer.h.

Referenced by SetCostFunction().

---

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

• frePowellSOOptimizer.h
• frePowellSOOptimizer.cxx

---