Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts
itk::CumulativeGaussianCostFunction

itk::CumulativeGaussianCostFunction Class Reference
[Numerics]

#include <itkCumulativeGaussianCostFunction.h>

Inheritance diagram for itk::CumulativeGaussianCostFunction:

Inheritance graph
[legend]
Collaboration diagram for itk::CumulativeGaussianCostFunction:

Collaboration graph
[legend]
List of all members.

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 }}} $ .
Cost Functions

Definition at line 50 of file itkCumulativeGaussianCostFunction.h.

Public Types

enum  { SpaceDimension = 4 }
typedef SmartPointer< const
Self > 		ConstPointer
typedef Superclass::DerivativeType DerivativeType
typedef Superclass::MeasureType MeasureType
typedef Superclass::ParametersType ParametersType
typedef double ParametersValueType
typedef SmartPointer< Self > Pointer
typedef CumulativeGaussianCostFunction Self
typedef MultipleValuedCostFunction Superclass

Public Member Functions

double CalculateFitError (MeasureType *setTestArray)
virtual LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
double EvaluateCumulativeGaussian (double argument) const
Command * GetCommand (unsigned long tag)
bool GetDebug () const
void GetDerivative (const ParametersType &, DerivativeType &) const
const MetaDataDictionary & GetMetaDataDictionary (void) const
MetaDataDictionary & GetMetaDataDictionary (void)
virtual unsigned long GetMTime () const
virtual const char * GetNameOfClass () const
unsigned int GetNumberOfParameters () const
unsigned int GetNumberOfValues () const
virtual int GetReferenceCount () const
MeasureType * GetValue (ParametersType &parameters)
MeasureType GetValue (const ParametersType &parameters) const
bool HasObserver (const EventObject &event) const
void Initialize (unsigned int rangeDimension)
void InvokeEvent (const EventObject &) const
void InvokeEvent (const EventObject &)
virtual void Modified () const
void Print (std::ostream &os, Indent indent=0) const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
void SetOriginalDataArray (MeasureType *setOriginalDataArray)
virtual void SetReferenceCount (int)
virtual void UnRegister () const

Static Public Member Functions

static void BreakOnError ()
static bool GetGlobalWarningDisplay ()
static void GlobalWarningDisplayOff ()
static void GlobalWarningDisplayOn ()
static Pointer New ()
This is a global flag that
controls whether any warning
*or error messages are displayed
*static void 		SetGlobalWarningDisplay (bool flag)

Public Attributes

Allow people to add remove
invoke observers(callbacks)
to any ITK *object.This is
an implementation of the subject/observer design *pattern.An
observer is added by specifying
an event to respond to *and
an itk unsigned lon 		AddObserver )(const EventObject &event, Command *) const
This is a global flag that
controls whether any 		debug

Protected Member Functions

 CumulativeGaussianCostFunction ()
bool PrintObservers (std::ostream &os, Indent indent) const
void PrintSelf (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~CumulativeGaussianCostFunction ()

Protected Attributes

int m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
Methods invoked by virtual
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.*/virtual
void PrintSelf(std voi 		PrintHeader )(std::ostream &os, Indent indent) const

Member Typedef Documentation

typedef SmartPointer<const Self> itk::CumulativeGaussianCostFunction::ConstPointer
 

Reimplemented from itk::MultipleValuedCostFunction.

Definition at line 58 of file itkCumulativeGaussianCostFunction.h.

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

GradientType typedef. It defines a type used to return the cost function derivative.

Reimplemented from itk::MultipleValuedCostFunction.

Definition at line 66 of file itkCumulativeGaussianCostFunction.h.

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

MeasureType typedef. It defines a type used to return the cost function value.

Reimplemented from itk::MultipleValuedCostFunction.

Definition at line 65 of file itkCumulativeGaussianCostFunction.h.

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

Array Typedefs.

Reimplemented from itk::MultipleValuedCostFunction.

Definition at line 61 of file itkCumulativeGaussianCostFunction.h.

typedef double itk::CostFunction::ParametersValueType [inherited]
 

ParametersType typedef. It defines a position in the optimization search space.

Definition at line 46 of file itkCostFunction.h.

typedef SmartPointer<Self> itk::CumulativeGaussianCostFunction::Pointer
 

Reimplemented from itk::MultipleValuedCostFunction.

Definition at line 57 of file itkCumulativeGaussianCostFunction.h.

typedef CumulativeGaussianCostFunction itk::CumulativeGaussianCostFunction::Self
 

Standard typedefs.

Reimplemented from itk::MultipleValuedCostFunction.

Definition at line 55 of file itkCumulativeGaussianCostFunction.h.

typedef MultipleValuedCostFunction itk::CumulativeGaussianCostFunction::Superclass
 

Reimplemented from itk::MultipleValuedCostFunction.

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.

Enumeration values:
SpaceDimension 

Definition at line 69 of file itkCumulativeGaussianCostFunction.h.

Constructor & Destructor Documentation

itk::CumulativeGaussianCostFunction::CumulativeGaussianCostFunction (   )  [protected]
 

virtual itk::CumulativeGaussianCostFunction::~CumulativeGaussianCostFunction (   )  [protected, virtual]
 

Member Function Documentation

static void itk::LightObject::BreakOnError (   )  [static, inherited]
 

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

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

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

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]
 

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::LightObject.

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]
 

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]
 

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]
 

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

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

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

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]
 

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug (   )  const [inherited]
 

Get the value of the debug flag.

void itk::CumulativeGaussianCostFunction::GetDerivative (  const ParametersType &  ,
DerivativeType & 
)  const [inline, virtual]
 

Not necessary for this optimizer.

Implements itk::MultipleValuedCostFunction.

Definition at line 72 of file itkCumulativeGaussianCostFunction.h.

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]
 

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]
 

Returns:
A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]
 

Returns:
A reference to this objects MetaDataDictionary.
Warning:
This reference may be changed.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]
 

Return this objects modified time.

Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

virtual const char* itk::MultipleValuedCostFunction::GetNameOfClass (   )  const [virtual, inherited]
 

Run-time type information (and related methods).

Reimplemented from itk::CostFunction.

Reimplemented in itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >, and itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >.

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.

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]
 

Gets the reference count on this object.

Definition at line 98 of file itkLightObject.h.

MeasureType* itk::CumulativeGaussianCostFunction::GetValue (  ParametersType &  parameters  ) 
 

Return a pointer of values evaluated for the given parameters.

MeasureType itk::CumulativeGaussianCostFunction::GetValue (  const ParametersType &  parameters  )  const [virtual]
 

Return the values evaluated for the given parameters.

Implements itk::MultipleValuedCostFunction.

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]
 

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]
 

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]
 

Return true if an observer is registered for this event.

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

Initialize the arrays.

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]
 

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]
 

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified (   )  const [virtual, inherited]
 

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

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

Method for creation through the object factory.

Reimplemented from itk::Object.

void itk::LightObject::Print (  std::ostream &  os,
Indent  indent = 0
)  const [inherited]
 

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os,
Indent  indent
)  const [protected, inherited]
 

void itk::CumulativeGaussianCostFunction::PrintSelf (  std::ostream &  os,
Indent  indent
)  const [protected, virtual]
 

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.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os,
Indent  indent
)  const [protected, virtual, inherited]
 

virtual void itk::Object::Register (   )  const [virtual, inherited]
 

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]
 

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]
 

Remove the observer with this tag value.

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]
 

Set the value of the debug flag. A non-zero value turns debugging on.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]
 

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]
 

Returns:
Set the MetaDataDictionary

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

Set the original data array.

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]
 

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]
 

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]
 

This is a global flag that controls whether any itk::Object::debug [inherited]
 

Definition at line 94 of file itkObject.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]
 

Number of uses of this object by other objects.

Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]
 

Mutex lock to protect modification to the reference count

Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]
 

The documentation for this class was generated from the following file:
Generated at Sun Jul 9 19:25:14 2006 for ITK by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2000