FREE::ItkSingleValuedCostFunctionWrapper Class Reference

This class wraps all class based on FREE::SetupOptimizationMetric. It is a wrapper used to allow itk::SingleValuedOptimizer based optimizers to interact with FREE::SetupOptimizationMetrics. It is allows an utalization of itk optimizers for setup optimization. More...

#include <freItkSingleValuedCostFunctionWrapper.h>

List of all members.

Public Types
typedef ItkSingleValuedCostFunctionWrapper	Self
typedef itk::SingleValuedCostFunction	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef SetupOptimizationMetric	WrappedCostFunctionType
typedef WrappedCostFunctionType::Pointer	WrappedCostFunctionPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual MeasureType	GetValue (const ParametersType &parameters) const
virtual void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const
virtual void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const
virtual unsigned int	GetNumberOfParameters (void) const
virtual WrappedCostFunctionType *	GetWrappedCostFunction ()
virtual void	SetWrappedCostFunction (WrappedCostFunctionType *_arg)
Static Public Member Functions
static Pointer	New (void)
Protected Member Functions
	ItkSingleValuedCostFunctionWrapper ()
virtual	~ItkSingleValuedCostFunctionWrapper ()
Protected Attributes
WrappedCostFunctionPointer	m_WrappedCostFunction
Private Member Functions
	ItkSingleValuedCostFunctionWrapper (const Self &)
void	operator= (const Self &)

---

Detailed Description

This class wraps all class based on FREE::SetupOptimizationMetric. It is a wrapper used to allow itk::SingleValuedOptimizer based optimizers to interact with FREE::SetupOptimizationMetrics. It is allows an utalization of itk optimizers for setup optimization.

Definition at line 39 of file freItkSingleValuedCostFunctionWrapper.h.

---

Member Typedef Documentation

typedef ItkSingleValuedCostFunctionWrapper FREE::ItkSingleValuedCostFunctionWrapper::Self

Standard class typedefs.

Definition at line 44 of file freItkSingleValuedCostFunctionWrapper.h.

typedef itk::SingleValuedCostFunction FREE::ItkSingleValuedCostFunctionWrapper::Superclass

Definition at line 45 of file freItkSingleValuedCostFunctionWrapper.h.

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

Definition at line 46 of file freItkSingleValuedCostFunctionWrapper.h.

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

Definition at line 47 of file freItkSingleValuedCostFunctionWrapper.h.

typedef SetupOptimizationMetric FREE::ItkSingleValuedCostFunctionWrapper::WrappedCostFunctionType

Definition at line 51 of file freItkSingleValuedCostFunctionWrapper.h.

typedef WrappedCostFunctionType::Pointer FREE::ItkSingleValuedCostFunctionWrapper::WrappedCostFunctionPointer

Definition at line 54 of file freItkSingleValuedCostFunctionWrapper.h.

---

Constructor & Destructor Documentation

FREE::ItkSingleValuedCostFunctionWrapper::ItkSingleValuedCostFunctionWrapper

(

)

[protected]

Definition at line 27 of file freItkSingleValuedCostFunctionWrapper.cxx.

References m_WrappedCostFunction.

FREE::ItkSingleValuedCostFunctionWrapper::~ItkSingleValuedCostFunctionWrapper

(

)

[protected, virtual]

Definition at line 32 of file freItkSingleValuedCostFunctionWrapper.cxx.

FREE::ItkSingleValuedCostFunctionWrapper::ItkSingleValuedCostFunctionWrapper

(

const Self &

)

[private]

---

Member Function Documentation

virtual const char* FREE::ItkSingleValuedCostFunctionWrapper::GetNameOfClass

(

)

const [inline, virtual]

Run-time type information (and related methods).

Definition at line 50 of file freItkSingleValuedCostFunctionWrapper.h.

static Pointer FREE::ItkSingleValuedCostFunctionWrapper::New

(

void

)

[inline, static]

Definition at line 51 of file freItkSingleValuedCostFunctionWrapper.h.

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

virtual ::itk::LightObject::Pointer FREE::ItkSingleValuedCostFunctionWrapper::CreateAnother

(

void

)

const [inline, virtual]

Definition at line 51 of file freItkSingleValuedCostFunctionWrapper.h.

ItkSingleValuedCostFunctionWrapper::MeasureType FREE::ItkSingleValuedCostFunctionWrapper::GetValue

(

const ParametersType &

parameters

)

const [virtual]

Definition at line 46 of file freItkSingleValuedCostFunctionWrapper.cxx.

References m_WrappedCostFunction, and throwExceptionMacro.

void FREE::ItkSingleValuedCostFunctionWrapper::GetDerivative	(	const ParametersType &	parameters,
		DerivativeType &	derivative
	)			const [virtual]

Definition at line 54 of file freItkSingleValuedCostFunctionWrapper.cxx.

References m_WrappedCostFunction, and throwExceptionMacro.

void FREE::ItkSingleValuedCostFunctionWrapper::GetValueAndDerivative	(	const ParametersType &	parameters,
		MeasureType &	Value,
		DerivativeType &	Derivative
	)			const [virtual]

Definition at line 63 of file freItkSingleValuedCostFunctionWrapper.cxx.

References m_WrappedCostFunction, and throwExceptionMacro.

unsigned int FREE::ItkSingleValuedCostFunctionWrapper::GetNumberOfParameters

(

void

)

const [virtual]

Definition at line 38 of file freItkSingleValuedCostFunctionWrapper.cxx.

References m_WrappedCostFunction, and throwExceptionMacro.

virtual WrappedCostFunctionType* FREE::ItkSingleValuedCostFunctionWrapper::GetWrappedCostFunction

(

)

[inline, virtual]

Definition at line 64 of file freItkSingleValuedCostFunctionWrapper.h.

virtual void FREE::ItkSingleValuedCostFunctionWrapper::SetWrappedCostFunction

(

WrappedCostFunctionType *

_arg

)

[inline, virtual]

Definition at line 65 of file freItkSingleValuedCostFunctionWrapper.h.

void FREE::ItkSingleValuedCostFunctionWrapper::operator=

(

const Self &

)

[private]

---

Member Data Documentation

WrappedCostFunctionPointer FREE::ItkSingleValuedCostFunctionWrapper::m_WrappedCostFunction [protected]

Definition at line 71 of file freItkSingleValuedCostFunctionWrapper.h.

Referenced by GetDerivative(), GetNumberOfParameters(), GetValue(), GetValueAndDerivative(), and ItkSingleValuedCostFunctionWrapper().

---

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

• freItkSingleValuedCostFunctionWrapper.h
• freItkSingleValuedCostFunctionWrapper.cxx

---