ITK  4.4.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
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 36 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

Public Types

typedef vnl_matrix< double > InternalDerivativeType
typedef vnl_vector< double > InternalMeasureType
typedef vnl_vector< double > InternalParametersType
typedef Array< double > ScalesType

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)
virtual void f (const InternalParametersType &inparameters, InternalMeasureType &measures)
const ParametersTypeGetCachedCurrentParameters () const
const DerivativeTypeGetCachedDerivative () const
const MeasureTypeGetCachedValue () const
const MultipleValuedCostFunctionGetCostFunction (void) const
bool GetUseGradient () const
virtual void gradf (const InternalParametersType &inparameters, InternalDerivativeType &gradient)
 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 Attributes

ParametersType m_CachedCurrentParameters
DerivativeType m_CachedDerivative
MeasureType m_CachedValue
MultipleValuedCostFunction::Pointer m_CostFunction
Object::Pointer m_Reporter
ScalesType m_Scales
bool m_ScalesInitialized

Member Typedef Documentation

Derivatives of the MultipleValuedCostFunction

Definition at line 57 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

InternalGradientType typedef.

Definition at line 48 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

InternalMeasureType typedef.

Definition at line 45 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

InternalParametersType typedef.

Definition at line 42 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

MeasureType of the MultipleValuedCostFunction

Definition at line 51 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

Parameters of the MultipleValuedCostFunction

Definition at line 54 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

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

unsigned long itk::MultipleValuedVnlCostFunctionAdaptor::AddObserver ( const EventObject event,
) 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 

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 

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

Get the CostFunction deriving from MultipleValuedCostFunction

Definition at line 71 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

bool itk::MultipleValuedVnlCostFunctionAdaptor::GetUseGradient ( ) const
virtual void itk::MultipleValuedVnlCostFunctionAdaptor::gradf ( const InternalParametersType inparameters,
InternalDerivativeType gradient 

Delegate computation of the gradient to the costFunction.

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

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)

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

void itk::MultipleValuedVnlCostFunctionAdaptor::UseGradientOff ( )

Definition at line 103 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

void itk::MultipleValuedVnlCostFunctionAdaptor::UseGradientOn ( )

Definition at line 102 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

Member Data Documentation

ParametersType itk::MultipleValuedVnlCostFunctionAdaptor::m_CachedCurrentParameters

Definition at line 141 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

DerivativeType itk::MultipleValuedVnlCostFunctionAdaptor::m_CachedDerivative

Definition at line 140 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

MeasureType itk::MultipleValuedVnlCostFunctionAdaptor::m_CachedValue

Definition at line 139 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

MultipleValuedCostFunction::Pointer itk::MultipleValuedVnlCostFunctionAdaptor::m_CostFunction

Definition at line 133 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

Object::Pointer itk::MultipleValuedVnlCostFunctionAdaptor::m_Reporter

Definition at line 137 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

ScalesType itk::MultipleValuedVnlCostFunctionAdaptor::m_Scales

Definition at line 136 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

bool itk::MultipleValuedVnlCostFunctionAdaptor::m_ScalesInitialized

Definition at line 135 of file itkMultipleValuedVnlCostFunctionAdaptor.h.

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