ITK  5.2.0
Insight Toolkit
Public Types | List of all members
itk::Statistics::DistanceToCentroidMembershipFunction< TVector > Class Template Reference
Group Numerics » Module ITKStatistics

#include <itkDistanceToCentroidMembershipFunction.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
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
 
using MembershipFunctionPointer = typename Superclass::Pointer
 
using MeasurementVectorType = TVector
 
using MeasurementVectorSizeType = typename Superclass::MeasurementVectorSizeType
 
using DistanceMetricType = DistanceMetric< MeasurementVectorType >
 
using DistanceMetricPointer = typename DistanceMetricType::Pointer
 
using CentroidType = typename DistanceMetricType::OriginType
 
DistanceMetricPointer m_DistanceMetric
 
virtual const char * GetNameOfClass () const
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
void SetMeasurementVectorSize (MeasurementVectorSizeType) override
 
virtual void SetDistanceMetric (DistanceMetricType *_arg)
 
virtual DistanceMetricType * GetModifiableDistanceMetric ()
 
virtual const DistanceMetricType * GetDistanceMetric () const
 
void SetCentroid (const CentroidType &centroid)
 
const CentroidType & GetCentroid () const
 
double Evaluate (const MeasurementVectorType &measurement) const override
 
static Pointer New ()
 
 DistanceToCentroidMembershipFunction ()
 
 ~DistanceToCentroidMembershipFunction () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
LightObject::Pointer InternalClone () const override
 

Additional Inherited Members

- 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
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
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
 
- 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 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 ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
- 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 ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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, and SphinxExamples/src/Segmentation/Classifiers/KMeansClusterOfPixelsInImage/Code.cxx.

Definition at line 45 of file itkDistanceToCentroidMembershipFunction.h.

Member Typedef Documentation

◆ CentroidType

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

SmartPointer class for superclass

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

SmartPointer class for superclass

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.

◆ MeasurementVectorSizeType

template<typename TVector >
using itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::MeasurementVectorSizeType = typename Superclass::MeasurementVectorSizeType

Typedef to represent the length of measurement vectors

Definition at line 68 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

SmartPointer class for superclass

◆ ~DistanceToCentroidMembershipFunction()

template<typename TVector >
itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::~DistanceToCentroidMembershipFunction ( )
overrideprotecteddefault

SmartPointer class for superclass

Member Function Documentation

◆ CreateAnother()

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

SmartPointer class for superclass

Reimplemented from itk::Object.

◆ 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

◆ GetDistanceMetric()

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

SmartPointer class for superclass

◆ GetModifiableDistanceMetric()

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

Get the DistanceMetric used by the MembershipFunction

◆ GetNameOfClass()

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

Strandard macros

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

◆ 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

SmartPointer class for superclass

◆ PrintSelf()

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

SmartPointer class for superclass

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  )
override

Set the length of each measurement vector.

Member Data Documentation

◆ m_DistanceMetric

template<typename TVector >
DistanceMetricPointer itk::Statistics::DistanceToCentroidMembershipFunction< TVector >::m_DistanceMetric
private

SmartPointer class for superclass

Definition at line 113 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 Thu Apr 1 2021 02:36:58 for ITK by   doxygen 1.8.16