#include <itkMembershipFunctionBase.h>

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

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

Public Types
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 TVector	InputType
typedef double	OutputType
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual double	Evaluate (const MeasurementVectorType &x) const =0
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
virtual const char *	GetNameOfClass () const
virtual void	SetMeasurementVectorSize (MeasurementVectorSizeType s)

Protected Member Functions
	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
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 Member Functions
	MembershipFunctionBase (const Self &)
void	operator= (const Self &)

Private Attributes
MeasurementVectorSizeType	m_MeasurementVectorSize

Detailed Description

template<class 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 57 of file itkMembershipFunctionBase.h.

Member Typedef Documentation

template<class TVector>

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

Reimplemented from itk::FunctionBase< TVector, double >.

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

Definition at line 65 of file itkMembershipFunctionBase.h.

template<class TVector>

typedef unsigned int itk::Statistics::MembershipFunctionBase< TVector >::MeasurementVectorSizeType

Typedef for the length of each measurement vector

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

Definition at line 74 of file itkMembershipFunctionBase.h.

template<class TVector>

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

MeasurementVector typedef support

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

Definition at line 68 of file itkMembershipFunctionBase.h.

template<class TVector>

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

Reimplemented from itk::FunctionBase< TVector, double >.

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

Definition at line 64 of file itkMembershipFunctionBase.h.

template<class TVector>

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

Standard class typedefs

Reimplemented from itk::FunctionBase< TVector, double >.

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

Definition at line 62 of file itkMembershipFunctionBase.h.

template<class TVector>

typedef FunctionBase< TVector, double > itk::Statistics::MembershipFunctionBase< TVector >::Superclass

Reimplemented from itk::FunctionBase< TVector, double >.

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

Definition at line 63 of file itkMembershipFunctionBase.h.

Constructor & Destructor Documentation

template<class TVector>

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

inlineprotected

Definition at line 128 of file itkMembershipFunctionBase.h.

template<class TVector>

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

inlineprotectedvirtual

Definition at line 134 of file itkMembershipFunctionBase.h.

template<class TVector>

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

private

Member Function Documentation

template<class TVector>

virtual double itk::Statistics::MembershipFunctionBase< TVector >::Evaluate ( const MeasurementVectorType & x ) const

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

template<class TVector>

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

virtual

Get the length of the measurement vector

template<class TVector>

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

virtual

Standard macros

Reimplemented from itk::FunctionBase< TVector, double >.

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

template<class TVector>

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

private

Mutex lock to protect modification to the reference count

Reimplemented from itk::FunctionBase< TVector, double >.

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

template<class TVector>

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

inlineprotectedvirtual

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.

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

Definition at line 136 of file itkMembershipFunctionBase.h.

template<class 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 88 of file itkMembershipFunctionBase.h.