![]() |
ITK
4.13.0
Insight Segmentation and Registration Toolkit
|
#include <itkClassifierBase.h>
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 86 of file itkClassifierBase.h.
Public Types | |
typedef Statistics::DecisionRule | DecisionRuleType |
typedef TDataContainer::ValueType | MeasurementVectorType |
typedef MembershipFunctionType::Pointer | MembershipFunctionPointer |
typedef std::vector < MembershipFunctionPointer > | MembershipFunctionPointerVector |
typedef Statistics::MembershipFunctionBase < MeasurementVectorType > | MembershipFunctionType |
typedef ClassifierBase | Self |
typedef LightProcessObject | Superclass |
![]() | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightProcessObject | Self |
typedef Object | Superclass |
![]() | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef Object | Self |
typedef LightObject | Superclass |
![]() | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightObject | Self |
Public Member Functions | |
unsigned int | AddMembershipFunction (MembershipFunctionType *function) |
DecisionRuleType * | GetDecisionRule (void) |
const MembershipFunctionType * | GetMembershipFunction (unsigned int index) const |
virtual const char * | GetNameOfClass () const |
virtual const unsigned int & | GetNumberOfClasses () const |
unsigned int | GetNumberOfMembershipFunctions () |
void | SetDecisionRule (DecisionRuleType *ptrToDecisionRule) |
virtual void | SetNumberOfClasses (unsigned int _arg) |
void | Update () |
![]() | |
virtual void | AbortGenerateDataOff () |
virtual void | AbortGenerateDataOn () |
virtual ::itk::LightObject::Pointer | CreateAnother () const |
virtual const bool & | GetAbortGenerateData () const |
virtual void | SetAbortGenerateData (bool _arg) |
virtual void | UpdateOutputData () |
void | UpdateProgress (float amount) |
virtual void | SetProgress (float _arg) |
virtual const float & | GetProgress () const |
![]() | |
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 |
![]() | |
virtual void | Delete () |
virtual int | GetReferenceCount () const |
itkCloneMacro (Self) | |
void | Print (std::ostream &os, Indent indent=0) const |
Protected Member Functions | |
ClassifierBase () | |
virtual void | GenerateData () override=0 |
virtual void | PrintSelf (std::ostream &os, Indent indent) const override |
~ClassifierBase () override | |
![]() | |
LightProcessObject () | |
~LightProcessObject () override | |
![]() | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
virtual void | SetTimeStamp (const TimeStamp &time) |
virtual | ~Object () override |
![]() | |
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 | |
DecisionRuleType::Pointer | m_DecisionRule |
MembershipFunctionPointerVector | m_MembershipFunctions |
unsigned int | m_NumberOfClasses |
Additional Inherited Members | |
![]() | |
static Pointer | New () |
![]() | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool flag) |
![]() | |
static void | BreakOnError () |
static Pointer | New () |
![]() | |
AtomicInt< int > | m_ReferenceCount |
typedef Statistics::DecisionRule itk::ClassifierBase< TDataContainer >::DecisionRuleType |
Type alias for decision rule
Definition at line 113 of file itkClassifierBase.h.
typedef TDataContainer::ValueType itk::ClassifierBase< TDataContainer >::MeasurementVectorType |
Sets the decision rule
Definition at line 100 of file itkClassifierBase.h.
typedef MembershipFunctionType::Pointer itk::ClassifierBase< TDataContainer >::MembershipFunctionPointer |
Definition at line 107 of file itkClassifierBase.h.
typedef std::vector< MembershipFunctionPointer > itk::ClassifierBase< TDataContainer >::MembershipFunctionPointerVector |
Definition at line 110 of file itkClassifierBase.h.
typedef Statistics::MembershipFunctionBase< MeasurementVectorType > itk::ClassifierBase< TDataContainer >::MembershipFunctionType |
Typedefs for membership funciton
Definition at line 106 of file itkClassifierBase.h.
typedef ClassifierBase itk::ClassifierBase< TDataContainer >::Self |
Standard class typedefs.
Definition at line 90 of file itkClassifierBase.h.
typedef LightProcessObject itk::ClassifierBase< TDataContainer >::Superclass |
Definition at line 91 of file itkClassifierBase.h.
|
protected |
|
overrideprotected |
unsigned int itk::ClassifierBase< TDataContainer >::AddMembershipFunction | ( | MembershipFunctionType * | function | ) |
Stores a membership function of a class in its internal vector
|
overrideprotectedpure virtual |
The real classification logic implementaion. All the subclasses of this class should implement this method.
Reimplemented from itk::LightProcessObject.
Implemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >.
|
inline |
Gets the pointer to the decision rule being used.
Definition at line 124 of file itkClassifierBase.h.
|
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 133 of file itkClassifierBase.h.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::LightProcessObject.
Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >.
|
virtual |
Gets the number of classes.
|
inline |
Gets the number of membership functions
Definition at line 139 of file itkClassifierBase.h.
|
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.
Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >.
|
inline |
Sets the pointer to the decision rule. Stores the decision rule that makes the real decision using informations from MembershipFunctions and other prior knowledge
Definition at line 118 of file itkClassifierBase.h.
|
virtual |
Sets the number of classes.
void itk::ClassifierBase< TDataContainer >::Update | ( | ) |
Starts the classification process
|
private |
Pointer to the decision rule to be used for classification.
Definition at line 166 of file itkClassifierBase.h.
|
private |
Container to hold the membership functions
Definition at line 169 of file itkClassifierBase.h.
|
private |
Number of classes
Definition at line 160 of file itkClassifierBase.h.