ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
#include <itkImageModelEstimatorBase.h>
Base class for model estimation from images used for classification.
itkImageModelEstimatorBase is the base class for the ImageModelEstimator objects. It provides the basic function definitions that are inherent to 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 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 of the membership calculator becomes the class label for the class that is represented by the membership calculator.
Definition at line 64 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 Types inherited from itk::LightProcessObject | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightProcessObject | Self |
typedef Object | Superclass |
Public Types inherited from itk::Object | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef Object | Self |
typedef LightObject | Superclass |
Public Types inherited from itk::LightObject | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightObject | Self |
Public Member Functions | |
unsigned int | AddMembershipFunction (MembershipFunctionPointer function) |
void | DeleteAllMembershipFunctions () |
const MembershipFunctionPointerVector | GetMembershipFunctions () const |
virtual const char * | GetNameOfClass () const |
unsigned int | GetNumberOfMembershipFunctions () |
virtual const unsigned int & | GetNumberOfModels () const |
void | SetMembershipFunctions (MembershipFunctionPointerVector membershipFunctions) |
virtual void | SetNumberOfModels (unsigned int _arg) |
void | Update () |
virtual void | SetInputImage (InputImageType *_arg) |
virtual InputImageType * | GetModifiableInputImage () |
virtual const InputImageType * | GetInputImage () const |
Public Member Functions inherited from itk::LightProcessObject | |
virtual void | AbortGenerateDataOff () |
virtual void | AbortGenerateDataOn () |
virtual ::itk::LightObject::Pointer | CreateAnother (void) 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 |
Public Member Functions inherited from itk::Object | |
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 (void) |
const MetaDataDictionary & | GetMetaDataDictionary (void) 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 ITK_OVERRIDE |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
virtual void | SetReferenceCount (int) ITK_OVERRIDE |
virtual void | UnRegister () const ITK_OVERRIDE |
virtual void | SetObjectName (std::string _arg) |
virtual const std::string & | GetObjectName () const |
Public Member Functions inherited from itk::LightObject | |
virtual void | Delete () |
virtual int | GetReferenceCount () const |
itkCloneMacro (Self) | |
void | Print (std::ostream &os, Indent indent=0) const |
Protected Member Functions | |
virtual void | GenerateData () ITK_OVERRIDE |
ImageModelEstimatorBase () | |
virtual void | PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE |
~ImageModelEstimatorBase () | |
Protected Member Functions inherited from itk::LightProcessObject | |
LightProcessObject () | |
~LightProcessObject () | |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
virtual void | SetTimeStamp (const TimeStamp &time) |
virtual | ~Object () |
Protected Member Functions inherited from itk::LightObject | |
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 Member Functions | |
virtual void | EstimateModels ()=0 |
ImageModelEstimatorBase (const Self &) | |
void | operator= (const Self &) |
Private Attributes | |
InputImagePointer | m_InputImage |
MembershipFunctionPointerVector | m_MembershipFunctions |
unsigned int | m_NumberOfModels |
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 flag) |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
Protected Types inherited from itk::LightObject | |
typedef int | InternalReferenceCountType |
Protected Attributes inherited from itk::LightObject | |
InternalReferenceCountType | m_ReferenceCount |
SimpleFastMutexLock | m_ReferenceCountLock |
typedef SmartPointer< const Self > itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::ConstPointer |
Definition at line 71 of file itkImageModelEstimatorBase.h.
typedef TInputImage::Pointer itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::InputImagePointer |
Definition at line 90 of file itkImageModelEstimatorBase.h.
typedef TInputImage itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::InputImageType |
Type definitions for the training image.
Definition at line 89 of file itkImageModelEstimatorBase.h.
typedef TMembershipFunction::Pointer itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::MembershipFunctionPointer |
Type definitions for the membership function .
Definition at line 80 of file itkImageModelEstimatorBase.h.
typedef std::vector< MembershipFunctionPointer > itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::MembershipFunctionPointerVector |
Definition at line 86 of file itkImageModelEstimatorBase.h.
typedef SmartPointer< Self > itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::Pointer |
Definition at line 70 of file itkImageModelEstimatorBase.h.
typedef ImageModelEstimatorBase itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::Self |
Standard class typedefs.
Definition at line 68 of file itkImageModelEstimatorBase.h.
typedef LightProcessObject itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::Superclass |
Definition at line 69 of file itkImageModelEstimatorBase.h.
|
protected |
|
protected |
|
private |
unsigned int itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::AddMembershipFunction | ( | MembershipFunctionPointer | function | ) |
Stores a MembershipCalculator of a class in its internal vector
|
inline |
Method to reset the membership function mean
Definition at line 120 of file itkImageModelEstimatorBase.h.
References itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::m_MembershipFunctions.
|
privatepure virtual |
The core virtual function to perform modelling of the input data
Implemented in itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, and itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >.
|
protectedvirtual |
This method causes the filter to generate its output.
Reimplemented from itk::LightProcessObject.
Reimplemented in itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, and itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >.
|
virtual |
Type definitions for the training image. Get/Set the input image.
|
inline |
Method to get mean
Definition at line 108 of file itkImageModelEstimatorBase.h.
References itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::m_MembershipFunctions.
|
virtual |
Type definitions for the training image. Get/Set the input image.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::LightProcessObject.
Reimplemented in itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, and itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >.
|
inline |
Method to number of membership functions
Definition at line 114 of file itkImageModelEstimatorBase.h.
References itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::m_MembershipFunctions.
|
virtual |
Get the number of classes.
|
private |
|
protectedvirtual |
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::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, and itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >.
|
virtual |
Type definitions for the training image. Get/Set the input image.
|
inline |
Set the classified image.
Definition at line 101 of file itkImageModelEstimatorBase.h.
References itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::m_MembershipFunctions.
|
virtual |
Set the number of classes.
void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::Update | ( | ) |
Define a virtual function to perform model generation from the input data
|
private |
Container for holding the training image
Definition at line 150 of file itkImageModelEstimatorBase.h.
|
private |
Container to hold the membership functions
Definition at line 147 of file itkImageModelEstimatorBase.h.
Referenced by itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::DeleteAllMembershipFunctions(), itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GetMembershipFunctions(), itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GetNumberOfMembershipFunctions(), and itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::SetMembershipFunctions().
|
private |
Definition at line 144 of file itkImageModelEstimatorBase.h.