#include <itkMultipleValuedNonLinearOptimizer.h>

Inheritance diagram for itk::MultipleValuedNonLinearOptimizer:

Collaboration diagram for itk::MultipleValuedNonLinearOptimizer:

Detailed Description

This class is a base for the Optimization methods that optimize a multiple valued function.

Definition at line 33 of file itkMultipleValuedNonLinearOptimizer.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef CostFunctionType::Pointer	CostFunctionPointer

typedef MultipleValuedCostFunction	CostFunctionType

typedef Array2D< double >	DerivativeType

typedef Array< double >	MeasureType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef MultipleValuedNonLinearOptimizer	Self

typedef NonLinearOptimizer	Superclass

Public Types inherited from itk::NonLinearOptimizer
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef Superclass::ScalesType	ScalesType

typedef NonLinearOptimizer	Self

typedef Optimizer	Superclass

Public Types inherited from itk::Optimizer
typedef SmartPointer< const Self >	ConstPointer

typedef OptimizerParameters < double >	ParametersType

typedef SmartPointer< Self >	Pointer

typedef Array< double >	ScalesType

typedef Optimizer	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual const char *	GetNameOfClass () const

virtual void	SetCostFunction (CostFunctionType *costFunction)

Public Member Functions inherited from itk::NonLinearOptimizer
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

Public Member Functions inherited from itk::Optimizer
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual const ParametersType &	GetCurrentPosition () const

virtual const ParametersType &	GetInitialPosition () const

virtual const std::string	GetStopConditionDescription () const

virtual void	SetInitialPosition (const ParametersType &param)

void	SetScales (const ScalesType &scales)

virtual void	StartOptimization ()

virtual const ScalesType &	GetScales () const

virtual const ScalesType &	GetInverseScales () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const ITK_OVERRIDE

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) ITK_OVERRIDE

virtual void	UnRegister () const ITK_OVERRIDE

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::NonLinearOptimizer
static Pointer	New ()

Static Public Member Functions inherited from itk::Optimizer
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
	MultipleValuedNonLinearOptimizer ()

virtual void	PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE

virtual	~MultipleValuedNonLinearOptimizer ()

Protected Member Functions inherited from itk::NonLinearOptimizer
	NonLinearOptimizer ()

virtual	~NonLinearOptimizer ()

Protected Member Functions inherited from itk::Optimizer
	Optimizer ()

virtual void	SetCurrentPosition (const ParametersType &param)

virtual	~Optimizer ()

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Attributes
CostFunctionPointer	m_CostFunction

Protected Attributes inherited from itk::Optimizer
ParametersType	m_CurrentPosition

bool	m_ScalesInitialized

Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Private Member Functions
	MultipleValuedNonLinearOptimizer (const Self &)

void	operator= (const Self &)

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Member Typedef Documentation

typedef SmartPointer< const Self > itk::MultipleValuedNonLinearOptimizer::ConstPointer

Definition at line 41 of file itkMultipleValuedNonLinearOptimizer.h.

typedef CostFunctionType::Pointer itk::MultipleValuedNonLinearOptimizer::CostFunctionPointer

Definition at line 45 of file itkMultipleValuedNonLinearOptimizer.h.

typedef MultipleValuedCostFunction itk::MultipleValuedNonLinearOptimizer::CostFunctionType

Type of the Cost Function

Definition at line 44 of file itkMultipleValuedNonLinearOptimizer.h.

typedef Array2D< double > itk::MultipleValuedNonLinearOptimizer::DerivativeType

Derivative type. It defines a type used to return the cost function derivative. Here a bidimensional Array is used for Multivalued functions

Definition at line 65 of file itkMultipleValuedNonLinearOptimizer.h.

typedef Array< double > itk::MultipleValuedNonLinearOptimizer::MeasureType

Measure type. It defines a type used to return the cost function value. Here an Array is used for Multivalued functions

Definition at line 60 of file itkMultipleValuedNonLinearOptimizer.h.

typedef Superclass::ParametersType itk::MultipleValuedNonLinearOptimizer::ParametersType

Parameters type. It defines a position in the optimization search space.

Definition at line 51 of file itkMultipleValuedNonLinearOptimizer.h.

typedef SmartPointer< Self > itk::MultipleValuedNonLinearOptimizer::Pointer

Definition at line 40 of file itkMultipleValuedNonLinearOptimizer.h.

typedef MultipleValuedNonLinearOptimizer itk::MultipleValuedNonLinearOptimizer::Self

Standard class typedefs.

Definition at line 38 of file itkMultipleValuedNonLinearOptimizer.h.

typedef NonLinearOptimizer itk::MultipleValuedNonLinearOptimizer::Superclass

Definition at line 39 of file itkMultipleValuedNonLinearOptimizer.h.

Constructor & Destructor Documentation

itk::MultipleValuedNonLinearOptimizer::MultipleValuedNonLinearOptimizer ( )

protected

virtual itk::MultipleValuedNonLinearOptimizer::~MultipleValuedNonLinearOptimizer ( )

inlineprotectedvirtual

Definition at line 72 of file itkMultipleValuedNonLinearOptimizer.h.

itk::MultipleValuedNonLinearOptimizer::MultipleValuedNonLinearOptimizer ( const Self & )

private

Member Function Documentation

virtual::itk::LightObject::Pointer itk::MultipleValuedNonLinearOptimizer::CreateAnother ( void ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

virtual const char* itk::MultipleValuedNonLinearOptimizer::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::NonLinearOptimizer.

Reimplemented in itk::CumulativeGaussianOptimizer, itk::MultipleValuedNonLinearVnlOptimizer, and itk::LevenbergMarquardtOptimizer.

static Pointer itk::MultipleValuedNonLinearOptimizer::New ( )

static

Method for creation through the object factory.

void itk::MultipleValuedNonLinearOptimizer::operator= ( const Self & )

private

virtual void itk::MultipleValuedNonLinearOptimizer::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Optimizer.

Reimplemented in itk::CumulativeGaussianOptimizer, and itk::MultipleValuedNonLinearVnlOptimizer.

virtual void itk::MultipleValuedNonLinearOptimizer::SetCostFunction ( CostFunctionType * costFunction )

virtual

Set the cost function.