itk::MultipleValuedVnlCostFunctionAdaptor Class Reference
[Numerics, Optimizers]

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

#include <itkMultipleValuedVnlCostFunctionAdaptor.h>

Collaboration diagram for itk::MultipleValuedVnlCostFunctionAdaptor:

[legend]List of all members.

Public Types
typedef vnl_vector< double >	InternalParametersType
typedef vnl_vector< double >	InternalMeasureType
typedef vnl_matrix< double >	InternalDerivativeType
typedef MultipleValuedCostFunction::MeasureType	MeasureType
typedef MultipleValuedCostFunction::ParametersType	ParametersType
typedef MultipleValuedCostFunction::DerivativeType	DerivativeType
typedef Array< double >	ScalesType
Public Member Functions
	MultipleValuedVnlCostFunctionAdaptor (unsigned int spaceDimension, unsigned int numberOfValues)
void	SetCostFunction (MultipleValuedCostFunction *costFunction)
const MultipleValuedCostFunction *	GetCostFunction (void) const
virtual void	f (const InternalParametersType &inparameters, InternalMeasureType &measures)
virtual void	gradf (const InternalParametersType &inparameters, InternalDerivativeType &gradient)
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	SetScales (const ScalesType &scales)
void	SetUseGradient (bool)
void	UseGradientOn ()
void	UseGradientOff ()
bool	GetUseGradient () const

---

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 36 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

---

Member Typedef Documentation

typedef MultipleValuedCostFunction::DerivativeType itk::MultipleValuedVnlCostFunctionAdaptor::DerivativeType

Derivatives of the MultipleValuedCostFunction Definition at line 57 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

typedef vnl_matrix<double> itk::MultipleValuedVnlCostFunctionAdaptor::InternalDerivativeType

InternalGradientType typedef. Definition at line 48 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

typedef vnl_vector<double> itk::MultipleValuedVnlCostFunctionAdaptor::InternalMeasureType

InternalMeasureType typedef. Definition at line 45 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

typedef vnl_vector<double> itk::MultipleValuedVnlCostFunctionAdaptor::InternalParametersType

InternalParametersType typedef. Definition at line 42 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

typedef MultipleValuedCostFunction::MeasureType itk::MultipleValuedVnlCostFunctionAdaptor::MeasureType

MeasureType of the MultipleValuedCostFunction Definition at line 51 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

typedef MultipleValuedCostFunction::ParametersType itk::MultipleValuedVnlCostFunctionAdaptor::ParametersType

Parameters of the MultipleValuedCostFunction Definition at line 54 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

typedef Array<double> itk::MultipleValuedVnlCostFunctionAdaptor::ScalesType

Scales typedef Definition at line 60 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

---

Constructor & Destructor Documentation

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

Constructor with size

---

Member Function Documentation

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

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

Delegate computation of the value to the CostFunction.

const MultipleValuedCostFunction* itk::MultipleValuedVnlCostFunctionAdaptor::GetCostFunction (  void   )  const [inline]

Get the CostFunction deriving from MultipleValuedCostFunction Definition at line 71 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

bool itk::MultipleValuedVnlCostFunctionAdaptor::GetUseGradient (   )  const

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

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

Delegate computation of the gradient to the costFunction.

void itk::MultipleValuedVnlCostFunctionAdaptor::SetCostFunction (  MultipleValuedCostFunction *  costFunction  )  [inline]

Set the CostFunction deriving from MultipleValuedCostFunction Definition at line 67 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 Referenced by UseGradientOff(), and UseGradientOn().

void itk::MultipleValuedVnlCostFunctionAdaptor::UseGradientOff (   )  [inline]

Define if the Cost function should provide a customized Gradient computation or the gradient can be computed internally using a default approach Definition at line 102 of file itkMultipleValuedVnlCostFunctionAdaptor.h. References SetUseGradient().

void itk::MultipleValuedVnlCostFunctionAdaptor::UseGradientOn (   )  [inline]

Define if the Cost function should provide a customized Gradient computation or the gradient can be computed internally using a default approach Definition at line 101 of file itkMultipleValuedVnlCostFunctionAdaptor.h. References SetUseGradient().

---

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

• itkMultipleValuedVnlCostFunctionAdaptor.h

---