#include <itkClassifierBase.h>

Detailed Description

template<typename TDataContainer>
class itk::ClassifierBase< TDataContainer >

Base class for classifier objects.

ClassifierBase is the base class for classifier objects. It provides the basic function definitions that are inherent to classifier objects.

This is the Superclass for the classifier framework. This is an abstract class defining an interface for all the classification objects available through the classifier framework in the ITK toolkit.

The basic functionality of the classifier framework base class is to classify each data point in given a data set to one of the N classes where N is either specified by the user or automatically determined using methods such as k-means clustering techniques.

The classifier framework supports two types of data where (1) The input is a series of data points that needs to be classified. These points may be in the form of images where the pixels can be viewed as a list and the spatial location of the pixels in not of a concern. This classification can be carried out via the use of SampleClassifier.

(2)The input is specifically an image and the pixels cannot be viewed as a list of pixels since the spatial location of the pixel in needed for various algorithmic implementations (such as the Markov Random Field based approached). This type of data can be classified via the use of GeneralImageClassifierBase.

The user will call the Update() function to run the classification process.

The user must generate the membership function before asking for data to be classified. One can automatically generate the membership function from the training data via the use of itkImageModelEstimator class. The membership functions have to be populated by using the AddMembershipFunction. If membership functions are not set prior to calling for classification, an exception in thrown.

The user can have more than one membership function, and can have one for each class. The order of the membership calculator becomes the class label for the class that is represented by the membership calculator.

The fourth argument is the type of decision rule. The main role of a decision rule is comparing the return values of the membership calculators. However, decision rules can include some prior knowledge that can improve the result. To plug in the decision rule, use SetDecisionRule method.

Before the Update method is called to start the classification process, plug in all necessary parts (one or more membership functions, a decision rule, and the unclassified data).

This class is templated over the container type.

Definition at line 87 of file itkClassifierBase.h.

Inheritance diagram for itk::ClassifierBase< TDataContainer >:

Collaboration diagram for itk::ClassifierBase< TDataContainer >:

Public Types
using	DecisionRuleType = Statistics::DecisionRule

using	MeasurementVectorType = typename TDataContainer::ValueType

using	MembershipFunctionPointer = typename MembershipFunctionType::Pointer

using	MembershipFunctionPointerVector = std::vector< MembershipFunctionPointer >

using	MembershipFunctionType = Statistics::MembershipFunctionBase< MeasurementVectorType >

using	Self = ClassifierBase

using	Superclass = LightProcessObject

Public Types inherited from itk::LightProcessObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightProcessObject

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
unsigned int	AddMembershipFunction (MembershipFunctionType *function)

DecisionRuleType *	GetDecisionRule ()

const MembershipFunctionType *	GetMembershipFunction (unsigned int index) const

const char *	GetNameOfClass () const override

virtual const unsigned int &	GetNumberOfClasses () const

unsigned int	GetNumberOfMembershipFunctions ()

void	SetDecisionRule (DecisionRuleType *ptrToDecisionRule)

virtual void	SetNumberOfClasses (unsigned int _arg)

void	Update ()

Public Member Functions inherited from itk::LightProcessObject
virtual void	AbortGenerateDataOn ()

virtual const bool &	GetAbortGenerateData () const

const char *	GetNameOfClass () const override

virtual void	SetAbortGenerateData (bool _arg)

virtual void	UpdateOutputData ()

void	UpdateProgress (float amount)

virtual void	SetProgress (float _arg)

virtual const float &	GetProgress () const

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

const char *	GetNameOfClass () const override

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 Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Protected Member Functions
	ClassifierBase ()

void	GenerateData () override=0

void	PrintSelf (std::ostream &os, Indent indent) const override

	~ClassifierBase () override=default

Protected Member Functions inherited from itk::LightProcessObject
virtual void	GenerateData ()

	LightProcessObject ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~LightProcessObject () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
DecisionRuleType::Pointer	m_DecisionRule {}

MembershipFunctionPointerVector	m_MembershipFunctions {}

unsigned int	m_NumberOfClasses {}

Additional Inherited Members
Static Public Member Functions inherited from itk::LightProcessObject
static Pointer	New ()

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

◆ DecisionRuleType

template<typename TDataContainer >

using itk::ClassifierBase< TDataContainer >::DecisionRuleType = Statistics::DecisionRule

Type alias for decision rule

Definition at line 115 of file itkClassifierBase.h.

◆ MeasurementVectorType

template<typename TDataContainer >

using itk::ClassifierBase< TDataContainer >::MeasurementVectorType = typename TDataContainer::ValueType

Sets the decision rule

Definition at line 106 of file itkClassifierBase.h.

◆ MembershipFunctionPointer

template<typename TDataContainer >

using itk::ClassifierBase< TDataContainer >::MembershipFunctionPointer = typename MembershipFunctionType::Pointer

Definition at line 110 of file itkClassifierBase.h.

◆ MembershipFunctionPointerVector

template<typename TDataContainer >

using itk::ClassifierBase< TDataContainer >::MembershipFunctionPointerVector = std::vector<MembershipFunctionPointer>

Definition at line 112 of file itkClassifierBase.h.

◆ MembershipFunctionType

template<typename TDataContainer >

using itk::ClassifierBase< TDataContainer >::MembershipFunctionType = Statistics::MembershipFunctionBase<MeasurementVectorType>

Typedefs for membership function

Definition at line 109 of file itkClassifierBase.h.

◆ Self

template<typename TDataContainer >

using itk::ClassifierBase< TDataContainer >::Self = ClassifierBase

Standard class type aliases.

Definition at line 93 of file itkClassifierBase.h.

◆ Superclass

template<typename TDataContainer >

using itk::ClassifierBase< TDataContainer >::Superclass = LightProcessObject

Definition at line 94 of file itkClassifierBase.h.

Constructor & Destructor Documentation

◆ ClassifierBase()

template<typename TDataContainer >

itk::ClassifierBase< TDataContainer >::ClassifierBase ( )

protected

◆ ~ClassifierBase()

template<typename TDataContainer >

itk::ClassifierBase< TDataContainer >::~ClassifierBase ( )

overrideprotecteddefault

Member Function Documentation

◆ AddMembershipFunction()

template<typename TDataContainer >

unsigned int itk::ClassifierBase< TDataContainer >::AddMembershipFunction ( MembershipFunctionType * function )

Stores a membership function of a class in its internal vector

◆ GenerateData()

template<typename TDataContainer >

void itk::ClassifierBase< TDataContainer >::GenerateData ( )

overrideprotectedpure virtual

The real classification logic implementation. All the subclasses of this class should implement this method.

Reimplemented from itk::LightProcessObject.

Implemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >.

◆ GetDecisionRule()

template<typename TDataContainer >

DecisionRuleType * itk::ClassifierBase< TDataContainer >::GetDecisionRule ( )

inline

Gets the pointer to the decision rule being used.

Definition at line 128 of file itkClassifierBase.h.

◆ GetMembershipFunction()

template<typename TDataContainer >

const MembershipFunctionType * itk::ClassifierBase< TDataContainer >::GetMembershipFunction ( unsigned int index ) const

inline

Gets the MembershipFunction that are plugged in by the AddMembershipFunction method. The index is assigned according to the order each membership function has been added using the AddMemberShipFunction method

Definition at line 138 of file itkClassifierBase.h.

◆ GetNameOfClass()

template<typename TDataContainer >

const char * itk::ClassifierBase< TDataContainer >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightProcessObject.

◆ GetNumberOfClasses()

template<typename TDataContainer >

virtual const unsigned int & itk::ClassifierBase< TDataContainer >::GetNumberOfClasses ( ) const

virtual

Gets the number of classes.

◆ GetNumberOfMembershipFunctions()

template<typename TDataContainer >

unsigned int itk::ClassifierBase< TDataContainer >::GetNumberOfMembershipFunctions ( )

inline

Gets the number of membership functions

Definition at line 145 of file itkClassifierBase.h.

◆ PrintSelf()

template<typename TDataContainer >

void itk::ClassifierBase< TDataContainer >::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::LightProcessObject.

◆ SetDecisionRule()

template<typename TDataContainer >

void itk::ClassifierBase< TDataContainer >::SetDecisionRule ( DecisionRuleType * ptrToDecisionRule )

inline

Sets the pointer to the decision rule. Stores the decision rule that makes the real decision using information from MembershipFunctions and other prior knowledge

Definition at line 121 of file itkClassifierBase.h.

◆ SetNumberOfClasses()

template<typename TDataContainer >

virtual void itk::ClassifierBase< TDataContainer >::SetNumberOfClasses ( unsigned int _arg )

virtual

Sets the number of classes.

◆ Update()

template<typename TDataContainer >

void itk::ClassifierBase< TDataContainer >::Update ( )

Starts the classification process

Member Data Documentation

◆ m_DecisionRule

template<typename TDataContainer >

DecisionRuleType::Pointer itk::ClassifierBase< TDataContainer >::m_DecisionRule {}

private

Pointer to the decision rule to be used for classification.

Definition at line 174 of file itkClassifierBase.h.

◆ m_MembershipFunctions

template<typename TDataContainer >

MembershipFunctionPointerVector itk::ClassifierBase< TDataContainer >::m_MembershipFunctions {}

private

Container to hold the membership functions

Definition at line 177 of file itkClassifierBase.h.

◆ m_NumberOfClasses

template<typename TDataContainer >

unsigned int itk::ClassifierBase< TDataContainer >::m_NumberOfClasses {}

private

Number of classes

Definition at line 171 of file itkClassifierBase.h.

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

itkClassifierBase.h

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ DecisionRuleType

◆ MeasurementVectorType

◆ MembershipFunctionPointer

◆ MembershipFunctionPointerVector

◆ MembershipFunctionType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ClassifierBase()

◆ ~ClassifierBase()

Member Function Documentation

◆ AddMembershipFunction()

◆ GenerateData()

◆ GetDecisionRule()

◆ GetMembershipFunction()

◆ GetNameOfClass()

◆ GetNumberOfClasses()

◆ GetNumberOfMembershipFunctions()

◆ PrintSelf()

◆ SetDecisionRule()

◆ SetNumberOfClasses()

◆ Update()

Member Data Documentation

◆ m_DecisionRule

◆ m_MembershipFunctions

◆ m_NumberOfClasses