ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::Statistics::DistanceToCentroidMembershipFunction< TVector > Class Template Reference
Module ITKStatistics

#include <itkDistanceToCentroidMembershipFunction.h>

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

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

Examples:
Examples/Statistics/KdTreeBasedKMeansClustering.cxx, Examples/Statistics/ScalarImageMarkovRandomField1.cxx, WikiExamples/Statistics/KdTreeBasedKMeansClustering1D.cxx, and WikiExamples/Statistics/KdTreeBasedKMeansClustering3D.cxx.

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 override
 
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) override
 
- Public Member Functions inherited from itk::Statistics::MembershipFunctionBase< TVector >
virtual MeasurementVectorSizeType GetMeasurementVectorSize () const
 
virtual void SetMeasurementVectorSize (MeasurementVectorSizeType s)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () 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

 DistanceToCentroidMembershipFunction ()
 
virtual LightObject::Pointer InternalClone () const override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~DistanceToCentroidMembershipFunction (void)
 
- Protected Member Functions inherited from itk::Statistics::MembershipFunctionBase< TVector >
 MembershipFunctionBase ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
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 () 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)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

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

Definition at line 77 of file itkDistanceToCentroidMembershipFunction.h.

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

Definition at line 53 of file itkDistanceToCentroidMembershipFunction.h.

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

Definition at line 76 of file itkDistanceToCentroidMembershipFunction.h.

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

Type of the DistanceMetric to use

Definition at line 75 of file itkDistanceToCentroidMembershipFunction.h.

template<typename 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<typename TVector >
typedef TVector itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::MeasurementVectorType

Typedef alias for the measurement vectors

Definition at line 65 of file itkDistanceToCentroidMembershipFunction.h.

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

SmartPointer class for superclass

Definition at line 58 of file itkDistanceToCentroidMembershipFunction.h.

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

Definition at line 52 of file itkDistanceToCentroidMembershipFunction.h.

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

Standard class typedefs

Definition at line 50 of file itkDistanceToCentroidMembershipFunction.h.

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

Definition at line 51 of file itkDistanceToCentroidMembershipFunction.h.

Constructor & Destructor Documentation

template<typename TVector >
itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::DistanceToCentroidMembershipFunction ( )
protected
template<typename TVector >
virtual itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::~DistanceToCentroidMembershipFunction ( void  )
inlineprotectedvirtual

Definition at line 102 of file itkDistanceToCentroidMembershipFunction.h.

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

Member Function Documentation

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

Strandard macros

Reimplemented from itk::Object.

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

template<typename TVector >
const CentroidType& itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::GetCentroid ( ) const

Get the centroid of the class (requested from the DistanceMetric

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

Get the DistanceMetric used by the MembershipFunction

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

Strandard macros

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

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

Return a copy of the current membership function

Reimplemented from itk::LightObject.

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

Strandard macros

template<typename TVector >
void itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::operator= ( const Self &  )
private
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.

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)

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

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

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

Set the length of each measurement vector.

Member Data Documentation

template<typename 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:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Fri Jul 3 2015 04:30:57 for ITK by   doxygen 1.8.5