FREE::SetupOptimizationOptimizer Class Reference
[Optimizer controller, Setup optimization optimizer]

#include <freSetupOptimizationOptimizer.h>

Inheritance diagram for FREE::SetupOptimizationOptimizer:

[legend]

List of all members.

Public Types
typedef SetupOptimizationOptimizer	Self
typedef itk::NonLinearOptimizer	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef SetupOptimizationMetric	CostFunctionType
typedef CostFunctionType::Pointer	CostFunctionPointer
typedef CostFunctionType::MeasureType	MeasureType
typedef CostFunctionType::DecomposedMeasureType	DecomposedMeasureType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual void	StartOptimization ()=0
virtual bool	IsStoppable () const
virtual void	StopOptimization ()
virtual bool	IsResumeable () const
virtual void	ResumeOptimization ()
virtual const MeasureType &	GetCurrentValue () const
virtual const DecomposedMeasureType &	GetCurrentDecomposedValue () const
virtual const ParametersType &	GetBestPosition () const
virtual const MeasureType &	GetBestValue () const
virtual MeasureType	GetValue (const ParametersType &parameters)
virtual DecomposedMeasureType	GetDecomposedValue (const ParametersType &parameters)
virtual void	SetCostFunction (CostFunctionType *costFunction)
virtual const CostFunctionType *	GetCostFunction () const
Protected Member Functions
	SetupOptimizationOptimizer ()
virtual	~SetupOptimizationOptimizer ()
void	PrintSelf (std::ostream &os, itk::Indent indent) const
Protected Attributes
MeasureType	m_CurrentValue
DecomposedMeasureType	m_CurrentDecomposedValue
ParametersType	m_BestPosition
MeasureType	m_BestValue
CostFunctionPointer	m_CostFunction
Private Member Functions
	SetupOptimizationOptimizer (const Self &)
void	operator= (const Self &)

---

Detailed Description

Definition at line 36 of file freSetupOptimizationOptimizer.h.

---

Member Typedef Documentation

typedef SetupOptimizationOptimizer FREE::SetupOptimizationOptimizer::Self

Standard "Self" typedef.

Reimplemented in FREE::AmoebaSOOptimizer, FREE::ConstrainedOnePlusOneEvolutionarySOOptimizer, FREE::EvolutionaryStrategySOOptimizer, FREE::ExhaustiveSOOptimizer, FREE::LimitedAxisAmoebaSOOptimizer, FREE::OnePlusOneEvolutionarySOOptimizer, FREE::PowellSOOptimizer, FREE::SPSASOOptimizer, and FREE::VnlSetupOptimizationOptimizer.

Definition at line 41 of file freSetupOptimizationOptimizer.h.

typedef itk::NonLinearOptimizer FREE::SetupOptimizationOptimizer::Superclass

Reimplemented in FREE::AmoebaSOOptimizer, FREE::ConstrainedOnePlusOneEvolutionarySOOptimizer, FREE::EvolutionaryStrategySOOptimizer, FREE::ExhaustiveSOOptimizer, FREE::LimitedAxisAmoebaSOOptimizer, FREE::OnePlusOneEvolutionarySOOptimizer, FREE::PowellSOOptimizer, FREE::SPSASOOptimizer, and FREE::VnlSetupOptimizationOptimizer.

Definition at line 42 of file freSetupOptimizationOptimizer.h.

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

Reimplemented in FREE::AmoebaSOOptimizer, FREE::ConstrainedOnePlusOneEvolutionarySOOptimizer, FREE::EvolutionaryStrategySOOptimizer, FREE::ExhaustiveSOOptimizer, FREE::LimitedAxisAmoebaSOOptimizer, FREE::OnePlusOneEvolutionarySOOptimizer, FREE::PowellSOOptimizer, FREE::SPSASOOptimizer, and FREE::VnlSetupOptimizationOptimizer.

Definition at line 43 of file freSetupOptimizationOptimizer.h.

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

Reimplemented in FREE::AmoebaSOOptimizer, FREE::ConstrainedOnePlusOneEvolutionarySOOptimizer, FREE::EvolutionaryStrategySOOptimizer, FREE::ExhaustiveSOOptimizer, FREE::LimitedAxisAmoebaSOOptimizer, FREE::OnePlusOneEvolutionarySOOptimizer, FREE::PowellSOOptimizer, FREE::SPSASOOptimizer, and FREE::VnlSetupOptimizationOptimizer.

Definition at line 44 of file freSetupOptimizationOptimizer.h.

typedef SetupOptimizationMetric FREE::SetupOptimizationOptimizer::CostFunctionType

Reimplemented in FREE::VnlSetupOptimizationOptimizer.

Definition at line 46 of file freSetupOptimizationOptimizer.h.

typedef CostFunctionType::Pointer FREE::SetupOptimizationOptimizer::CostFunctionPointer

Reimplemented in FREE::VnlSetupOptimizationOptimizer.

Definition at line 47 of file freSetupOptimizationOptimizer.h.

typedef CostFunctionType::MeasureType FREE::SetupOptimizationOptimizer::MeasureType

Reimplemented in FREE::VnlSetupOptimizationOptimizer.

Definition at line 48 of file freSetupOptimizationOptimizer.h.

typedef CostFunctionType::DecomposedMeasureType FREE::SetupOptimizationOptimizer::DecomposedMeasureType

Reimplemented in FREE::VnlSetupOptimizationOptimizer.

Definition at line 49 of file freSetupOptimizationOptimizer.h.

---

Constructor & Destructor Documentation

FREE::SetupOptimizationOptimizer::SetupOptimizationOptimizer

(

)

[protected]

Constructor

Definition at line 34 of file freSetupOptimizationOptimizer.cxx.

virtual FREE::SetupOptimizationOptimizer::~SetupOptimizationOptimizer

(

)

[inline, protected, virtual]

Definition at line 83 of file freSetupOptimizationOptimizer.h.

FREE::SetupOptimizationOptimizer::SetupOptimizationOptimizer

(

const Self &

)

[private]

---

Member Function Documentation

virtual const char* FREE::SetupOptimizationOptimizer::GetNameOfClass

(

)

const [inline, virtual]

Run-time type information (and related methods).

Reimplemented in FREE::AmoebaSOOptimizer, FREE::ConstrainedOnePlusOneEvolutionarySOOptimizer, FREE::EvolutionaryStrategySOOptimizer, FREE::ExhaustiveSOOptimizer, FREE::LimitedAxisAmoebaSOOptimizer, FREE::OnePlusOneEvolutionarySOOptimizer, FREE::PowellSOOptimizer, FREE::SPSASOOptimizer, and FREE::VnlSetupOptimizationOptimizer.

Definition at line 52 of file freSetupOptimizationOptimizer.h.

virtual void FREE::SetupOptimizationOptimizer::StartOptimization

(

)

[pure virtual]

Implemented in FREE::AmoebaSOOptimizer, FREE::ConstrainedOnePlusOneEvolutionarySOOptimizer, FREE::EvolutionaryStrategySOOptimizer, FREE::ExhaustiveSOOptimizer, FREE::LimitedAxisAmoebaSOOptimizer, FREE::OnePlusOneEvolutionarySOOptimizer, FREE::PowellSOOptimizer, and FREE::SPSASOOptimizer.

bool FREE::SetupOptimizationOptimizer::IsStoppable

(

)

const [virtual]

Indicates if the optimizer can be stopped.

Reimplemented in FREE::ConstrainedOnePlusOneEvolutionarySOOptimizer, FREE::EvolutionaryStrategySOOptimizer, FREE::ExhaustiveSOOptimizer, FREE::OnePlusOneEvolutionarySOOptimizer, FREE::PowellSOOptimizer, and FREE::SPSASOOptimizer.

Definition at line 87 of file freSetupOptimizationOptimizer.cxx.

void FREE::SetupOptimizationOptimizer::StopOptimization

(

void

)

[virtual]

Stops the ongoing optimization process.

Returns:

Indicates of the optimizer was sucessfully stopped.

Reimplemented in FREE::ConstrainedOnePlusOneEvolutionarySOOptimizer, FREE::EvolutionaryStrategySOOptimizer, FREE::ExhaustiveSOOptimizer, FREE::OnePlusOneEvolutionarySOOptimizer, FREE::PowellSOOptimizer, and FREE::SPSASOOptimizer.

Definition at line 94 of file freSetupOptimizationOptimizer.cxx.

bool FREE::SetupOptimizationOptimizer::IsResumeable

(

)

const [virtual]

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

Reimplemented in FREE::EvolutionaryStrategySOOptimizer, FREE::ExhaustiveSOOptimizer, and FREE::SPSASOOptimizer.

Definition at line 100 of file freSetupOptimizationOptimizer.cxx.

void FREE::SetupOptimizationOptimizer::ResumeOptimization

(

)

[virtual]

Resumes the ongoing optimization process.

Returns:

Indicates of the optimizer has sucessfully resumed the optimization.

Reimplemented in FREE::EvolutionaryStrategySOOptimizer, FREE::ExhaustiveSOOptimizer, and FREE::SPSASOOptimizer.

Definition at line 107 of file freSetupOptimizationOptimizer.cxx.

virtual const MeasureType& FREE::SetupOptimizationOptimizer::GetCurrentValue

(

)

const [inline, virtual]

Definition at line 70 of file freSetupOptimizationOptimizer.h.

Referenced by FREE::SPSASOOptimizer::PrintSelf().

virtual const DecomposedMeasureType& FREE::SetupOptimizationOptimizer::GetCurrentDecomposedValue

(

)

const [inline, virtual]

Definition at line 71 of file freSetupOptimizationOptimizer.h.

virtual const ParametersType& FREE::SetupOptimizationOptimizer::GetBestPosition

(

)

const [inline, virtual]

Definition at line 72 of file freSetupOptimizationOptimizer.h.

virtual const MeasureType& FREE::SetupOptimizationOptimizer::GetBestValue

(

)

const [inline, virtual]

Definition at line 73 of file freSetupOptimizationOptimizer.h.

SetupOptimizationOptimizer::MeasureType FREE::SetupOptimizationOptimizer::GetValue

(

const ParametersType &

parameters

)

[virtual]

Reimplemented in FREE::AmoebaSOOptimizer, and FREE::LimitedAxisAmoebaSOOptimizer.

Definition at line 54 of file freSetupOptimizationOptimizer.cxx.

References throwExceptionMacro.

SetupOptimizationOptimizer::DecomposedMeasureType FREE::SetupOptimizationOptimizer::GetDecomposedValue

(

const ParametersType &

parameters

)

[virtual]

Reimplemented in FREE::AmoebaSOOptimizer, and FREE::LimitedAxisAmoebaSOOptimizer.

Definition at line 62 of file freSetupOptimizationOptimizer.cxx.

References throwExceptionMacro.

void FREE::SetupOptimizationOptimizer::SetCostFunction

(

CostFunctionType *

costFunction

)

[virtual]

Reimplemented in FREE::AmoebaSOOptimizer, FREE::EvolutionaryStrategySOOptimizer, FREE::LimitedAxisAmoebaSOOptimizer, FREE::OnePlusOneEvolutionarySOOptimizer, FREE::PowellSOOptimizer, FREE::SPSASOOptimizer, and FREE::VnlSetupOptimizationOptimizer.

Definition at line 71 of file freSetupOptimizationOptimizer.cxx.

References m_CostFunction.

Referenced by FREE::PowellSOOptimizer::SetCostFunction(), FREE::OnePlusOneEvolutionarySOOptimizer::SetCostFunction(), and FREE::EvolutionaryStrategySOOptimizer::SetCostFunction().

virtual const CostFunctionType* FREE::SetupOptimizationOptimizer::GetCostFunction

(

)

const [inline, virtual]

Definition at line 79 of file freSetupOptimizationOptimizer.h.

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

Reimplemented in FREE::AmoebaSOOptimizer, FREE::ConstrainedOnePlusOneEvolutionarySOOptimizer, FREE::EvolutionaryStrategySOOptimizer, FREE::ExhaustiveSOOptimizer, FREE::LimitedAxisAmoebaSOOptimizer, FREE::OnePlusOneEvolutionarySOOptimizer, FREE::PowellSOOptimizer, FREE::SPSASOOptimizer, and FREE::VnlSetupOptimizationOptimizer.

Definition at line 44 of file freSetupOptimizationOptimizer.cxx.

Referenced by FREE::PowellSOOptimizer::PrintSelf(), and FREE::OnePlusOneEvolutionarySOOptimizer::PrintSelf().

void FREE::SetupOptimizationOptimizer::operator=

(

const Self &

)

[private]

Reimplemented in FREE::SPSASOOptimizer, and FREE::VnlSetupOptimizationOptimizer.

---

Member Data Documentation

MeasureType FREE::SetupOptimizationOptimizer::m_CurrentValue [mutable, protected]

Definition at line 91 of file freSetupOptimizationOptimizer.h.

Referenced by FREE::SPSASOOptimizer::OnOptIteration(), FREE::PowellSOOptimizer::OnOptIteration(), FREE::OnePlusOneEvolutionarySOOptimizer::OnOptIteration(), FREE::EvolutionaryStrategySOOptimizer::OnOptIteration(), FREE::SPSASOOptimizer::StartOptimization(), and FREE::OnePlusOneEvolutionarySOOptimizer::StartOptimization().

DecomposedMeasureType FREE::SetupOptimizationOptimizer::m_CurrentDecomposedValue [mutable, protected]

Definition at line 92 of file freSetupOptimizationOptimizer.h.

Referenced by FREE::SPSASOOptimizer::OnOptIteration(), FREE::PowellSOOptimizer::OnOptIteration(), FREE::OnePlusOneEvolutionarySOOptimizer::OnOptIteration(), FREE::EvolutionaryStrategySOOptimizer::OnOptIteration(), FREE::SPSASOOptimizer::StartOptimization(), and FREE::OnePlusOneEvolutionarySOOptimizer::StartOptimization().

ParametersType FREE::SetupOptimizationOptimizer::m_BestPosition [mutable, protected]

Definition at line 93 of file freSetupOptimizationOptimizer.h.

Referenced by FREE::SPSASOOptimizer::OnOptIteration(), FREE::PowellSOOptimizer::OnOptIteration(), FREE::OnePlusOneEvolutionarySOOptimizer::OnOptIteration(), FREE::EvolutionaryStrategySOOptimizer::OnOptIteration(), FREE::SPSASOOptimizer::StartOptimization(), and FREE::OnePlusOneEvolutionarySOOptimizer::StartOptimization().

MeasureType FREE::SetupOptimizationOptimizer::m_BestValue [mutable, protected]

Definition at line 94 of file freSetupOptimizationOptimizer.h.

Referenced by FREE::SPSASOOptimizer::OnOptIteration(), FREE::PowellSOOptimizer::OnOptIteration(), FREE::OnePlusOneEvolutionarySOOptimizer::OnOptIteration(), FREE::EvolutionaryStrategySOOptimizer::OnOptIteration(), FREE::SPSASOOptimizer::StartOptimization(), and FREE::OnePlusOneEvolutionarySOOptimizer::StartOptimization().

CostFunctionPointer FREE::SetupOptimizationOptimizer::m_CostFunction [protected]

Definition at line 96 of file freSetupOptimizationOptimizer.h.

Referenced by FREE::EvolutionaryStrategySOOptimizer::OnChildEval(), FREE::SPSASOOptimizer::OnOptIteration(), FREE::PowellSOOptimizer::OnOptIteration(), FREE::OnePlusOneEvolutionarySOOptimizer::OnOptIteration(), FREE::EvolutionaryStrategySOOptimizer::OnOptIteration(), SetCostFunction(), FREE::LimitedAxisAmoebaSOOptimizer::SetCostFunction(), FREE::AmoebaSOOptimizer::SetCostFunction(), FREE::SPSASOOptimizer::StartOptimization(), FREE::OnePlusOneEvolutionarySOOptimizer::StartOptimization(), and FREE::ExhaustiveSOOptimizer::StartOptimization().

---

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

• freSetupOptimizationOptimizer.h
• freSetupOptimizationOptimizer.cxx

---