ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::Statistics::MembershipFunctionBase< TVector > Class Template Referenceabstract

#include <itkMembershipFunctionBase.h>

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

Public Types

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 &x) const override=0
 
virtual MeasurementVectorSizeType GetMeasurementVectorSize () const
 
virtual const char * GetNameOfClass () 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
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

 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 &time)
 
- 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 Attributes

MeasurementVectorSizeType m_MeasurementVectorSize
 

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
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TVector>
class itk::Statistics::MembershipFunctionBase< TVector >

MembershipFunctionBase defines common interfaces for membership functions.

MembershipFunctionBase is a subclass of FunctionBase which restricts the function type to be a membership function. Membership functions provide a mapping from an arbitrary domain to a set of real numbers. Membership functions are typically used to model or approximate likelihood functions, $p( x | i )$, i.e. the probability of the measurement $x$ belonging to a class $i$.

The Statistics framework models random variables $x$ as vectors. Typical uses of MembershipFunctions include templating over a FixedArray, Array, Vector, or VariableLengthVector.

The Evaluate() method returns the membership rank or likelihood that the measurement belongs to the class represented by this membership function.

Evaluations of a single measurement across of set MembershipFunctions can then be passed to a DecisionRule in order to establish class (or group) assignment.

Definition at line 58 of file itkMembershipFunctionBase.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TVector>
using itk::Statistics::MembershipFunctionBase< TVector >::ConstPointer = SmartPointer<const Self>

Definition at line 67 of file itkMembershipFunctionBase.h.

◆ MeasurementVectorSizeType

template<typename TVector>
using itk::Statistics::MembershipFunctionBase< TVector >::MeasurementVectorSizeType = unsigned int

Typedef for the length of each measurement vector

Definition at line 76 of file itkMembershipFunctionBase.h.

◆ MeasurementVectorType

template<typename TVector>
using itk::Statistics::MembershipFunctionBase< TVector >::MeasurementVectorType = TVector

MeasurementVector type alias support

Definition at line 73 of file itkMembershipFunctionBase.h.

◆ Pointer

template<typename TVector>
using itk::Statistics::MembershipFunctionBase< TVector >::Pointer = SmartPointer<Self>

Definition at line 66 of file itkMembershipFunctionBase.h.

◆ Self

template<typename TVector>
using itk::Statistics::MembershipFunctionBase< TVector >::Self = MembershipFunctionBase

Standard class type aliases

Definition at line 64 of file itkMembershipFunctionBase.h.

◆ Superclass

template<typename TVector>
using itk::Statistics::MembershipFunctionBase< TVector >::Superclass = FunctionBase<TVector, double>

Definition at line 65 of file itkMembershipFunctionBase.h.

Constructor & Destructor Documentation

◆ MembershipFunctionBase()

template<typename TVector>
itk::Statistics::MembershipFunctionBase< TVector >::MembershipFunctionBase ( )
inlineprotected

Definition at line 130 of file itkMembershipFunctionBase.h.

◆ ~MembershipFunctionBase()

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

Member Function Documentation

◆ Evaluate()

template<typename TVector>
double itk::Statistics::MembershipFunctionBase< TVector >::Evaluate ( const MeasurementVectorType x) const
overridepure virtual

Method to get membership score (discriminant score) of an entity or measurement. Evaluate() maps from a vector measurement type to a real number.

Implements itk::FunctionBase< TVector, double >.

Implemented in itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >, itk::Statistics::GaussianMembershipFunction< TMeasurementVector >, and itk::Statistics::DistanceToCentroidMembershipFunction< TVector >.

◆ GetMeasurementVectorSize()

template<typename TVector>
virtual MeasurementVectorSizeType itk::Statistics::MembershipFunctionBase< TVector >::GetMeasurementVectorSize ( ) const
virtual

Get the length of the measurement vector

◆ GetNameOfClass()

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

◆ PrintSelf()

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

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.

Definition at line 138 of file itkMembershipFunctionBase.h.

◆ SetMeasurementVectorSize()

template<typename TVector>
virtual void itk::Statistics::MembershipFunctionBase< TVector >::SetMeasurementVectorSize ( MeasurementVectorSizeType  s)
inlinevirtual

Set the length of the measurement vector. If this membership function is templated over a vector type that can be resized, the new size is set. If the vector type has a fixed size and an attempt is made to change its size, an exception is thrown. Subclasses may have to override this method if a change in vector size requires invalidating other instance variables, e.g. covariance matrices, mean vectors, etc.

Definition at line 92 of file itkMembershipFunctionBase.h.

Member Data Documentation

◆ m_MeasurementVectorSize

template<typename TVector>
MeasurementVectorSizeType itk::Statistics::MembershipFunctionBase< TVector >::m_MeasurementVectorSize
private

Definition at line 145 of file itkMembershipFunctionBase.h.


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