itk::MultipleValuedCostFunction Class Reference

#include <itkMultipleValuedCostFunction.h>

Inheritance diagram for itk::MultipleValuedCostFunction:

Collaboration diagram for itk::MultipleValuedCostFunction:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Array2D< double >	DerivativeType
typedef Array< double >	MeasureType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef MultipleValuedCostFunction	Self
typedef CostFunction	Superclass
Public Types inherited from itk::CostFunction
typedef double	ParametersValueType
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0
virtual const char *	GetNameOfClass () const
virtual unsigned int	GetNumberOfValues (void) const =0
virtual MeasureType	GetValue (const ParametersType &parameters) const =0
Public Member Functions inherited from itk::CostFunction
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 unsigned long	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
	MultipleValuedCostFunction ()
virtual	~MultipleValuedCostFunction ()
Protected Member Functions inherited from itk::CostFunction
	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
	MultipleValuedCostFunction (const Self &)
void	operator= (const Self &)

---

Detailed Description

This class is a base for the CostFunctions returning a multiple values.

Definition at line 34 of file itkMultipleValuedCostFunction.h.

---

Member Typedef Documentation

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

Reimplemented from itk::CostFunction.

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

Definition at line 42 of file itkMultipleValuedCostFunction.h.

typedef Array2D< double > itk::MultipleValuedCostFunction::DerivativeType

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

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

Definition at line 57 of file itkMultipleValuedCostFunction.h.

typedef Array< double > itk::MultipleValuedCostFunction::MeasureType

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

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

Definition at line 53 of file itkMultipleValuedCostFunction.h.

typedef Superclass::ParametersType itk::MultipleValuedCostFunction::ParametersType

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

Reimplemented from itk::CostFunction.

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

Definition at line 45 of file itkMultipleValuedCostFunction.h.

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

Reimplemented from itk::CostFunction.

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

Definition at line 41 of file itkMultipleValuedCostFunction.h.

typedef MultipleValuedCostFunction itk::MultipleValuedCostFunction::Self

Standard class typedefs.

Reimplemented from itk::CostFunction.

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

Definition at line 39 of file itkMultipleValuedCostFunction.h.

typedef CostFunction itk::MultipleValuedCostFunction::Superclass

Reimplemented from itk::CostFunction.

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

Definition at line 40 of file itkMultipleValuedCostFunction.h.

---

Constructor & Destructor Documentation

itk::MultipleValuedCostFunction::MultipleValuedCostFunction ( )

inlineprotected

Definition at line 76 of file itkMultipleValuedCostFunction.h.

virtual itk::MultipleValuedCostFunction::~MultipleValuedCostFunction ( )

inlineprotectedvirtual

Definition at line 77 of file itkMultipleValuedCostFunction.h.

itk::MultipleValuedCostFunction::MultipleValuedCostFunction ( const Self &  )

private

---

Member Function Documentation

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

pure virtual

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

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::CostFunction.

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

virtual unsigned int itk::MultipleValuedCostFunction::GetNumberOfValues ( void  ) const

pure virtual

Return the number of values that are computed by the multivalued cost function. This method MUST be overloaded by derived classes

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

virtual MeasureType itk::MultipleValuedCostFunction::GetValue ( const ParametersType &  parameters ) const

pure virtual

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

Implemented in itk::CumulativeGaussianCostFunction.

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

private

Mutex lock to protect modification to the reference count

Reimplemented from itk::CostFunction.

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

---

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

• itkMultipleValuedCostFunction.h