#include <itkClassifierBase.h>
Inheritance diagram for itk::ClassifierBase< TDataContainer >:


ClassifierBase is the base class for the classifier objects. It provides the basic function definitions that are inherent to a 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 as a list of pixels since the spatial location of the pixel in needed for various algorithmic implementation such as Markov Random Field based approached. This type of data can be classified via the use of GeneralImageClassifierBase.
User will call The Update() function to run the classification proces
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 membershio functions have to be populated by using the AddMembershipFunction If membership functions are not set prior to calling for classification, an exception in thrown.
As the method name indicates, you can have more than one membership function. One for each classes. The order you put 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 rule can include some prior knowledge that can improve the result. To plug in the decision rule, use SetDecisionRule method.
Before you call the Update method to start the classification process, you should plug in all necessary parts ( one or more membership functions, a decision rule, the unclassified data).
This class is templated over the container type.
Definition at line 86 of file itkClassifierBase.h.
Public Types | |
| typedef SmartPointer< const Self > | ConstPointer |
| typedef DecisionRuleBase | DecisionRuleType |
| typedef TDataContainer::ValueType | MeasurementVectorType |
| typedef MembershipFunctionType::Pointer | MembershipFunctionPointer |
| typedef std::vector< MembershipFunctionPointer > | MembershipFunctionPointerVector |
| typedef Statistics::MembershipFunctionBase< MeasurementVectorType > | MembershipFunctionType |
| typedef SmartPointer< Self > | Pointer |
| typedef ClassifierBase | Self |
| typedef LightProcessObject | Superclass |
Public Member Functions | |
| virtual void | AbortGenerateDataOff () |
| virtual void | AbortGenerateDataOn () |
| unsigned int | AddMembershipFunction (MembershipFunctionType *function) |
| Get the execution progress of a process object The progress is *a floating number | between (0, 1) |
| Set the execution progress of a process object The progress is *a floating number | between (0, 1) |
| virtual LightObject::Pointer | CreateAnother () const |
| virtual void | DebugOff () const |
| virtual void | DebugOn () const |
| virtual void | Delete () |
| virtual const bool & | GetAbortGenerateData () |
| Command * | GetCommand (unsigned long tag) |
| bool | GetDebug () const |
| DecisionRuleType * | GetDecisionRule (void) |
| const MembershipFunctionType * | GetMembershipFunction (unsigned int index) const |
| const MetaDataDictionary & | GetMetaDataDictionary (void) const |
| MetaDataDictionary & | GetMetaDataDictionary (void) |
| virtual unsigned long | GetMTime () const |
| virtual const char * | GetNameOfClass () const |
| virtual const unsigned int & | GetNumberOfClasses () |
| unsigned int | GetNumberOfMembershipFunctions () |
| meaning *the filter has completed execution *virtual const float & | GetProgress () |
| virtual int | GetReferenceCount () const |
| bool | HasObserver (const EventObject &event) const |
| void | InvokeEvent (const EventObject &) const |
| void | InvokeEvent (const EventObject &) |
| virtual void | Modified () const |
| void | Print (std::ostream &os, Indent indent=0) const |
| virtual void | Register () const |
| void | RemoveAllObservers () |
| void | RemoveObserver (unsigned long tag) |
| virtual void | SetAbortGenerateData (bool _arg) |
| void | SetDebug (bool debugFlag) const |
| void | SetDecisionRule (DecisionRuleType *ptrToDecisionRule) |
| void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
| virtual void | SetNumberOfClasses (unsigned int _arg) |
| meaning *the filter has completed execution *virtual void | SetProgress (float _arg) |
| virtual void | SetReferenceCount (int) |
| virtual void | UnRegister () const |
| void | Update () |
| virtual void | UpdateOutputData () |
| void | UpdateProgress (float amount) |
Static Public Member Functions | |
| static void | BreakOnError () |
| static bool | GetGlobalWarningDisplay () |
| static void | GlobalWarningDisplayOff () |
| static void | GlobalWarningDisplayOn () |
| static Pointer | New () |
| This is a global flag that controls whether any warning *or error messages are displayed *static void | SetGlobalWarningDisplay (bool flag) |
Public Attributes | |
| Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon | AddObserver )(const EventObject &event, Command *) const |
| This is a global flag that controls whether any | debug |
| Get the execution progress of a process object The progress is *a floating number meaning no | progress |
| Set the execution progress of a process object The progress is *a floating number meaning no | progress |
Protected Member Functions | |
| ClassifierBase () | |
| virtual void | GenerateData ()=0 |
| bool | PrintObservers (std::ostream &os, Indent indent) const |
| void | PrintSelf (std::ostream &os, Indent indent) const |
| virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
| ~ClassifierBase () | |
Protected Attributes | |
| int | m_ReferenceCount |
| SimpleFastMutexLock | m_ReferenceCountLock |
| Methods invoked by virtual 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.*/virtual void PrintSelf(std voi | PrintHeader )(std::ostream &os, Indent indent) const |
|
|
|||||
|
Type alias for decision rule Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >. Definition at line 114 of file itkClassifierBase.h. |
|
|||||
|
Sets the decision rule Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::Statistics::SampleClassifier< TSample >, and itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >. Definition at line 100 of file itkClassifierBase.h. |
|
|||||
|
Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >. Definition at line 108 of file itkClassifierBase.h. |
|
|||||
|
Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::Statistics::SampleClassifier< TSample >, and itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >. Definition at line 111 of file itkClassifierBase.h. |
|
|||||
|
Typedefs for membership funciton Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >. Definition at line 107 of file itkClassifierBase.h. |
|
|
|||||
|
Standard class typedefs. Reimplemented from itk::LightProcessObject. Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::Statistics::SampleClassifier< TSample >, and itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >. Definition at line 90 of file itkClassifierBase.h. |
|
|||||
|
Reimplemented from itk::LightProcessObject. Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::Statistics::SampleClassifier< TSample >, and itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >. Definition at line 91 of file itkClassifierBase.h. |
|
|||||||||
|
|
|
|||||||||
|
|
|
|
|
|
|
Turn on and off the AbortGenerateData flag. |
|
||||||||||
|
Stores a membership function of a class in its internal vector |
|
||||||||||||
|
|
|
||||||||||||
|
|
|
|
This method is called when itkExceptionMacro executes. It allows the debugger to break on error. |
|
|
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class. Reimplemented from itk::LightObject. |
|
|
Turn debugging output off. |
|
|
Turn debugging output on. |
|
|
Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting. |
|
|||||||||
|
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 >, itk::Statistics::SampleClassifier< TSample >, and itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >. |
|
|
Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways. |
|
|
Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used. |
|
|
Get the value of the debug flag. |
|
||||||||||
|
Gets the pointer to the decision rule being used. Definition at line 125 of file itkClassifierBase.h. |
|
|
|
|
||||||||||
|
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 134 of file itkClassifierBase.h. |
|
|
|
|
|
|
|
|
|||||||||
|
Run-time type information (and related methods). Reimplemented from itk::LightProcessObject. Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::Statistics::SampleClassifier< TSample >, and itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >. |
|
|||||||||
|
Gets the number of classes. |
|
|||||||||
|
Gets the number of membership functions Definition at line 140 of file itkClassifierBase.h. |
|
|
|
|
|
Gets the reference count on this object. Definition at line 98 of file itkLightObject.h. |
|
|
Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay(). |
|
|
Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay(). |
|
|
Return true if an observer is registered for this event. |
|
|
Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object. |
|
|
Call Execute on all the Commands observing this event id. |
|
|
|
||||||||||||
|
Cause the object to print itself out. |
|
||||||||||||
|
|
|
||||||||||||||||
|
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 >, itk::Statistics::SampleClassifier< TSample >, and itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >. |
|
||||||||||||
|
|
|
|
Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject. |
|
|
Remove all observers . |
|
|
Remove the observer with this tag value. |
|
|
Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways. |
|
|
Set the value of the debug flag. A non-zero value turns debugging on. |
|
||||||||||
|
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 119 of file itkClassifierBase.h. |
|
|
Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn(). |
|
|
|
|
||||||||||
|
Sets the number of classes. |
|
|
|
|
|
Sets the reference count (use with care) Reimplemented from itk::LightObject. |
|
|
Decrease the reference count (release by another object). Reimplemented from itk::LightObject. |
|
|||||||||
|
Starts the classification process |
|
|
Actually generate new output. |
|
|
Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1). |
|
|
|
|
|
Definition at line 94 of file itkObject.h. |
|
|
Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h. |
|
|
Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h. |
|
|
|
|
|
Definition at line 104 of file itkLightProcessObject.h. |
|
|
Definition at line 98 of file itkLightProcessObject.h. |
1.4.2 written by Dimitri van Heesch,
© 1997-2000