ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction > Class Template Reference

#include <itkImageModelEstimatorBase.h>

+ Inheritance diagram for itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >:
+ Collaboration diagram for itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef TInputImage::Pointer InputImagePointer
typedef TInputImage InputImageType
typedef
TMembershipFunction::Pointer 
MembershipFunctionPointer
typedef std::vector
< MembershipFunctionPointer
MembershipFunctionPointerVector
typedef SmartPointer< SelfPointer
typedef ImageModelEstimatorBase Self
typedef LightProcessObject Superclass
- Public Types inherited from itk::LightProcessObject
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

unsigned int AddMembershipFunction (MembershipFunctionPointer function)
void DeleteAllMembershipFunctions ()
virtual InputImageTypeGetInputImage ()
const
MembershipFunctionPointerVector 
GetMembershipFunctions () const
virtual const char * GetNameOfClass () const
unsigned int GetNumberOfMembershipFunctions ()
virtual const unsigned int & GetNumberOfModels ()
virtual void SetInputImage (InputImageType *_arg)
void SetMembershipFunctions (MembershipFunctionPointerVector membershipFunctions)
virtual void SetNumberOfModels (unsigned int _arg)
void Update ()
- Public Member Functions inherited from itk::LightProcessObject
virtual void AbortGenerateDataOff ()
virtual void AbortGenerateDataOn ()
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const bool & GetAbortGenerateData ()
virtual void SetAbortGenerateData (bool _arg)
virtual void UpdateOutputData ()
void UpdateProgress (float amount)
virtual void SetProgress (float _arg)
virtual const float & GetProgress ()
- 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
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long GetMTime () const
virtual const TimeStampGetTimeStamp () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () 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 ()
 ImageModelEstimatorBase ()
void PrintSelf (std::ostream &os, Indent indent) const
 ~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 void SetGlobalWarningDisplay (bool flag)
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()

Detailed Description

template<class TInputImage, class TMembershipFunction>
class itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >

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.


Member Typedef Documentation

template<class TInputImage , class TMembershipFunction >
typedef SmartPointer< const Self > itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::ConstPointer
template<class TInputImage , class TMembershipFunction >
typedef TInputImage::Pointer itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::InputImagePointer
template<class TInputImage , class TMembershipFunction >
typedef TInputImage itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::InputImageType

Type definitions for the training image.

Reimplemented in itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >.

Definition at line 89 of file itkImageModelEstimatorBase.h.

template<class TInputImage , class TMembershipFunction >
typedef TMembershipFunction::Pointer itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::MembershipFunctionPointer
template<class TInputImage , class TMembershipFunction >
typedef std::vector< MembershipFunctionPointer > itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::MembershipFunctionPointerVector

Definition at line 86 of file itkImageModelEstimatorBase.h.

template<class TInputImage , class TMembershipFunction >
typedef SmartPointer< Self > itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::Pointer
template<class TInputImage , class TMembershipFunction >
typedef ImageModelEstimatorBase itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::Self
template<class TInputImage , class TMembershipFunction >
typedef LightProcessObject itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::Superclass

Constructor & Destructor Documentation

template<class TInputImage , class TMembershipFunction >
itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::ImageModelEstimatorBase ( )
protected
template<class TInputImage , class TMembershipFunction >
itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::~ImageModelEstimatorBase ( )
protected
template<class TInputImage , class TMembershipFunction >
itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::ImageModelEstimatorBase ( const Self )
private

Member Function Documentation

template<class TInputImage , class TMembershipFunction >
unsigned int itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::AddMembershipFunction ( MembershipFunctionPointer  function)

Stores a MembershipCalculator of a class in its internal vector

template<class TInputImage , class TMembershipFunction >
void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::DeleteAllMembershipFunctions ( )
inline

Method to reset the membership function mean

Definition at line 121 of file itkImageModelEstimatorBase.h.

template<class TInputImage , class TMembershipFunction >
virtual void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::EstimateModels ( )
privatepure virtual
template<class TInputImage , class TMembershipFunction >
virtual void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GenerateData ( void  )
protectedvirtual
template<class TInputImage , class TMembershipFunction >
virtual InputImageType* itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GetInputImage ( )
virtual

Get the input image.

template<class TInputImage , class TMembershipFunction >
const MembershipFunctionPointerVector itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GetMembershipFunctions ( ) const
inline

Method to get mean

Definition at line 109 of file itkImageModelEstimatorBase.h.

template<class TInputImage , class TMembershipFunction >
virtual const char* itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GetNameOfClass ( ) const
virtual
template<class TInputImage , class TMembershipFunction >
unsigned int itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GetNumberOfMembershipFunctions ( )
inline

Method to number of membership functions

Definition at line 115 of file itkImageModelEstimatorBase.h.

template<class TInputImage , class TMembershipFunction >
virtual const unsigned int& itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GetNumberOfModels ( )
virtual

Get the number of classes.

template<class TInputImage , class TMembershipFunction >
void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::operator= ( const Self )
private
template<class TInputImage , class TMembershipFunction >
void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
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 >.

template<class TInputImage , class TMembershipFunction >
virtual void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::SetInputImage ( InputImageType _arg)
virtual

Type definitions for the training image. Set the input image.

template<class TInputImage , class TMembershipFunction >
void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::SetMembershipFunctions ( MembershipFunctionPointerVector  membershipFunctions)
inline

Set the classified image.

Definition at line 102 of file itkImageModelEstimatorBase.h.

template<class TInputImage , class TMembershipFunction >
virtual void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::SetNumberOfModels ( unsigned int  _arg)
virtual

Set the number of classes.

template<class TInputImage , class TMembershipFunction >
void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::Update ( )

Define a virtual function to perform model generation from the input data


Member Data Documentation

template<class TInputImage , class TMembershipFunction >
InputImagePointer itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::m_InputImage
private

Container for holding the training image

Definition at line 151 of file itkImageModelEstimatorBase.h.

template<class TInputImage , class TMembershipFunction >
MembershipFunctionPointerVector itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::m_MembershipFunctions
private

Container to hold the membership functions

Definition at line 148 of file itkImageModelEstimatorBase.h.

template<class TInputImage , class TMembershipFunction >
unsigned int itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::m_NumberOfModels
private

Definition at line 145 of file itkImageModelEstimatorBase.h.


The documentation for this class was generated from the following file: