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

#include <itkDistanceToCentroidMembershipFunction.h>

Detailed Description

template<typename 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 ManhattanDistanceMetric. 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.

Examples

Examples/Statistics/KdTreeBasedKMeansClustering.cxx, Examples/Statistics/ScalarImageMarkovRandomField1.cxx, and SphinxExamples/src/Segmentation/Classifiers/KMeansClusterOfPixelsInImage/Code.cxx.

Definition at line 45 of file itkDistanceToCentroidMembershipFunction.h.

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

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

Public Types
using	CentroidType = typename DistanceMetricType::OriginType
using	ConstPointer = SmartPointer< const Self >
using	DistanceMetricPointer = typename DistanceMetricType::Pointer
using	DistanceMetricType = DistanceMetric< MeasurementVectorType >
using	MeasurementVectorType = TVector
using	MembershipFunctionPointer = typename Superclass::Pointer
using	Pointer = SmartPointer< Self >
using	Self = DistanceToCentroidMembershipFunction
using	Superclass = MembershipFunctionBase< TVector >
Public Types inherited from itk::Statistics::MembershipFunctionBase< TVector >
using	ConstPointer = SmartPointer< const Self >
using	MeasurementVectorSizeType = unsigned int
using	MeasurementVectorType = TVector
using	Pointer = SmartPointer< Self >
using	Self = MembershipFunctionBase
using	Superclass = FunctionBase< TVector, double >
Public Types inherited from itk::FunctionBase< TVector, double >
using	ConstPointer = SmartPointer< const Self >
using	InputType = TVector
using	OutputType = double
using	Pointer = SmartPointer< Self >
using	Self = FunctionBase
using	Superclass = Object
Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = Object
using	Superclass = LightObject
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightObject

Public Member Functions
double	Evaluate (const MeasurementVectorType &measurement) const override
const CentroidType &	GetCentroid () const
virtual DistanceMetricType *	GetModifiableDistanceMetric ()
void	SetCentroid (const CentroidType &centroid)
virtual void	SetDistanceMetric (DistanceMetricType *_arg)
void	SetMeasurementVectorSize (MeasurementVectorSizeType) override
Public Member Functions inherited from itk::Statistics::MembershipFunctionBase< TVector >
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
const char *	GetNameOfClass () const override
Public Member Functions inherited from itk::FunctionBase< TVector, double >
const char *	GetNameOfClass () const override
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const
unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
LightObject::Pointer	CreateAnother () const override
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () 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
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag) const
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexcept override
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
Pointer	Clone () const
virtual void	Delete ()
virtual int	GetReferenceCount () const
void	Print (std::ostream &os, Indent indent=0) const

Protected Member Functions
	DistanceToCentroidMembershipFunction ()
LightObject::Pointer	InternalClone () const override
void	PrintSelf (std::ostream &os, Indent indent) const override
	~DistanceToCentroidMembershipFunction () override=default
Protected Member Functions inherited from itk::Statistics::MembershipFunctionBase< TVector >
	MembershipFunctionBase ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~MembershipFunctionBase () override=default
Protected Member Functions inherited from itk::FunctionBase< TVector, double >
	FunctionBase ()=default
	~FunctionBase () override=default
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
	~Object () override
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 Attributes
DistanceMetricPointer	m_DistanceMetric {}
const char *	GetNameOfClass () const override
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 val)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

CentroidType

template<typename TVector >

using itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::CentroidType = typename DistanceMetricType::OriginType

Definition at line 76 of file itkDistanceToCentroidMembershipFunction.h.

ConstPointer

template<typename TVector >

using itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::ConstPointer = SmartPointer<const Self>

Definition at line 54 of file itkDistanceToCentroidMembershipFunction.h.

DistanceMetricPointer

template<typename TVector >

using itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::DistanceMetricPointer = typename DistanceMetricType::Pointer

Definition at line 75 of file itkDistanceToCentroidMembershipFunction.h.

DistanceMetricType

template<typename TVector >

using itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::DistanceMetricType = DistanceMetric<MeasurementVectorType>

Type of the DistanceMetric to use

Definition at line 74 of file itkDistanceToCentroidMembershipFunction.h.

MeasurementVectorType

template<typename TVector >

using itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::MeasurementVectorType = TVector

Typedef alias for the measurement vectors

Definition at line 65 of file itkDistanceToCentroidMembershipFunction.h.

MembershipFunctionPointer

template<typename TVector >

using itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::MembershipFunctionPointer = typename Superclass::Pointer

SmartPointer class for superclass

Definition at line 62 of file itkDistanceToCentroidMembershipFunction.h.

Pointer

template<typename TVector >

using itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::Pointer = SmartPointer<Self>

Definition at line 53 of file itkDistanceToCentroidMembershipFunction.h.

Self

template<typename TVector >

using itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::Self = DistanceToCentroidMembershipFunction

Standard class type aliases

Definition at line 51 of file itkDistanceToCentroidMembershipFunction.h.

Superclass

template<typename TVector >

using itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::Superclass = MembershipFunctionBase<TVector>

Definition at line 52 of file itkDistanceToCentroidMembershipFunction.h.

Constructor & Destructor Documentation

DistanceToCentroidMembershipFunction()

template<typename TVector >

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

protected

~DistanceToCentroidMembershipFunction()

template<typename TVector >

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

overrideprotecteddefault

Member Function Documentation

Evaluate()

template<typename TVector >

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

overridevirtual

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

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

GetCentroid()

template<typename TVector >

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

(

)

const

Get the centroid of the class (requested from the DistanceMetric

GetModifiableDistanceMetric()

template<typename TVector >

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

virtual

Get the DistanceMetric used by the MembershipFunction

GetNameOfClass()

template<typename TVector >

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

overridevirtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::Object.

InternalClone()

template<typename TVector >

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

overrideprotectedvirtual

Return a copy of the current membership function

Reimplemented from itk::LightObject.

New()

template<typename TVector >

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

static

See also

LightObject::GetNameOfClass()

PrintSelf()

template<typename TVector >

void itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

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.

SetCentroid()

template<typename 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)

SetDistanceMetric()

template<typename TVector >

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

virtual

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

SetMeasurementVectorSize()

template<typename TVector >

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

overridevirtual

Set the length of each measurement vector.

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

Member Data Documentation

m_DistanceMetric

template<typename TVector >

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

private

Definition at line 113 of file itkDistanceToCentroidMembershipFunction.h.

---

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

• itkDistanceToCentroidMembershipFunction.h