itk::ImageClassifierBase< TInputImage, TClassifiedImage > Class Template Reference

Base class for ImageClassifierBase object. More...

#include <itkImageClassifierBase.h>

Inheritance diagram for itk::ImageClassifierBase:

[legend]Collaboration diagram for itk::ImageClassifierBase< TInputImage, TClassifiedImage >:

[legend]List of all members.

Public Types
typedef ImageClassifierBase	Self
typedef ClassifierBase< TInputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef TInputImage::Pointer	InputImagePointer
typedef TInputImage::ConstPointer	InputImageConstPointer
typedef TClassifiedImage::Pointer	ClassifiedImagePointer
typedef Superclass::MeasurementVectorType	MeasurementVectorType
typedef Superclass::MembershipFunctionType	MembershipFunctionType
typedef Superclass::MembershipFunctionPointer	MembershipFunctionPointer
typedef Superclass::MembershipFunctionPointerVector	MembershipFunctionPointerVector
typedef Superclass::DecisionRuleType	DecisionRuleType
typedef TInputImage::PixelType	InputImagePixelType
typedef TClassifiedImage::PixelType	ClassifiedImagePixelType
typedef ImageRegionConstIterator< TInputImage >	InputImageConstIterator
typedef ImageRegionIterator< TClassifiedImage >	ClassifiedImageIterator
Public Methods
virtual const char *	GetClassName () const
	itkSetConstObjectMacro (InputImage, InputImageType)
	itkGetConstObjectMacro (InputImage, InputImageType)
virtual void	SetClassifiedImage (ClassifiedImagePointer _arg)
virtual ClassifiedImagePointer	GetClassifiedImage ()
const std::vector< double > &	GetPixelMembershipValue (const InputImagePixelType inputImagePixel)
Static Public Methods
Pointer	New ()
Protected Methods
	ImageClassifierBase ()
	~ImageClassifierBase ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	Allocate ()
void	GenerateData ()

---

Detailed Description

template<class TInputImage, class TClassifiedImage>
class itk::ImageClassifierBase< TInputImage, TClassifiedImage >

Base class for ImageClassifierBase object.

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.

---

Member Typedef Documentation

template<class TInputImage, class TClassifiedImage> typedef ImageRegionIterator< TClassifiedImage > itk::ImageClassifierBase< TInputImage, TClassifiedImage >::ClassifiedImageIterator

Definition at line 136 of file itkImageClassifierBase.h.

template<class TInputImage, class TClassifiedImage> typedef TClassifiedImage::PixelType itk::ImageClassifierBase< TInputImage, TClassifiedImage >::ClassifiedImagePixelType

Type definitions for the vector holding training image pixel type. Definition at line 130 of file itkImageClassifierBase.h.

template<class TInputImage, class TClassifiedImage> typedef TClassifiedImage::Pointer itk::ImageClassifierBase< TInputImage, TClassifiedImage >::ClassifiedImagePointer

Type definitions for the classified image pixel type. Definition at line 93 of file itkImageClassifierBase.h.

template<class TInputImage, class TClassifiedImage> typedef SmartPointer<const Self> itk::ImageClassifierBase< TInputImage, TClassifiedImage >::ConstPointer

Reimplemented from itk::ClassifierBase< TInputImage >. Definition at line 79 of file itkImageClassifierBase.h.

template<class TInputImage, class TClassifiedImage> typedef Superclass::DecisionRuleType itk::ImageClassifierBase< TInputImage, TClassifiedImage >::DecisionRuleType

Type alias for decision rule Reimplemented from itk::ClassifierBase< TInputImage >. Definition at line 110 of file itkImageClassifierBase.h.

template<class TInputImage, class TClassifiedImage> typedef ImageRegionConstIterator< TInputImage > itk::ImageClassifierBase< TInputImage, TClassifiedImage >::InputImageConstIterator

Type definition for the input image/training iterator Definition at line 134 of file itkImageClassifierBase.h.

template<class TInputImage, class TClassifiedImage> typedef TInputImage::ConstPointer itk::ImageClassifierBase< TInputImage, TClassifiedImage >::InputImageConstPointer

Definition at line 90 of file itkImageClassifierBase.h.

template<class TInputImage, class TClassifiedImage> typedef TInputImage::PixelType itk::ImageClassifierBase< TInputImage, TClassifiedImage >::InputImagePixelType

Type definition for the vector associated with input image pixel type. Definition at line 126 of file itkImageClassifierBase.h.

template<class TInputImage, class TClassifiedImage> typedef TInputImage::Pointer itk::ImageClassifierBase< TInputImage, TClassifiedImage >::InputImagePointer

Definition at line 89 of file itkImageClassifierBase.h.

template<class TInputImage, class TClassifiedImage> typedef TInputImage itk::ImageClassifierBase< TInputImage, TClassifiedImage >::InputImageType

Type definition for the input image. Definition at line 88 of file itkImageClassifierBase.h.

template<class TInputImage, class TClassifiedImage> typedef Superclass::MeasurementVectorType itk::ImageClassifierBase< TInputImage, TClassifiedImage >::MeasurementVectorType

Set the decision rule Reimplemented from itk::ClassifierBase< TInputImage >. Definition at line 98 of file itkImageClassifierBase.h.

template<class TInputImage, class TClassifiedImage> typedef Superclass::MembershipFunctionPointer itk::ImageClassifierBase< TInputImage, TClassifiedImage >::MembershipFunctionPointer

Reimplemented from itk::ClassifierBase< TInputImage >. Definition at line 104 of file itkImageClassifierBase.h.

template<class TInputImage, class TClassifiedImage> typedef Superclass::MembershipFunctionPointerVector itk::ImageClassifierBase< TInputImage, TClassifiedImage >::MembershipFunctionPointerVector

Reimplemented from itk::ClassifierBase< TInputImage >. Definition at line 107 of file itkImageClassifierBase.h.

template<class TInputImage, class TClassifiedImage> typedef Superclass::MembershipFunctionType itk::ImageClassifierBase< TInputImage, TClassifiedImage >::MembershipFunctionType

Typedefs for membership funciton Reimplemented from itk::ClassifierBase< TInputImage >. Definition at line 101 of file itkImageClassifierBase.h.

template<class TInputImage, class TClassifiedImage> typedef SmartPointer<Self> itk::ImageClassifierBase< TInputImage, TClassifiedImage >::Pointer

Reimplemented from itk::ClassifierBase< TInputImage >. Definition at line 78 of file itkImageClassifierBase.h.

template<class TInputImage, class TClassifiedImage> typedef ImageClassifierBase itk::ImageClassifierBase< TInputImage, TClassifiedImage >::Self

Standard class typedefs. Reimplemented from itk::ClassifierBase< TInputImage >. Definition at line 76 of file itkImageClassifierBase.h.

template<class TInputImage, class TClassifiedImage> typedef ClassifierBase<TInputImage> itk::ImageClassifierBase< TInputImage, TClassifiedImage >::Superclass

Reimplemented from itk::ClassifierBase< TInputImage >. Definition at line 77 of file itkImageClassifierBase.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TClassifiedImage> itk::ImageClassifierBase< TInputImage, TClassifiedImage >::ImageClassifierBase (    )  [protected]

template<class TInputImage, class TClassifiedImage> itk::ImageClassifierBase< TInputImage, TClassifiedImage >::~ImageClassifierBase (    )  [protected]

---

Member Function Documentation

template<class TInputImage, class TClassifiedImage> void itk::ImageClassifierBase< TInputImage, TClassifiedImage >::Allocate (    )  [protected]

Allocate memory for the classified image.

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

Starts the classification process Reimplemented from itk::ClassifierBase< TInputImage >.

template<class TInputImage, class TClassifiedImage> virtual ClassifiedImagePointer itk::ImageClassifierBase< TInputImage, TClassifiedImage >::GetClassifiedImage (    )  [virtual]

Get the classified image.

template<class TInputImage, class TClassifiedImage> virtual const char* itk::ImageClassifierBase< TInputImage, TClassifiedImage >::GetClassName (    )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ClassifierBase< TInputImage >.

template<class TInputImage, class TClassifiedImage> const std::vector<double>& itk::ImageClassifierBase< TInputImage, TClassifiedImage >::GetPixelMembershipValue (  const InputImagePixelType    inputImagePixel )

Method to get the membership of a given pixel to the different classes

template<class TInputImage, class TClassifiedImage> itk::ImageClassifierBase< TInputImage, TClassifiedImage >::itkGetConstObjectMacro (  InputImage   , InputImageType    )

Get the input image.

template<class TInputImage, class TClassifiedImage> itk::ImageClassifierBase< TInputImage, TClassifiedImage >::itkSetConstObjectMacro (  InputImage   , InputImageType    )

Set the input image.

template<class TInputImage, class TClassifiedImage> Pointer itk::ImageClassifierBase< TInputImage, TClassifiedImage >::New (    )  [static]

Method for creation through the object factory. Reimplemented from itk::LightProcessObject.

template<class TInputImage, class TClassifiedImage> void itk::ImageClassifierBase< TInputImage, TClassifiedImage >::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::ClassifierBase< TInputImage >.

template<class TInputImage, class TClassifiedImage> virtual void itk::ImageClassifierBase< TInputImage, TClassifiedImage >::SetClassifiedImage (  ClassifiedImagePointer    _arg )  [virtual]

Set the classified image.

---

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

• itkImageClassifierBase.h

---