#include <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
virtual const char *	GetNameOfClass () const

bool	GetUseCostFunctionGradient () const

void	SetCostFunction (MultipleValuedCostFunction *costFunction) override=0

void	SetUseCostFunctionGradient (bool)

void	UseCostFunctionGradientOff ()

void	UseCostFunctionGradientOn ()

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

virtual void	SetCostFunction (CostFunctionType *costFunction)

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

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

virtual const ParametersType &	GetInitialPosition () const

virtual void	SetInitialPosition (const ParametersType &param)

void	SetScales (const ScalesType &scales)

virtual const ScalesType &	GetScales () const

virtual const ScalesType &	GetInverseScales () const

virtual const ParametersType &	GetCurrentPosition () const

virtual void	StartOptimization ()

virtual const std::string	GetStopConditionDescription () const

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

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

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

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

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)

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 void	Delete ()

virtual int	GetReferenceCount () const

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

using	CostFunctionAdaptorType = MultipleValuedVnlCostFunctionAdaptor

using	CommandType = ReceptorMemberCommand< Self >

CostFunctionAdaptorType *	m_CostFunctionAdaptor

bool	m_UseGradient

CommandType::Pointer	m_Command

ParametersType	m_CachedCurrentPosition

MeasureType	m_CachedValue

DerivativeType	m_CachedDerivative

virtual const MeasureType &	GetCachedValue () const

virtual const DerivativeType &	GetCachedDerivative () const

virtual const ParametersType &	GetCachedCurrentPosition () const

	MultipleValuedNonLinearVnlOptimizer ()

	~MultipleValuedNonLinearVnlOptimizer () override

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

void	SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor)

const CostFunctionAdaptorType *	GetCostFunctionAdaptor () const

CostFunctionAdaptorType *	GetCostFunctionAdaptor ()

CostFunctionAdaptorType *	GetNonConstCostFunctionAdaptor () const

void	IterationReport (const EventObject &event)

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 Member Functions inherited from itk::MultipleValuedNonLinearOptimizer
	MultipleValuedNonLinearOptimizer ()

	~MultipleValuedNonLinearOptimizer () override=default

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

	~NonLinearOptimizer () override

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

	~Optimizer () override=default

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

virtual void	SetCurrentPosition (const ParametersType &param)

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

	~Object () override

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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 inherited from itk::MultipleValuedNonLinearOptimizer
CostFunctionPointer	m_CostFunction

Protected Attributes inherited from itk::Optimizer
bool	m_ScalesInitialized { false }

ParametersType	m_CurrentPosition

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

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 37 of file itkMultipleValuedNonLinearVnlOptimizer.h.

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 123 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ ConstPointer

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

Definition at line 46 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ CostFunctionAdaptorType

using itk::MultipleValuedNonLinearVnlOptimizer::CostFunctionAdaptorType = MultipleValuedVnlCostFunctionAdaptor

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 103 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 53 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ Pointer

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

Definition at line 45 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ Self

using itk::MultipleValuedNonLinearVnlOptimizer::Self = MultipleValuedNonLinearVnlOptimizer

Standard class type aliases.

Definition at line 43 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ Superclass

using itk::MultipleValuedNonLinearVnlOptimizer::Superclass = MultipleValuedNonLinearOptimizer

Definition at line 44 of file itkMultipleValuedNonLinearVnlOptimizer.h.

Constructor & Destructor Documentation

◆ MultipleValuedNonLinearVnlOptimizer()

itk::MultipleValuedNonLinearVnlOptimizer::MultipleValuedNonLinearVnlOptimizer ( )

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

◆ ~MultipleValuedNonLinearVnlOptimizer()

itk::MultipleValuedNonLinearVnlOptimizer::~MultipleValuedNonLinearVnlOptimizer ( )

overrideprotected

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

Member Function Documentation

◆ GetCachedCurrentPosition()

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

virtual

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

◆ GetCachedDerivative()

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

virtual

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

◆ 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

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

◆ GetCostFunctionAdaptor() [2/2]

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

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

◆ GetNameOfClass()

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::MultipleValuedNonLinearOptimizer.

Reimplemented in itk::LevenbergMarquardtOptimizer.

◆ 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

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

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

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

◆ 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 77 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ UseCostFunctionGradientOn()

void itk::MultipleValuedNonLinearVnlOptimizer::UseCostFunctionGradientOn ( )

inline

Definition at line 71 of file itkMultipleValuedNonLinearVnlOptimizer.h.

Member Data Documentation

◆ m_CachedCurrentPosition

ParametersType itk::MultipleValuedNonLinearVnlOptimizer::m_CachedCurrentPosition

mutableprivate

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 135 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ m_CachedDerivative

DerivativeType itk::MultipleValuedNonLinearVnlOptimizer::m_CachedDerivative

mutableprivate

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 137 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ m_CachedValue

MeasureType itk::MultipleValuedNonLinearVnlOptimizer::m_CachedValue

mutableprivate

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 136 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ m_Command

CommandType::Pointer itk::MultipleValuedNonLinearVnlOptimizer::m_Command

private

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 133 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ m_CostFunctionAdaptor

CostFunctionAdaptorType* itk::MultipleValuedNonLinearVnlOptimizer::m_CostFunctionAdaptor

private

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 130 of file itkMultipleValuedNonLinearVnlOptimizer.h.

◆ m_UseGradient

bool itk::MultipleValuedNonLinearVnlOptimizer::m_UseGradient

private

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 131 of file itkMultipleValuedNonLinearVnlOptimizer.h.

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

itkMultipleValuedNonLinearVnlOptimizer.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

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