#include <itkImageModelEstimatorBase.h>
Inheritance diagram for itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >:


itkImageModelEstimatorBase is the base class for the ImageModelEstimator objects. It provides the basic function definitions that are inherent to a ImageModelEstimator objects.
This is the SuperClass for the ImageModelEstimator framework. This is an abstract class defining an interface for all such objects available through the ImageModelEstimator framework in the ITK toolkit.
The basic functionality of the ImageModelEstimator framework base class is to generate the models used in classification applications. It requires input images and a training image to be provided by the user. 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.
EstimateModels() is a pure virtual function making this an abstract class. The template parameter is the type of a membership function the ImageModelEstimator populates.
A membership function represents a specific knowledge about a class. In other words, it should tell us how "likely" is that a measurement vector (pattern) belong to the class.
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.
Definition at line 65 of file itkImageModelEstimatorBase.h.
Public Types | |
| typedef SmartPointer< const Self > | ConstPointer |
| typedef TInputImage::Pointer | InputImagePointer |
| typedef TInputImage | InputImageType |
| typedef TMembershipFunction::Pointer | MembershipFunctionPointer |
| typedef std::vector< MembershipFunctionPointer > | MembershipFunctionPointerVector |
| typedef SmartPointer< Self > | Pointer |
| typedef ImageModelEstimatorBase | Self |
| typedef LightProcessObject | Superclass |
Public Member Functions | |
| virtual void | AbortGenerateDataOff () |
| virtual void | AbortGenerateDataOn () |
| unsigned int | AddMembershipFunction (MembershipFunctionPointer 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 () |
| void | DeleteAllMembershipFunctions () |
| virtual const bool & | GetAbortGenerateData () |
| Command * | GetCommand (unsigned long tag) |
| bool | GetDebug () const |
| virtual InputImageType * | GetInputImage () |
| const MembershipFunctionPointerVector | GetMembershipFunctions () const |
| const MetaDataDictionary & | GetMetaDataDictionary (void) const |
| MetaDataDictionary & | GetMetaDataDictionary (void) |
| virtual unsigned long | GetMTime () const |
| virtual const char * | GetNameOfClass () const |
| unsigned int | GetNumberOfMembershipFunctions () |
| virtual const unsigned int & | GetNumberOfModels () |
| 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 |
| virtual void | SetInputImage (InputImageType *_arg) |
| void | SetMembershipFunctions (MembershipFunctionPointerVector membershipFunctions) |
| void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
| virtual void | SetNumberOfModels (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 | |
| virtual void | GenerateData () |
| ImageModelEstimatorBase () | |
| 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 |
| ~ImageModelEstimatorBase () | |
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 |
|
|||||
|
Reimplemented from itk::LightProcessObject. Reimplemented in itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, and itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >. Definition at line 72 of file itkImageModelEstimatorBase.h. |
|
|||||
|
Reimplemented in itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, and itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >. Definition at line 91 of file itkImageModelEstimatorBase.h. |
|
|||||
|
Type definitions for the training image. Reimplemented in itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >. Definition at line 90 of file itkImageModelEstimatorBase.h. |
|
|||||
|
Type definitions for the membership function . Reimplemented in itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, and itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >. Definition at line 81 of file itkImageModelEstimatorBase.h. |
|
|||||
|
Definition at line 87 of file itkImageModelEstimatorBase.h. |
|
|||||
|
Reimplemented from itk::LightProcessObject. Reimplemented in itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, and itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >. Definition at line 71 of file itkImageModelEstimatorBase.h. |
|
|||||
|
Standard class typedefs. Reimplemented from itk::LightProcessObject. Reimplemented in itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, and itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >. Definition at line 69 of file itkImageModelEstimatorBase.h. |
|
|||||
|
Reimplemented from itk::LightProcessObject. Reimplemented in itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, and itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >. Definition at line 70 of file itkImageModelEstimatorBase.h. |
|
|||||||||
|
|
|
|||||||||
|
|
|
|
|
|
|
Turn on and off the AbortGenerateData flag. |
|
||||||||||
|
Stores a MembershipCalculator 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. |
|
|||||||||
|
Method to reset the membership fucntion mean Definition at line 122 of file itkImageModelEstimatorBase.h. |
|
||||||||||
|
This method causes the filter to generate its output. Reimplemented from itk::LightProcessObject. Reimplemented in itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, and itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >. |
|
|
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. |
|
|
|
|
|||||||||
|
Get the input image. |
|
|||||||||
|
Method to get mean Definition at line 110 of file itkImageModelEstimatorBase.h. |
|
|
|
|
|
|
|
|
|||||||||
|
Run-time type information (and related methods). Reimplemented from itk::LightProcessObject. Reimplemented in itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, and itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >. |
|
|||||||||
|
Method to number of membership functions Definition at line 116 of file itkImageModelEstimatorBase.h. |
|
|||||||||
|
Get the number of 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. |
|
|
|
||||||||||||
|
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::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, and itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >. |
|
||||||||||||
|
|
|
|
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. |
|
|
Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn(). |
|
||||||||||
|
Set the input image. |
|
||||||||||
|
Set the classified image. Definition at line 103 of file itkImageModelEstimatorBase.h. |
|
|
|
|
||||||||||
|
Set 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. |
|
|||||||||
|
Define a virtual function to perform model generation from the input data |
|
|
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