itk::MultipleValuedVnlCostFunctionAdaptor Class Reference

#include <itkMultipleValuedVnlCostFunctionAdaptor.h>

Inheritance diagram for itk::MultipleValuedVnlCostFunctionAdaptor:

Collaboration diagram for itk::MultipleValuedVnlCostFunctionAdaptor:

Detailed Description

This class is an Adaptor that allows to pass itk::MultipleValuedCostFunctions to vnl_optimizers expecting a vnl_cost_function.

This class returns a single valued.

Definition at line 37 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

Public Types
using	DerivativeType = MultipleValuedCostFunction::DerivativeType
using	InternalDerivativeType = vnl_matrix< double >
using	InternalMeasureType = vnl_vector< double >
using	InternalParametersType = vnl_vector< double >
using	MeasureType = MultipleValuedCostFunction::MeasureType
using	ParametersType = MultipleValuedCostFunction::ParametersType
using	ScalesType = Array< double >

Public Member Functions
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	compute (const InternalParametersType &x, InternalMeasureType *f, InternalDerivativeType *g)
void	ConvertExternalToInternalGradient (const DerivativeType &input, InternalDerivativeType &output)
void	ConvertExternalToInternalMeasures (const MeasureType &input, InternalMeasureType &output)
void	f (const InternalParametersType &inparameters, InternalMeasureType &measures) override
const ParametersType &	GetCachedCurrentParameters () const
const DerivativeType &	GetCachedDerivative () const
const MeasureType &	GetCachedValue () const
const MultipleValuedCostFunction *	GetCostFunction () const
bool	GetUseGradient () const
void	gradf (const InternalParametersType &inparameters, InternalDerivativeType &gradient) override
	MultipleValuedVnlCostFunctionAdaptor (unsigned int spaceDimension, unsigned int numberOfValues)
void	SetCostFunction (MultipleValuedCostFunction *costFunction)
void	SetScales (const ScalesType &scales)
void	SetUseGradient (bool)
void	UseGradientOff ()
void	UseGradientOn ()

Protected Member Functions
void	ReportIteration (const EventObject &event) const

Private Member Functions
virtual const ScalesType &	GetInverseScales () const

Private Attributes
ParametersType	m_CachedCurrentParameters
DerivativeType	m_CachedDerivative
MeasureType	m_CachedValue
MultipleValuedCostFunction::Pointer	m_CostFunction
ScalesType	m_InverseScales
Object::Pointer	m_Reporter
bool	m_ScalesInitialized

Member Typedef Documentation

using itk::MultipleValuedVnlCostFunctionAdaptor::DerivativeType = MultipleValuedCostFunction::DerivativeType

Derivatives of the MultipleValuedCostFunction

Definition at line 58 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

using itk::MultipleValuedVnlCostFunctionAdaptor::InternalDerivativeType = vnl_matrix< double >

InternalGradientType type alias.

Definition at line 49 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

using itk::MultipleValuedVnlCostFunctionAdaptor::InternalMeasureType = vnl_vector< double >

InternalMeasureType type alias.

Definition at line 46 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

using itk::MultipleValuedVnlCostFunctionAdaptor::InternalParametersType = vnl_vector< double >

InternalParametersType type alias.

Definition at line 43 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

using itk::MultipleValuedVnlCostFunctionAdaptor::MeasureType = MultipleValuedCostFunction::MeasureType

MeasureType of the MultipleValuedCostFunction

Definition at line 52 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

using itk::MultipleValuedVnlCostFunctionAdaptor::ParametersType = MultipleValuedCostFunction::ParametersType

Parameters of the MultipleValuedCostFunction

Definition at line 55 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

using itk::MultipleValuedVnlCostFunctionAdaptor::ScalesType = Array< double >

Scales type alias

Definition at line 61 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

Constructor & Destructor Documentation

itk::MultipleValuedVnlCostFunctionAdaptor::MultipleValuedVnlCostFunctionAdaptor	(	unsigned int	spaceDimension,
		unsigned int	numberOfValues
	)

Constructor with size

Member Function Documentation

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

This AddObserver method allows to simulate that this class derives from an itkObject for the purpose of reporting iteration events. The goal of this method is to allow ITK-vnl optimizer adaptors to get iteration events despite the fact that VNL does not provide callbacks.

virtual void itk::MultipleValuedVnlCostFunctionAdaptor::compute ( const InternalParametersType &  x, InternalMeasureType *  f, InternalDerivativeType *  g  )

virtual

Delegate computation of value and gradient to the costFunction.

void itk::MultipleValuedVnlCostFunctionAdaptor::ConvertExternalToInternalGradient	(	const DerivativeType &	input,
		InternalDerivativeType &	output
	)

Convert external derviative measures into internal type

void itk::MultipleValuedVnlCostFunctionAdaptor::ConvertExternalToInternalMeasures	(	const MeasureType &	input,
		InternalMeasureType &	output
	)

Convert external measures into internal type

void itk::MultipleValuedVnlCostFunctionAdaptor::f ( const InternalParametersType &  inparameters, InternalMeasureType &  measures  )

override

Delegate computation of the value to the CostFunction.

const ParametersType& itk::MultipleValuedVnlCostFunctionAdaptor::GetCachedCurrentParameters

(

)

const

const DerivativeType& itk::MultipleValuedVnlCostFunctionAdaptor::GetCachedDerivative

(

)

const

const MeasureType& itk::MultipleValuedVnlCostFunctionAdaptor::GetCachedValue

(

)

const

Return the value of the last evaluation to the value of the cost function. Note that this method DOES NOT triggers a computation of the function or the derivatives, it only returns previous values. Therefore the values here are only valid after you invoke the f() or gradf() methods.

const MultipleValuedCostFunction* itk::MultipleValuedVnlCostFunctionAdaptor::GetCostFunction ( ) const

inline

Get the CostFunction deriving from MultipleValuedCostFunction

Definition at line 72 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

virtual const ScalesType& itk::MultipleValuedVnlCostFunctionAdaptor::GetInverseScales ( ) const

privatevirtual

Get current parameters scaling.

bool itk::MultipleValuedVnlCostFunctionAdaptor::GetUseGradient

(

)

const

void itk::MultipleValuedVnlCostFunctionAdaptor::gradf ( const InternalParametersType &  inparameters, InternalDerivativeType &  gradient  )

override

Delegate computation of the gradient to the costFunction.

void itk::MultipleValuedVnlCostFunctionAdaptor::ReportIteration ( const EventObject &  event ) const

protected

This method is intended to be called by the derived classes in order to notify of an iteration event to any Command/Observers

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

inline

Set the CostFunction deriving from MultipleValuedCostFunction

Definition at line 68 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

void itk::MultipleValuedVnlCostFunctionAdaptor::SetScales

(

const ScalesType &

scales

)

Set current parameters scaling.

void itk::MultipleValuedVnlCostFunctionAdaptor::SetUseGradient

(

bool

)

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

void itk::MultipleValuedVnlCostFunctionAdaptor::UseGradientOff ( )

inline

Definition at line 104 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

void itk::MultipleValuedVnlCostFunctionAdaptor::UseGradientOn ( )

inline

Definition at line 103 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

Member Data Documentation

ParametersType itk::MultipleValuedVnlCostFunctionAdaptor::m_CachedCurrentParameters

mutableprivate

Definition at line 145 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

DerivativeType itk::MultipleValuedVnlCostFunctionAdaptor::m_CachedDerivative

mutableprivate

Definition at line 144 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

MeasureType itk::MultipleValuedVnlCostFunctionAdaptor::m_CachedValue

mutableprivate

Definition at line 143 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

MultipleValuedCostFunction::Pointer itk::MultipleValuedVnlCostFunctionAdaptor::m_CostFunction

private

Definition at line 135 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

ScalesType itk::MultipleValuedVnlCostFunctionAdaptor::m_InverseScales

private

Definition at line 140 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

Object::Pointer itk::MultipleValuedVnlCostFunctionAdaptor::m_Reporter

private

Definition at line 141 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

bool itk::MultipleValuedVnlCostFunctionAdaptor::m_ScalesInitialized

private

Definition at line 139 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

---

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

• itkMultipleValuedVnlCostFunctionAdaptor.h