ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions
itk::SingleValuedCostFunctionv4 Class Reference

#include <itkSingleValuedCostFunctionv4.h>

+ Inheritance diagram for itk::SingleValuedCostFunctionv4:
+ Collaboration diagram for itk::SingleValuedCostFunctionv4:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef Array
< ParametersValueType
DerivativeType
typedef double MeasureType
typedef Superclass::ParametersType ParametersType
typedef
Superclass::ParametersValueType 
ParametersValueType
typedef SmartPointer< SelfPointer
typedef SingleValuedCostFunctionv4 Self
typedef CostFunction Superclass

Public Member Functions

virtual const char * GetNameOfClass () const
virtual MeasureType GetValue () const =0
virtual void GetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const =0

Protected Member Functions

 SingleValuedCostFunctionv4 ()
virtual ~SingleValuedCostFunctionv4 ()

Private Member Functions

void operator= (const Self &)
 SingleValuedCostFunctionv4 (const Self &)

Detailed Description

This class is a base for a CostFunction that returns a single value.

This class differs from the SingleValuedCostFunction in that it is fine tunned for managing very large numbers of parameters. For example, to be used in conditions where the number of parameters is in the range of thousands or even millions. Due to the large number of parameters, the API of this class avoids any copying of the parameters array, and of the classes that have dimensionality related to the size of the parameters array.

As you look at the code of this class, keep in mind that the types ParametersType and DerivativeType will be some sort of array-like type with millions of elements.

Derived classes must provide implementations for: GetValue GetValueAndDerivative

Definition at line 48 of file itkSingleValuedCostFunctionv4.h.


Member Typedef Documentation


Constructor & Destructor Documentation

Definition at line 85 of file itkSingleValuedCostFunctionv4.h.

virtual itk::SingleValuedCostFunctionv4::~SingleValuedCostFunctionv4 ( ) [inline, protected, virtual]

Definition at line 86 of file itkSingleValuedCostFunctionv4.h.


Member Function Documentation

virtual const char* itk::SingleValuedCostFunctionv4::GetNameOfClass ( ) const [virtual]
virtual MeasureType itk::SingleValuedCostFunctionv4::GetValue ( ) const [pure virtual]
virtual void itk::SingleValuedCostFunctionv4::GetValueAndDerivative ( MeasureType value,
DerivativeType derivative 
) const [pure virtual]

This method returns the value and derivative of the cost function. derivative will be sized and allocated as needed by metric. If it's already proper size, no new allocation is done.

void itk::SingleValuedCostFunctionv4::operator= ( const Self ) [private]

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