itk::Statistics::DistanceToCentroidMembershipFunction< TVector > Class Template Reference

#include <itkDistanceToCentroidMembershipFunction.h>

Inheritance diagram for itk::Statistics::DistanceToCentroidMembershipFunction< TVector >:

Collaboration diagram for itk::Statistics::DistanceToCentroidMembershipFunction< TVector >:

Detailed Description

template<class TVector>
class itk::Statistics::DistanceToCentroidMembershipFunction< TVector >

DistanceToCentroidMembershipFunction models class membership using a distance metric.

DistanceToCentroidMembershipFunction is a subclass of MembershipFunctionBase that models class membership using the distance to the centroid of the class. A choice of distance metric can be specified using the SetDistanceMetric() method. Options include EuclideanDistanceMetric, EuclideanSquaredDistanceMetric, and ManhattenDistanceMetric. The centroid of the class is specified using the SetCentroid() method. Any other parameters to control the distance function evaluation have to be set directly on the distance function itself.

Definition at line 45 of file itkDistanceToCentroidMembershipFunction.h.

Public Types
typedef DistanceMetricType::OriginType	CentroidType
typedef SmartPointer< const Self >	ConstPointer
typedef DistanceMetricType::Pointer	DistanceMetricPointer
typedef DistanceMetric < MeasurementVectorType >	DistanceMetricType
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef TVector	MeasurementVectorType
typedef Superclass::Pointer	MembershipFunctionPointer
typedef SmartPointer< Self >	Pointer
typedef DistanceToCentroidMembershipFunction	Self
typedef MembershipFunctionBase < TVector >	Superclass
Public Types inherited from itk::Statistics::MembershipFunctionBase< TVector >
typedef SmartPointer< const Self >	ConstPointer
typedef unsigned int	MeasurementVectorSizeType
typedef TVector	MeasurementVectorType
typedef SmartPointer< Self >	Pointer
typedef MembershipFunctionBase	Self
typedef FunctionBase< TVector, double >	Superclass
Public Types inherited from itk::FunctionBase< TVector, double >
typedef SmartPointer< const Self >	ConstPointer
typedef TVector	InputType
typedef double	OutputType
typedef SmartPointer< Self >	Pointer
typedef FunctionBase	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
double	Evaluate (const MeasurementVectorType &measurement) const
const CentroidType &	GetCentroid () const
virtual const DistanceMetricType *	GetDistanceMetric () const
virtual DistanceMetricType *	GetModifiableDistanceMetric ()
void	SetCentroid (const CentroidType &centroid)
virtual void	SetDistanceMetric (DistanceMetricType *_arg)
virtual void	SetMeasurementVectorSize (MeasurementVectorSizeType)
Public Member Functions inherited from itk::Statistics::MembershipFunctionBase< TVector >
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
virtual void	SetMeasurementVectorSize (MeasurementVectorSizeType s)

Protected Member Functions
	DistanceToCentroidMembershipFunction (void)
virtual LightObject::Pointer	InternalClone () const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~DistanceToCentroidMembershipFunction (void)
Protected Member Functions inherited from itk::Statistics::MembershipFunctionBase< TVector >
	MembershipFunctionBase ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~MembershipFunctionBase (void)
Protected Member Functions inherited from itk::FunctionBase< TVector, double >
	FunctionBase ()
	~FunctionBase ()
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
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
	DistanceToCentroidMembershipFunction (const Self &)
void	operator= (const Self &)

Private Attributes
DistanceMetricPointer	m_DistanceMetric
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
static Pointer	New ()

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

template<class TVector >

typedef DistanceMetricType::OriginType itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::CentroidType

Definition at line 77 of file itkDistanceToCentroidMembershipFunction.h.

template<class TVector >

typedef SmartPointer< const Self > itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::ConstPointer

Definition at line 53 of file itkDistanceToCentroidMembershipFunction.h.

template<class TVector >

typedef DistanceMetricType::Pointer itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::DistanceMetricPointer

Definition at line 76 of file itkDistanceToCentroidMembershipFunction.h.

template<class TVector >

typedef DistanceMetric< MeasurementVectorType > itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::DistanceMetricType

Type of the DistanceMetric to use

Definition at line 75 of file itkDistanceToCentroidMembershipFunction.h.

template<class TVector >

typedef Superclass::MeasurementVectorSizeType itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::MeasurementVectorSizeType

Typedef to represent the length of measurement vectors

Definition at line 69 of file itkDistanceToCentroidMembershipFunction.h.

template<class TVector >

typedef TVector itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::MeasurementVectorType

Typedef alias for the measurement vectors

Definition at line 65 of file itkDistanceToCentroidMembershipFunction.h.

template<class TVector >

typedef Superclass::Pointer itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::MembershipFunctionPointer

SmartPointer class for superclass

Definition at line 58 of file itkDistanceToCentroidMembershipFunction.h.

template<class TVector >

typedef SmartPointer< Self > itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::Pointer

Definition at line 52 of file itkDistanceToCentroidMembershipFunction.h.

template<class TVector >

typedef DistanceToCentroidMembershipFunction itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::Self

Standard class typedefs

Definition at line 50 of file itkDistanceToCentroidMembershipFunction.h.

template<class TVector >

typedef MembershipFunctionBase< TVector > itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::Superclass

Definition at line 51 of file itkDistanceToCentroidMembershipFunction.h.

Constructor & Destructor Documentation

template<class TVector >

itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::DistanceToCentroidMembershipFunction ( void  )

protected

template<class TVector >

virtual itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::~DistanceToCentroidMembershipFunction ( void  )

inlineprotectedvirtual

Definition at line 102 of file itkDistanceToCentroidMembershipFunction.h.

template<class TVector >

itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::DistanceToCentroidMembershipFunction ( const Self &  )

private

Member Function Documentation

template<class TVector >

virtual::itk::LightObject::Pointer itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::CreateAnother ( void  ) const

virtual

Strandard macros

Reimplemented from itk::Object.

template<class TVector >

double itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::Evaluate ( const MeasurementVectorType &  measurement ) const

virtual

Method to get probability of an instance. The return value is the value of the density function, not probability.

Implements itk::Statistics::MembershipFunctionBase< TVector >.

template<class TVector >

const CentroidType& itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::GetCentroid

(

)

const

Get the centroid of the class (requested from the DistanceMetric

template<class TVector >

virtual const DistanceMetricType* itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::GetDistanceMetric ( ) const

virtual

template<class TVector >

virtual DistanceMetricType* itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::GetModifiableDistanceMetric ( )

virtual

Get the DistanceMetric used by the MembershipFunction

template<class TVector >

virtual const char* itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::GetNameOfClass ( ) const

virtual

Strandard macros

Reimplemented from itk::Statistics::MembershipFunctionBase< TVector >.

template<class TVector >

virtual LightObject::Pointer itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::InternalClone ( ) const

protectedvirtual

Return a copy of the current membership function

Reimplemented from itk::LightObject.

template<class TVector >

static Pointer itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::New ( )

static

Strandard macros

template<class TVector >

void itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::operator= ( const Self &  )

private

template<class TVector >

void itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::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.

template<class TVector >

void itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::SetCentroid

(

const CentroidType &

centroid

)

Get the DistanceMetric used by the MembershipFunction. This is a non-const version that allows you to configure the distance function directly. Set the centroid of the class (propagated to the DistanceMetric)

template<class TVector >

virtual void itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::SetDistanceMetric ( DistanceMetricType *  _arg )

virtual

Set the DistanceMetric to be used when calling the Evaluate() method

template<class TVector >

virtual void itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::SetMeasurementVectorSize ( MeasurementVectorSizeType  )

virtual

Set the length of each measurement vector.

Member Data Documentation

template<class TVector >

DistanceMetricPointer itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::m_DistanceMetric

private

Definition at line 112 of file itkDistanceToCentroidMembershipFunction.h.

---

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

• itkDistanceToCentroidMembershipFunction.h