ITK  4.4.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::CumulativeGaussianCostFunction Class Reference

#include <itkCumulativeGaussianCostFunction.h>

+ Inheritance diagram for itk::CumulativeGaussianCostFunction:
+ Collaboration diagram for itk::CumulativeGaussianCostFunction:

Detailed Description

Cost function for the Cumulative Gaussian Optimizer.

The Cumulative Gaussian is defined as the integral of a normalized Gaussian over the domain $ [-\infty, \infty] $.

Let G(x) be the normalized Gaussian defined as
$ G(x) = \frac{1}{{\sigma \sqrt {2\pi } }}e^{ - \frac{{\left( {x - \mu } \right)^2 }}{{2\sigma ^2 }}} $. The Cumulative Gaussian, is acquired by integrating G(x) then scaling and offseting it by the lower asymptotes $ I_1 $ and upper $ I_2 $: $ C\left( x \right) = I_1 + \frac{{I_2 - I_1 }}{2}\left( {1 + erf\left( {\frac{{x - \mu }}{{\sigma \sqrt 2 }}} \right)} \right) $, where $ C\left( { - \infty } \right) = I_1 $ and $ C\left( \infty \right) = I_2 $.
C(x) can only be tabulated since it's a variation of the
error function. It is included in this class as the function EvaluateCumulativeGaussian, where the argument of the function is $ {\frac{{x - \mu }}{{\sigma \sqrt 2 }}} $.

Definition at line 50 of file itkCumulativeGaussianCostFunction.h.

Public Types

enum  { SpaceDimension = 4 }
 
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::DerivativeType DerivativeType
 
typedef Superclass::MeasureType MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef
CumulativeGaussianCostFunction 
Self
 
typedef MultipleValuedCostFunction Superclass
 
- Public Types inherited from itk::MultipleValuedCostFunction
typedef SmartPointer< const SelfConstPointer
 
typedef Array2D< double > DerivativeType
 
typedef Array< double > MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef MultipleValuedCostFunction Self
 
typedef CostFunction Superclass
 
- Public Types inherited from itk::CostFunction
typedef SmartPointer< const SelfConstPointer
 
typedef OptimizerParameters
< ParametersValueType
ParametersType
 
typedef double ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef CostFunction Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

double CalculateFitError (MeasureType *setTestArray)
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
double EvaluateCumulativeGaussian (double argument) const
 
void GetDerivative (const ParametersType &, DerivativeType &) const
 
virtual const char * GetNameOfClass () const
 
unsigned int GetNumberOfParameters () const
 
unsigned int GetNumberOfValues () const
 
MeasureType GetValue (const ParametersType &parameters) const
 
MeasureTypeGetValuePointer (ParametersType &parameters)
 
void Initialize (unsigned int rangeDimension)
 
void SetOriginalDataArray (MeasureType *setOriginalDataArray)
 
- Public Member Functions inherited from itk::MultipleValuedCostFunction
virtual void GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 CumulativeGaussianCostFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual ~CumulativeGaussianCostFunction ()
 
- Protected Member Functions inherited from itk::MultipleValuedCostFunction
 MultipleValuedCostFunction ()
 
virtual ~MultipleValuedCostFunction ()
 
- Protected Member Functions inherited from itk::CostFunction
 CostFunction ()
 
virtual ~CostFunction ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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 ()
 

Private Attributes

MeasureType m_Measure
 
MeasureTypem_MeasurePointer
 
MeasureTypem_OriginalDataArray
 
ParametersType m_Parameters
 
unsigned int m_RangeDimension
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Member Typedef Documentation

Definition at line 58 of file itkCumulativeGaussianCostFunction.h.

typedef Superclass::DerivativeType itk::CumulativeGaussianCostFunction::DerivativeType

Definition at line 69 of file itkCumulativeGaussianCostFunction.h.

typedef Superclass::MeasureType itk::CumulativeGaussianCostFunction::MeasureType

Definition at line 68 of file itkCumulativeGaussianCostFunction.h.

typedef Superclass::ParametersType itk::CumulativeGaussianCostFunction::ParametersType

Array Typedefs.

Definition at line 64 of file itkCumulativeGaussianCostFunction.h.

Definition at line 57 of file itkCumulativeGaussianCostFunction.h.

Standard typedefs.

Definition at line 55 of file itkCumulativeGaussianCostFunction.h.

Definition at line 56 of file itkCumulativeGaussianCostFunction.h.

Member Enumeration Documentation

anonymous enum

The dimensions of parameter space; mean, standard deviation, lower and upper asymptotes.

Enumerator
SpaceDimension 

Definition at line 73 of file itkCumulativeGaussianCostFunction.h.

Constructor & Destructor Documentation

itk::CumulativeGaussianCostFunction::CumulativeGaussianCostFunction ( )
protected
virtual itk::CumulativeGaussianCostFunction::~CumulativeGaussianCostFunction ( )
protectedvirtual

Member Function Documentation

double itk::CumulativeGaussianCostFunction::CalculateFitError ( MeasureType setTestArray)

Calculate a fit error between the data and the fit curve.

virtual::itk::LightObject::Pointer itk::CumulativeGaussianCostFunction::CreateAnother ( void  ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

double itk::CumulativeGaussianCostFunction::EvaluateCumulativeGaussian ( double  argument) const

Given the argument of a Cumulative Gaussian, return its value.

void itk::CumulativeGaussianCostFunction::GetDerivative ( const ParametersType ,
DerivativeType  
) const
inline

Not necessary for this optimizer.

Definition at line 76 of file itkCumulativeGaussianCostFunction.h.

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

Run-time type information (and related methods).

Reimplemented from itk::MultipleValuedCostFunction.

unsigned int itk::CumulativeGaussianCostFunction::GetNumberOfParameters ( ) const
virtual

Get the SpaceDimension.

Implements itk::CostFunction.

unsigned int itk::CumulativeGaussianCostFunction::GetNumberOfValues ( ) const
virtual

Get the number Range Dimension.

Implements itk::MultipleValuedCostFunction.

MeasureType itk::CumulativeGaussianCostFunction::GetValue ( const ParametersType parameters) const
virtual

Return the values evaluated for the given parameters.

Implements itk::MultipleValuedCostFunction.

MeasureType* itk::CumulativeGaussianCostFunction::GetValuePointer ( ParametersType parameters)

Return a pointer of values evaluated for the given parameters.

void itk::CumulativeGaussianCostFunction::Initialize ( unsigned int  rangeDimension)

Initialize the arrays.

static Pointer itk::CumulativeGaussianCostFunction::New ( )
static

Method for creation through the object factory.

void itk::CumulativeGaussianCostFunction::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::CostFunction.

void itk::CumulativeGaussianCostFunction::SetOriginalDataArray ( MeasureType setOriginalDataArray)

Set the original data array.

Member Data Documentation

MeasureType itk::CumulativeGaussianCostFunction::m_Measure
mutableprivate

Different arrays.

Definition at line 118 of file itkCumulativeGaussianCostFunction.h.

MeasureType* itk::CumulativeGaussianCostFunction::m_MeasurePointer
mutableprivate

Definition at line 119 of file itkCumulativeGaussianCostFunction.h.

MeasureType* itk::CumulativeGaussianCostFunction::m_OriginalDataArray
private

Pointer to the original data array.

Definition at line 112 of file itkCumulativeGaussianCostFunction.h.

ParametersType itk::CumulativeGaussianCostFunction::m_Parameters
mutableprivate

Definition at line 120 of file itkCumulativeGaussianCostFunction.h.

unsigned int itk::CumulativeGaussianCostFunction::m_RangeDimension
private

Number of data samples.

Definition at line 115 of file itkCumulativeGaussianCostFunction.h.


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