Cost function for the Cumulative Gaussian Optimizer. More...

#include <itkCumulativeGaussianCostFunction.h>

Inheritance diagram for itk::CumulativeGaussianCostFunction:

Collaboration diagram for itk::CumulativeGaussianCostFunction:

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
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

double	CalculateFitError (MeasureType *setTestArray)

virtual ::itk::LightObject::Pointer	CreateAnother (void) 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

virtual void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual unsigned long	GetMTime () const

virtual const char *	GetNameOfClass () const

unsigned int	GetNumberOfParameters () const

unsigned int	GetNumberOfValues () const

virtual int	GetReferenceCount () const

MeasureType	GetValue (const ParametersType &parameters) const

MeasureType *	GetValue (ParametersType &parameters)

bool	HasObserver (const EventObject &event) const

void	Initialize (unsigned int rangeDimension)

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

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

static void	SetGlobalWarningDisplay (bool flag)

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	CumulativeGaussianCostFunction ()

virtual	~CumulativeGaussianCostFunction ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

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

Protected Attributes
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Private Attributes
MeasureType	m_Measure

MeasureType *	m_MeasurePointer

MeasureType *	m_OriginalDataArray

ParametersType	m_Parameters

unsigned int	m_RangeDimension

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 and upper : $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.

Member Typedef Documentation

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

Definition at line 58 of file itkCumulativeGaussianCostFunction.h.

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

Definition at line 69 of file itkCumulativeGaussianCostFunction.h.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.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.

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

Definition at line 57 of file itkCumulativeGaussianCostFunction.h.

typedef CumulativeGaussianCostFunction itk::CumulativeGaussianCostFunction::Self

Standard typedefs.

Definition at line 55 of file itkCumulativeGaussianCostFunction.h.

typedef MultipleValuedCostFunction itk::CumulativeGaussianCostFunction::Superclass

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 72 of file itkCumulativeGaussianCostFunction.h.

Constructor & Destructor Documentation

itk::CumulativeGaussianCostFunction::CumulativeGaussianCostFunction ( )

protected

Definition at line 27 of file itkCumulativeGaussianCostFunction.cxx.

itk::CumulativeGaussianCostFunction::~CumulativeGaussianCostFunction ( )

protectedvirtual

Definition at line 36 of file itkCumulativeGaussianCostFunction.cxx.

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

inherited

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::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)		const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void itk::LightObject::BreakOnError ( )

staticinherited

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

Definition at line 149 of file itkLightObject.cxx.

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

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

Definition at line 57 of file itkCumulativeGaussianCostFunction.cxx.

References itk::Array< TValueType >::GetNumberOfElements().

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.

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

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.

Delete a 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.

Definition at line 88 of file itkLightObject.cxx.

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

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

Definition at line 76 of file itkCumulativeGaussianCostFunction.cxx.

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.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

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

inline

Not necessary for this optimizer.

Definition at line 75 of file itkCumulativeGaussianCostFunction.h.

virtual void itk::MultipleValuedCostFunction::GetDerivative	(	const ParametersType &	parameters,
		DerivativeType &	derivative
	)		const

pure virtualinherited

This method returns the derivative of the cost function corresponding to the specified parameters This method MUST be overloaded by derived classes

Implemented in itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >.

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void )

inherited

Returns: A reference to this objects MetaDataDictionary.

Warning: This reference may be changed.

Definition at line 532 of file itkObject.cxx.

References NULL.

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void ) const

inherited

Returns: A constant reference to this objects MetaDataDictionary.

Definition at line 543 of file itkObject.cxx.

References NULL.

unsigned long itk::Object::GetMTime ( void ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), otb::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::MultipleValuedCostFunction.

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

virtual

Get the SpaceDimension.

Implements itk::CostFunction.

Definition at line 179 of file itkCumulativeGaussianCostFunction.cxx.

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

virtual

Get the number Range Dimension.

Implements itk::MultipleValuedCostFunction.

Definition at line 187 of file itkCumulativeGaussianCostFunction.cxx.

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

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

virtual

Return the values evaluated for the given parameters.

Implements itk::MultipleValuedCostFunction.

Definition at line 157 of file itkCumulativeGaussianCostFunction.cxx.

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

Return a pointer of values evaluated for the given parameters.

Definition at line 167 of file itkCumulativeGaussianCostFunction.cxx.

References itk::Array< TValueType >::SetSize().

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

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.

Definition at line 467 of file itkObject.cxx.

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

Initialize the arrays.

Definition at line 195 of file itkCumulativeGaussianCostFunction.cxx.

void itk::Object::InvokeEvent ( const EventObject & event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject & event ) const

inherited

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

Definition at line 457 of file itkObject.cxx.

void itk::Object::Modified ( void ) const

virtualinherited

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

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

static Pointer itk::CumulativeGaussianCostFunction::New ( )

static

Method for creation through the object factory.

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

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)		const

protectedinherited

Definition at line 478 of file itkObject.cxx.

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.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::CostFunction.

Definition at line 204 of file itkCumulativeGaussianCostFunction.cxx.

void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::Object::Register ( ) const

virtualinherited

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

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

void itk::Object::RemoveAllObservers ( )

inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::Object::RemoveObserver ( unsigned long tag )

inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

void itk::Object::SetDebug ( bool debugFlag ) const

inherited

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

Definition at line 275 of file itkObject.cxx.

void itk::Object::SetGlobalWarningDisplay ( bool val )

staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

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

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs )

inherited

Returns: Set the MetaDataDictionary

Definition at line 554 of file itkObject.cxx.

References NULL.

Referenced by otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), and otb::Image< TPixel, VImageDimension >::CopyInformation().

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

Set the original data array.

Definition at line 44 of file itkCumulativeGaussianCostFunction.cxx.

References itk::Array< TValueType >::GetNumberOfElements().

void itk::Object::SetReferenceCount ( int ref )

virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

void itk::Object::UnRegister ( ) const

virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().

Member Data Documentation

MeasureType itk::CumulativeGaussianCostFunction::m_Measure

mutableprivate

Different arrays.

Definition at line 117 of file itkCumulativeGaussianCostFunction.h.

MeasureType* itk::CumulativeGaussianCostFunction::m_MeasurePointer

mutableprivate

Definition at line 118 of file itkCumulativeGaussianCostFunction.h.

MeasureType* itk::CumulativeGaussianCostFunction::m_OriginalDataArray

private

Pointer to the original data array.

Definition at line 111 of file itkCumulativeGaussianCostFunction.h.

ParametersType itk::CumulativeGaussianCostFunction::m_Parameters

mutableprivate

Definition at line 119 of file itkCumulativeGaussianCostFunction.h.

unsigned int itk::CumulativeGaussianCostFunction::m_RangeDimension

private

Number of data samples.

Definition at line 114 of file itkCumulativeGaussianCostFunction.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount

mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock

mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation