#include <itkImageClassifierBase.h>
Inheritance diagram for itk::ImageClassifierBase< TInputImage, TClassifiedImage >:


itkImageClassifierBase is the base class for algorithms that take input data as images and preserve the image structure while performing classification. In other words, the data is not converted into a list, hence filters that require spatial information of a pixel can use the subclasses under this tree. It provides the basic function definitions that are inherent to a image classifier objects.
This is the SuperClass for the image classifier tree of the classifier framework. This is the class for all the classification objects available through the classifier framework in the ITK toolkit thatholds the input image and the classified image data.
It is templated over the type of input image, classified image. The second template parameter allows templating over the classified image type. The name "image" indicates that the basic data structure used for storing data/results are derived from the ITK image class.
This object supports data handling of multiband images. The object accepts the input image in vector format only, where each pixel is a vector and each element of the vector corresponds to an entry from 1 particular band of a multiband dataset. A single band image is treated as a vector image with a single element for every vector. The classified image is treated as a single band scalar image.
This class stores the input and output data as its private members. Before you call the Classify method to start the classification process, you should plug in all necessary parts as described in the superclass documentation.
The core computation is carried out here. The function requires that the the number of classes be set to a non zero value and the membership functions be populated. In addition the number of classes should be equal to the number of membership functions.
Definition at line 71 of file itkImageClassifierBase.h.
Public Types | |
| typedef ImageRegionIterator< TClassifiedImage > | ClassifiedImageIterator |
| typedef TClassifiedImage::PixelType | ClassifiedImagePixelType |
| typedef TClassifiedImage::Pointer | ClassifiedImagePointer |
| typedef SmartPointer< const Self > | ConstPointer |
| typedef Superclass::DecisionRuleType | DecisionRuleType |
| typedef ImageRegionConstIterator< TInputImage > | InputImageConstIterator |
| typedef TInputImage::ConstPointer | InputImageConstPointer |
| typedef TInputImage::PixelType | InputImagePixelType |
| typedef TInputImage::Pointer | InputImagePointer |
| typedef TInputImage | InputImageType |
| typedef Superclass::MeasurementVectorType | MeasurementVectorType |
| typedef Superclass::MembershipFunctionPointer | MembershipFunctionPointer |
| typedef Superclass::MembershipFunctionPointerVector | MembershipFunctionPointerVector |
| typedef Superclass::MembershipFunctionType | MembershipFunctionType |
| typedef SmartPointer< Self > | Pointer |
| typedef ImageClassifierBase | Self |
| typedef ClassifierBase< TInputImage > | 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 () |
| virtual ClassifiedImagePointer | GetClassifiedImage () |
| Command * | GetCommand (unsigned long tag) |
| bool | GetDebug () const |
| DecisionRuleType * | GetDecisionRule (void) |
| virtual const InputImageType * | GetInputImage () |
| 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 () |
| const std::vector< double > & | GetPixelMembershipValue (const InputImagePixelType inputImagePixel) |
| 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) |
| virtual void | SetClassifiedImage (ClassifiedImagePointer _arg) |
| void | SetDebug (bool debugFlag) const |
| void | SetDecisionRule (DecisionRuleType *ptrToDecisionRule) |
| virtual void | SetInputImage (const InputImageType *_arg) |
| 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 | |
| void | Allocate () |
| ClassifierBase () | |
| void | GenerateData () |
| ImageClassifierBase () | |
| 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 |
| ~ImageClassifierBase () | |
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 |
|
|||||
|
Definition at line 136 of file itkImageClassifierBase.h. |
|
|||||
|
Type definitions for the vector holding training image pixel type. Definition at line 130 of file itkImageClassifierBase.h. |
|
|||||
|
Type definitions for the classified image pixel type. Definition at line 93 of file itkImageClassifierBase.h. |
|
|||||
|
Reimplemented from itk::LightProcessObject. Definition at line 79 of file itkImageClassifierBase.h. |
|
|||||
|
Type alias for decision rule Reimplemented from itk::ClassifierBase< TInputImage >. Definition at line 110 of file itkImageClassifierBase.h. |
|
|||||
|
Type definition for the input image/training iterator Definition at line 134 of file itkImageClassifierBase.h. |
|
|||||
|
Definition at line 90 of file itkImageClassifierBase.h. |
|
|||||
|
Type definition for the vector associated with input image pixel type. Definition at line 122 of file itkImageClassifierBase.h. |
|
|||||
|
Definition at line 89 of file itkImageClassifierBase.h. |
|
|||||
|
Type definition for the input image. Definition at line 85 of file itkImageClassifierBase.h. |
|
|||||
|
Set the decision rule Reimplemented from itk::ClassifierBase< TInputImage >. Definition at line 98 of file itkImageClassifierBase.h. |
|
|||||
|
Reimplemented from itk::ClassifierBase< TInputImage >. Definition at line 104 of file itkImageClassifierBase.h. |
|
|||||
|
Reimplemented from itk::ClassifierBase< TInputImage >. Definition at line 107 of file itkImageClassifierBase.h. |
|
|||||
|
Typedefs for membership funciton Reimplemented from itk::ClassifierBase< TInputImage >. Definition at line 101 of file itkImageClassifierBase.h. |
|
|||||
|
Reimplemented from itk::LightProcessObject. Definition at line 78 of file itkImageClassifierBase.h. |
|
|||||
|
Standard class typedefs. Reimplemented from itk::ClassifierBase< TInputImage >. Definition at line 76 of file itkImageClassifierBase.h. |
|
|||||
|
Reimplemented from itk::ClassifierBase< TInputImage >. Definition at line 77 of file itkImageClassifierBase.h. |
|
|||||||||
|
|
|
|||||||||
|
|
|
|
|
|
|
Turn on and off the AbortGenerateData flag. |
|
|
Stores a membership function of a class in its internal vector |
|
|||||||||
|
Allocate memory for the classified image. |
|
||||||||||||
|
|
|
||||||||||||
|
|
|
|
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. |
|
|||||||||
|
Starts the classification process Implements itk::ClassifierBase< TInputImage >. |
|
|
Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways. |
|
|||||||||
|
Get the classified image. |
|
|
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. |
|
|
|
|
|||||||||
|
Get the input image. |
|
|
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::ClassifierBase< TInputImage >. |
|
|
Gets the number of classes. |
|
|
Gets the number of membership functions Definition at line 140 of file itkClassifierBase.h. |
|
||||||||||
|
Method to get the membership of a given pixel to the different classes |
|
|
|
|
|
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. |
|
|
|||||||||
|
Method for creation through the object factory. Reimplemented from itk::LightProcessObject. |
|
||||||||||||
|
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::ClassifierBase< TInputImage >. |
|
||||||||||||
|
|
|
|
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 classified image. |
|
|
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(). |
|
||||||||||
|
Set the input image. |
|
|
|
|
|
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