itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction > Class Template Reference
[Pixel Classification Filters]

Base class for model estimation from images used for classification. More...

#include <itkImageModelEstimatorBase.h>

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

[legend]Collaboration diagram for itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >:

[legend]List of all members.

Public Types
typedef ImageModelEstimatorBase	Self
typedef LightProcessObject	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TMembershipFunction::Pointer	MembershipFunctionPointer
typedef std::vector< MembershipFunctionPointer >	MembershipFunctionPointerVector
typedef TInputImage	InputImageType
typedef TInputImage::Pointer	InputImagePointer
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual void	SetNumberOfModels (unsigned int _arg)
virtual const unsigned int &	GetNumberOfModels ()
virtual void	SetInputImage (InputImageType *_arg)
virtual InputImageType *	GetInputImage ()
void	SetMembershipFunctions (MembershipFunctionPointerVector membershipFunctions)
const MembershipFunctionPointerVector	GetMembershipFunctions () const
unsigned int	GetNumberOfMembershipFunctions ()
void	DeleteAllMembershipFunctions ()
unsigned int	AddMembershipFunction (MembershipFunctionPointer function)
void	Update ()
Protected Member Functions
	ImageModelEstimatorBase ()
	~ImageModelEstimatorBase ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	GenerateData ()

---

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 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.

---

Member Typedef Documentation

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

Reimplemented from itk::LightProcessObject. Reimplemented in itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, and itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >. Definition at line 72 of file itkImageModelEstimatorBase.h.

template<class TInputImage, class TMembershipFunction> typedef TInputImage::Pointer itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::InputImagePointer

Reimplemented in itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, and itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >. Definition at line 91 of file itkImageModelEstimatorBase.h.

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 90 of file itkImageModelEstimatorBase.h.

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

Type definitions for the membership function . Reimplemented in itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, and itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >. Definition at line 84 of file itkImageModelEstimatorBase.h.

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

Definition at line 87 of file itkImageModelEstimatorBase.h. Referenced by itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GetMembershipFunctions(), and itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::SetMembershipFunctions().

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

Reimplemented from itk::LightProcessObject. Reimplemented in itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, and itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >. Definition at line 71 of file itkImageModelEstimatorBase.h.

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

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.

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

Reimplemented from itk::LightProcessObject. Reimplemented in itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, and itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >. Definition at line 70 of file itkImageModelEstimatorBase.h.

---

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]

---

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 fucntion mean Definition at line 122 of file itkImageModelEstimatorBase.h.

template<class TInputImage, class TMembershipFunction> virtual void itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GenerateData (  void   )  [protected, virtual]

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 >.

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 110 of file itkImageModelEstimatorBase.h. References itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::MembershipFunctionPointerVector.

template<class TInputImage, class TMembershipFunction> virtual const char* itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::LightProcessObject. Reimplemented in itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, and itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >.

template<class TInputImage, class TMembershipFunction> unsigned int itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::GetNumberOfMembershipFunctions (   )  [inline]

Method to number of membership functions Definition at line 116 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 >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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 >.

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

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 103 of file itkImageModelEstimatorBase.h. References itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >::MembershipFunctionPointerVector.

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

---

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

• itkImageModelEstimatorBase.h

---