ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes
itk::ImageClassifierBase< TInputImage, TClassifiedImage > Class Template Reference

#include <itkImageClassifierBase.h>

+ Inheritance diagram for itk::ImageClassifierBase< TInputImage, TClassifiedImage >:
+ Collaboration diagram for itk::ImageClassifierBase< TInputImage, TClassifiedImage >:

List of all members.

Public Types

typedef ImageRegionIterator
< TClassifiedImage > 
ClassifiedImageIterator
typedef TClassifiedImage::PixelType ClassifiedImagePixelType
typedef TClassifiedImage::Pointer ClassifiedImagePointer
typedef SmartPointer< const SelfConstPointer
typedef
Superclass::DecisionRuleType 
DecisionRuleType
typedef
ImageRegionConstIterator
< TInputImage > 
InputImageConstIterator
typedef TInputImage::ConstPointer InputImageConstPointer
typedef TInputImage::PixelType InputImagePixelType
typedef TInputImage::Pointer InputImagePointer
typedef TInputImage InputImageType
typedef
Superclass::MeasurementVectorType 
MeasurementVectorType
typedef
Superclass::MembershipFunctionPointer 
MembershipFunctionPointer
typedef
Superclass::MembershipFunctionPointerVector 
MembershipFunctionPointerVector
typedef
Superclass::MembershipFunctionType 
MembershipFunctionType
typedef SmartPointer< SelfPointer
typedef ImageClassifierBase Self
typedef ClassifierBase
< TInputImage > 
Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual ClassifiedImagePointer GetClassifiedImage () const
virtual const InputImageTypeGetInputImage ()
virtual const char * GetNameOfClass () const
std::vector< double > GetPixelMembershipValue (const InputImagePixelType inputImagePixel)
virtual void SetClassifiedImage (ClassifiedImagePointer _arg)
virtual void SetInputImage (const InputImageType *_arg)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

void Allocate ()
void GenerateData ()
 ImageClassifierBase ()
void PrintSelf (std::ostream &os, Indent indent) const
 ~ImageClassifierBase ()

Private Types

typedef TInputImage::SizeType InputImageSizeType

Private Member Functions

virtual void Classify ()
 ImageClassifierBase (const Self &)
void operator= (const Self &)

Private Attributes

ClassifiedImagePointer m_ClassifiedImage
InputImageConstPointer m_InputImage

Detailed Description

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

Base class for the 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 an 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 that hold 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 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::LightProcessObject.

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 122 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::SizeType itk::ImageClassifierBase< TInputImage, TClassifiedImage >::InputImageSizeType [private]

Definition at line 157 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 85 of file itkImageClassifierBase.h.

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

Type definitions from the Superclass 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::LightProcessObject.

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]
template<class TInputImage , class TClassifiedImage >
itk::ImageClassifierBase< TInputImage, TClassifiedImage >::ImageClassifierBase ( const Self ) [private]

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 >
virtual void itk::ImageClassifierBase< TInputImage, TClassifiedImage >::Classify ( ) [private, virtual]

Define a virtual Classifier function to classify the whole image.

template<class TInputImage , class TClassifiedImage >
virtual::itk::LightObject::Pointer itk::ImageClassifierBase< TInputImage, TClassifiedImage >::CreateAnother ( void  ) const [virtual]

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

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

Starts the classification process

Implements itk::ClassifierBase< TInputImage >.

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

Get the classified image.

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

Get the input image.

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

Run-time type information (and related methods).

Reimplemented from itk::ClassifierBase< TInputImage >.

template<class TInputImage , class TClassifiedImage >
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 >
static 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 >::operator= ( const Self ) [private]

This method causes the filter to generate its output.

Reimplemented from itk::ClassifierBase< TInputImage >.

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.

template<class TInputImage , class TClassifiedImage >
virtual void itk::ImageClassifierBase< TInputImage, TClassifiedImage >::SetInputImage ( const InputImageType _arg) [virtual]

Set the input image.


Member Data Documentation

template<class TInputImage , class TClassifiedImage >
ClassifiedImagePointer itk::ImageClassifierBase< TInputImage, TClassifiedImage >::m_ClassifiedImage [private]

Definition at line 160 of file itkImageClassifierBase.h.

template<class TInputImage , class TClassifiedImage >
InputImageConstPointer itk::ImageClassifierBase< TInputImage, TClassifiedImage >::m_InputImage [private]

Definition at line 159 of file itkImageClassifierBase.h.


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