#include <itkMultipleValuedNonLinearVnlOptimizer.h>

Detailed Description

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

It is an Adaptor class for optimizers provided by the vnl library

Definition at line 39 of file itkMultipleValuedNonLinearVnlOptimizer.h.

Inheritance diagram for itk::MultipleValuedNonLinearVnlOptimizer:

Collaboration diagram for itk::MultipleValuedNonLinearVnlOptimizer:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	ParametersType = Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	Self = MultipleValuedNonLinearVnlOptimizer

using	Superclass = MultipleValuedNonLinearOptimizer

Public Types inherited from itk::MultipleValuedNonLinearOptimizer
using	ConstPointer = SmartPointer< const Self >

using	CostFunctionPointer = CostFunctionType::Pointer

using	CostFunctionType = MultipleValuedCostFunction

using	DerivativeType = Array2D< double >

using	MeasureType = Array< double >

using	ParametersType = Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	Self = MultipleValuedNonLinearOptimizer

using	Superclass = NonLinearOptimizer

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

using	ParametersType = Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	ScalesType = Superclass::ScalesType

using	Self = NonLinearOptimizer

using	Superclass = Optimizer

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

using	ParametersType = OptimizerParameters< double >

using	Pointer = SmartPointer< Self >

using	ScalesType = Array< double >

using	Self = Optimizer

using	Superclass = Object

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
const char *	GetNameOfClass () const override

bool	GetUseCostFunctionGradient () const

void	SetCostFunction (MultipleValuedCostFunction *costFunction) override=0

void	SetUseCostFunctionGradient (bool)

void	UseCostFunctionGradientOff ()

void	UseCostFunctionGradientOn ()


virtual const MeasureType &	GetCachedValue () const

virtual const DerivativeType &	GetCachedDerivative () const

virtual const ParametersType &	GetCachedCurrentPosition () const

Public Member Functions inherited from itk::MultipleValuedNonLinearOptimizer
const char *	GetNameOfClass () const override

virtual void	SetCostFunction (CostFunctionType *costFunction)

Public Member Functions inherited from itk::NonLinearOptimizer
const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::Optimizer
virtual const ParametersType &	GetCurrentPosition () const

virtual const ParametersType &	GetInitialPosition () const

const char *	GetNameOfClass () const override

virtual 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 *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Protected Types
using	CommandType = ReceptorMemberCommand< Self >

using	CostFunctionAdaptorType = MultipleValuedVnlCostFunctionAdaptor

Protected Member Functions
CostFunctionAdaptorType *	GetCostFunctionAdaptor ()

const CostFunctionAdaptorType *	GetCostFunctionAdaptor () const

CostFunctionAdaptorType *	GetNonConstCostFunctionAdaptor () const

	MultipleValuedNonLinearVnlOptimizer ()

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

void	SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor)

	~MultipleValuedNonLinearVnlOptimizer () override

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

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

	~MultipleValuedNonLinearOptimizer () override=default

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

	~NonLinearOptimizer () override

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

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

virtual void	SetCurrentPosition (const ParametersType &param)

	~Optimizer () override=default

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

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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

	LightObject ()

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

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

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

virtual	~LightObject ()

Private Member Functions
void	IterationReport (const EventObject &event)

Private Attributes
ParametersType	m_CachedCurrentPosition {}

DerivativeType	m_CachedDerivative {}

MeasureType	m_CachedValue {}

CommandType::Pointer	m_Command {}

std::unique_ptr< CostFunctionAdaptorType >	m_CostFunctionAdaptor

bool	m_UseGradient {}

Additional Inherited Members
Static Public Member Functions inherited from itk::MultipleValuedNonLinearOptimizer
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 val)

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

static Pointer	New ()

Protected Attributes inherited from itk::MultipleValuedNonLinearOptimizer
CostFunctionPointer	m_CostFunction {}

Protected Attributes inherited from itk::Optimizer
ParametersType	m_CurrentPosition {}

bool	m_ScalesInitialized { false }

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ CommandType

using itk::MultipleValuedNonLinearVnlOptimizer::CommandType = ReceptorMemberCommand<Self>

protected

Command observer that will interact with the ITKVNL cost-function adaptor in order to generate iteration events. This will allow to overcome the limitation of VNL optimizers not offering callbacks for every iteration

Definition at line 125 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ ConstPointer

using itk::MultipleValuedNonLinearVnlOptimizer::ConstPointer = SmartPointer<const Self>

Definition at line 48 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ CostFunctionAdaptorType

using itk::MultipleValuedNonLinearVnlOptimizer::CostFunctionAdaptorType = MultipleValuedVnlCostFunctionAdaptor

protected

Definition at line 105 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ ParametersType

using itk::MultipleValuedNonLinearVnlOptimizer::ParametersType = Superclass::ParametersType

ParametersType type alias. It defines a position in the optimization search space.

Definition at line 55 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ Pointer

using itk::MultipleValuedNonLinearVnlOptimizer::Pointer = SmartPointer<Self>

Definition at line 47 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ Self

using itk::MultipleValuedNonLinearVnlOptimizer::Self = MultipleValuedNonLinearVnlOptimizer

Standard class type aliases.

Definition at line 45 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ Superclass

using itk::MultipleValuedNonLinearVnlOptimizer::Superclass = MultipleValuedNonLinearOptimizer

Definition at line 46 of file itkMultipleValuedNonLinearVnlOptimizer.h.

Constructor & Destructor Documentation

◆ MultipleValuedNonLinearVnlOptimizer()

itk::MultipleValuedNonLinearVnlOptimizer::MultipleValuedNonLinearVnlOptimizer ( )

protected

◆ ~MultipleValuedNonLinearVnlOptimizer()

itk::MultipleValuedNonLinearVnlOptimizer::~MultipleValuedNonLinearVnlOptimizer ( )

overrideprotected

Member Function Documentation

◆ GetCachedCurrentPosition()

virtual const ParametersType & itk::MultipleValuedNonLinearVnlOptimizer::GetCachedCurrentPosition ( ) const

virtual

Return Cached Values. These method have the advantage of not triggering a recomputation of the metric value, but it has the disadvantage of returning a value that may not be the one corresponding to the current parameters. For GUI update purposes, this method is a good option, for mathematical validation you should rather call GetValue().

◆ GetCachedDerivative()

virtual const DerivativeType & itk::MultipleValuedNonLinearVnlOptimizer::GetCachedDerivative ( ) const

virtual

Return Cached Values. These method have the advantage of not triggering a recomputation of the metric value, but it has the disadvantage of returning a value that may not be the one corresponding to the current parameters. For GUI update purposes, this method is a good option, for mathematical validation you should rather call GetValue().

◆ GetCachedValue()

virtual const MeasureType & itk::MultipleValuedNonLinearVnlOptimizer::GetCachedValue ( ) const

virtual

Return Cached Values. These method have the advantage of not triggering a recomputation of the metric value, but it has the disadvantage of returning a value that may not be the one corresponding to the current parameters. For GUI update purposes, this method is a good option, for mathematical validation you should rather call GetValue().

◆ GetCostFunctionAdaptor() [1/2]

CostFunctionAdaptorType * itk::MultipleValuedNonLinearVnlOptimizer::GetCostFunctionAdaptor ( )

protected

◆ GetCostFunctionAdaptor() [2/2]

const CostFunctionAdaptorType * itk::MultipleValuedNonLinearVnlOptimizer::GetCostFunctionAdaptor ( ) const

protected

◆ GetNameOfClass()

const char * itk::MultipleValuedNonLinearVnlOptimizer::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::MultipleValuedNonLinearOptimizer.

◆ GetNonConstCostFunctionAdaptor()

CostFunctionAdaptorType * itk::MultipleValuedNonLinearVnlOptimizer::GetNonConstCostFunctionAdaptor ( ) const

protected

The purpose of this method is to get around the lack of const correctness in vnl cost_functions and optimizers

◆ GetUseCostFunctionGradient()

bool itk::MultipleValuedNonLinearVnlOptimizer::GetUseCostFunctionGradient ( ) const

◆ IterationReport()

void itk::MultipleValuedNonLinearVnlOptimizer::IterationReport ( const EventObject & event )

private

Callback function for the Command Observer

◆ PrintSelf()

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

overrideprotectedvirtual

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::MultipleValuedNonLinearOptimizer.

◆ SetCostFunction()

void itk::MultipleValuedNonLinearVnlOptimizer::SetCostFunction ( MultipleValuedCostFunction * costFunction )

overridepure virtual

Set the cost Function. This method has to be overloaded by derived classes because the CostFunctionAdaptor requires to know the number of parameters at construction time. This number of parameters is obtained at run-time from the itkCostFunction. As a consequence each derived optimizer should construct its own CostFunctionAdaptor when overloading this method

Implemented in itk::LevenbergMarquardtOptimizer.

◆ SetCostFunctionAdaptor()

void itk::MultipleValuedNonLinearVnlOptimizer::SetCostFunctionAdaptor ( CostFunctionAdaptorType * adaptor )

protected

◆ SetUseCostFunctionGradient()

void itk::MultipleValuedNonLinearVnlOptimizer::SetUseCostFunctionGradient ( bool )

Define if the Cost function should provide a customized Gradient computation or the gradient can be computed internally using a default approach

◆ UseCostFunctionGradientOff()

void itk::MultipleValuedNonLinearVnlOptimizer::UseCostFunctionGradientOff ( )

inline

Definition at line 79 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ UseCostFunctionGradientOn()

void itk::MultipleValuedNonLinearVnlOptimizer::UseCostFunctionGradientOn ( )

inline

Definition at line 73 of file itkMultipleValuedNonLinearVnlOptimizer.h.

Member Data Documentation

◆ m_CachedCurrentPosition

ParametersType itk::MultipleValuedNonLinearVnlOptimizer::m_CachedCurrentPosition {}

mutableprivate

Definition at line 137 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ m_CachedDerivative

DerivativeType itk::MultipleValuedNonLinearVnlOptimizer::m_CachedDerivative {}

mutableprivate

Definition at line 139 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ m_CachedValue

MeasureType itk::MultipleValuedNonLinearVnlOptimizer::m_CachedValue {}

mutableprivate

Definition at line 138 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ m_Command

CommandType::Pointer itk::MultipleValuedNonLinearVnlOptimizer::m_Command {}

private

Definition at line 135 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ m_CostFunctionAdaptor

std::unique_ptr<CostFunctionAdaptorType> itk::MultipleValuedNonLinearVnlOptimizer::m_CostFunctionAdaptor

private

Definition at line 132 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ m_UseGradient

bool itk::MultipleValuedNonLinearVnlOptimizer::m_UseGradient {}

private

Definition at line 133 of file itkMultipleValuedNonLinearVnlOptimizer.h.

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

itkMultipleValuedNonLinearVnlOptimizer.h

Detailed Description

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ CommandType

◆ ConstPointer

◆ CostFunctionAdaptorType

◆ ParametersType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ MultipleValuedNonLinearVnlOptimizer()

◆ ~MultipleValuedNonLinearVnlOptimizer()

Member Function Documentation

◆ GetCachedCurrentPosition()

◆ GetCachedDerivative()

◆ GetCachedValue()

◆ GetCostFunctionAdaptor() [1/2]

◆ GetCostFunctionAdaptor() [2/2]

◆ GetNameOfClass()

◆ GetNonConstCostFunctionAdaptor()

◆ GetUseCostFunctionGradient()

◆ IterationReport()

◆ PrintSelf()

◆ SetCostFunction()

◆ SetCostFunctionAdaptor()

◆ SetUseCostFunctionGradient()

◆ UseCostFunctionGradientOff()

◆ UseCostFunctionGradientOn()

Member Data Documentation

◆ m_CachedCurrentPosition

◆ m_CachedDerivative

◆ m_CachedValue

◆ m_Command

◆ m_CostFunctionAdaptor

◆ m_UseGradient