#include <itkCostFunction.h>

Inheritance diagram for itk::CostFunction:

Collaboration diagram for itk::CostFunction:

Detailed Description

Base class for cost functions intended to be used with Optimizers.

Definition at line 36 of file itkCostFunction.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef OptimizerParameters < ParametersValueType >	ParametersType

typedef double	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef CostFunction	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual const char *	GetNameOfClass () const

virtual unsigned int	GetNumberOfParameters (void) const =0

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

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

virtual LightObject::Pointer	CreateAnother () const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

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

Protected Member Functions
	CostFunction ()

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

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 Member Functions
	CostFunction (const Self &)

void	operator= (const Self &)

Additional Inherited Members
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

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

Definition at line 43 of file itkCostFunction.h.

typedef OptimizerParameters< ParametersValueType > itk::CostFunction::ParametersType

Definition at line 51 of file itkCostFunction.h.

typedef double itk::CostFunction::ParametersValueType

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

Definition at line 46 of file itkCostFunction.h.

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

Definition at line 42 of file itkCostFunction.h.

typedef CostFunction itk::CostFunction::Self

Standard class typedefs.

Definition at line 40 of file itkCostFunction.h.

typedef Object itk::CostFunction::Superclass

Definition at line 41 of file itkCostFunction.h.

Constructor & Destructor Documentation

itk::CostFunction::CostFunction ( )

inlineprotected

Definition at line 59 of file itkCostFunction.h.

virtual itk::CostFunction::~CostFunction ( )

inlineprotectedvirtual

Definition at line 60 of file itkCostFunction.h.

itk::CostFunction::CostFunction ( const Self & )

private

Member Function Documentation

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

virtual unsigned int itk::CostFunction::GetNumberOfParameters ( void ) const

pure virtual

Return the number of parameters required to compute this cost function. This method MUST be overloaded by derived classes.

Implemented in itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage >, itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TVirtualImage >, itk::ObjectToObjectMetric< TPointSet::PointDimension, TPointSet::PointDimension >, itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::ObjectToObjectMetricBase, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, and itk::CumulativeGaussianCostFunction.

void itk::CostFunction::operator= ( const Self & )

private

void itk::CostFunction::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::Object.

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

itkCostFunction.h

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation