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

#include <itkRegionGrowImageFilter.h>

+ Inheritance diagram for itk::RegionGrowImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::RegionGrowImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef TInputImage::SizeType GridSizeType
typedef TInputImage::ConstPointer InputImageConstPointer
typedef TInputImage::PixelType InputImagePixelType
typedef TInputImage::Pointer InputImagePointer
typedef TInputImage InputImageType
typedef TOutputImage::PixelType OutputImagePixelType
typedef TOutputImage::Pointer OutputImagePointer
typedef TOutputImage OutputImageType
typedef SmartPointer< SelfPointer
typedef RegionGrowImageFilter Self
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass

Public Member Functions

virtual void ApplyRegionGrowImageFilter ()=0
virtual const char * GetNameOfClass () const
virtual void MergeRegions ()=0
virtual void SetGridSize (GridSizeType _arg)
virtual const GridSizeTypeGetGridSize ()
virtual void SetMaximumNumberOfRegions (unsigned int _arg)
virtual const unsigned int & GetMaximumNumberOfRegions ()

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const
 RegionGrowImageFilter ()
 ~RegionGrowImageFilter ()

Private Member Functions

void operator= (const Self &)
 RegionGrowImageFilter (const Self &)

Private Attributes

GridSizeType m_GridSize
unsigned int m_MaximumNumberOfRegions

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::RegionGrowImageFilter< TInputImage, TOutputImage >

Base class for RegionGrowImageFilter object.

itkRegionGrowImageFilter is the base class for the RegionGrowImageFilter objects. It provides the basic function definitons that are inherent to a RegionGrowImageFilter objects. It is templated over the type of input and output image.

This object defines the interface for those algorithm that perform feature/object segmentation by merging regions (parts of the image) that are similar in nature based on some metric. As a result parts of the image which belong to the same object gets merged and the region grows.

As an example regarding using this class to implementation of advanced region growing algorithm, itkRegionGrowImageFilterKLM class has been derived from this class. The virtual function ApplyRegionGrowImageFilter() provides the interface to the outside world to extend/enhance the scope of the current algorithm or write other region growing algorithms. The function MergeRegions is interface for the operation that merges two regions.

The local variable GridSize is used to define the initial small regions that the image is fragmented (atomic regions) into. For an 12 x 12 input image, GridSize set equal to [3, 3] will result in 16 initial regions. The default values are set equal to 2. The user can sets the number of desired regions via the m_MaxNumRegions parameter and the algorithm tries to perform region merging until there are only m_MaxNumRegions. If m_MaxNumRegions is more than the number of initial blocks, no region merging occurs.

These blocks are important as the labels associated with these blocks keep changing during the region growing process and at the end, while generating the results, each of these atomic blocks are revisited and the blocks with same labels are considered to belong to the same region.

This object supports data handling of multiband images. The object accepts images in vector format, where each pixel is a vector and each element of the vector corresponds to an entry from 1 particular band of a multiband dataset. The input to this object is assumed to be a multiband vector image, and the output is defined by specific algorithm implementation. The second template parameter is used to generate the the output image and can be modified according the algorithm specific output type.

We expect the user to provide the input to the routine in vector format. A single band image is treated as a vector image with a single element for every vector.

Definition at line 80 of file itkRegionGrowImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef SmartPointer< const Self > itk::RegionGrowImageFilter< TInputImage, TOutputImage >::ConstPointer
template<class TInputImage , class TOutputImage >
typedef TInputImage::SizeType itk::RegionGrowImageFilter< TInputImage, TOutputImage >::GridSizeType

Type definition for the initial grid.

Reimplemented in itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >.

Definition at line 109 of file itkRegionGrowImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TInputImage::ConstPointer itk::RegionGrowImageFilter< TInputImage, TOutputImage >::InputImageConstPointer
template<class TInputImage , class TOutputImage >
typedef TInputImage::PixelType itk::RegionGrowImageFilter< TInputImage, TOutputImage >::InputImagePixelType

Type definition for the input image pixel type.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >.

Definition at line 99 of file itkRegionGrowImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TInputImage::Pointer itk::RegionGrowImageFilter< TInputImage, TOutputImage >::InputImagePointer
template<class TInputImage , class TOutputImage >
typedef TInputImage itk::RegionGrowImageFilter< TInputImage, TOutputImage >::InputImageType

Type definition for the input image.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >.

Definition at line 91 of file itkRegionGrowImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TOutputImage::PixelType itk::RegionGrowImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Type definition for the input image pixel type.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >.

Definition at line 106 of file itkRegionGrowImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TOutputImage::Pointer itk::RegionGrowImageFilter< TInputImage, TOutputImage >::OutputImagePointer
template<class TInputImage , class TOutputImage >
typedef TOutputImage itk::RegionGrowImageFilter< TInputImage, TOutputImage >::OutputImageType

Type definition for the output image.

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >.

Definition at line 102 of file itkRegionGrowImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef SmartPointer< Self > itk::RegionGrowImageFilter< TInputImage, TOutputImage >::Pointer
template<class TInputImage , class TOutputImage >
typedef RegionGrowImageFilter itk::RegionGrowImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >.

Definition at line 85 of file itkRegionGrowImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef ImageToImageFilter< TInputImage, TOutputImage > itk::RegionGrowImageFilter< TInputImage, TOutputImage >::Superclass

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >
itk::RegionGrowImageFilter< TInputImage, TOutputImage >::RegionGrowImageFilter ( ) [protected]
template<class TInputImage , class TOutputImage >
itk::RegionGrowImageFilter< TInputImage, TOutputImage >::~RegionGrowImageFilter ( ) [protected]
template<class TInputImage , class TOutputImage >
itk::RegionGrowImageFilter< TInputImage, TOutputImage >::RegionGrowImageFilter ( const Self ) [private]

Member Function Documentation

template<class TInputImage , class TOutputImage >
virtual void itk::RegionGrowImageFilter< TInputImage, TOutputImage >::ApplyRegionGrowImageFilter ( ) [pure virtual]
template<class TInputImage , class TOutputImage >
virtual const GridSizeType& itk::RegionGrowImageFilter< TInputImage, TOutputImage >::GetGridSize ( ) [virtual]

Set/Get the initial grid.

template<class TInputImage , class TOutputImage >
virtual const unsigned int& itk::RegionGrowImageFilter< TInputImage, TOutputImage >::GetMaximumNumberOfRegions ( ) [virtual]

Set/Get the number of regions desired.

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

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
virtual void itk::RegionGrowImageFilter< TInputImage, TOutputImage >::MergeRegions ( ) [pure virtual]
template<class TInputImage , class TOutputImage >
void itk::RegionGrowImageFilter< TInputImage, TOutputImage >::operator= ( const Self ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
void itk::RegionGrowImageFilter< TInputImage, TOutputImage >::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::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
virtual void itk::RegionGrowImageFilter< TInputImage, TOutputImage >::SetGridSize ( GridSizeType  _arg) [virtual]

Set/Get the initial grid.

template<class TInputImage , class TOutputImage >
virtual void itk::RegionGrowImageFilter< TInputImage, TOutputImage >::SetMaximumNumberOfRegions ( unsigned int  _arg) [virtual]

Set/Get the number of regions desired.


Member Data Documentation

template<class TInputImage , class TOutputImage >
GridSizeType itk::RegionGrowImageFilter< TInputImage, TOutputImage >::m_GridSize [private]

Definition at line 138 of file itkRegionGrowImageFilter.h.

template<class TInputImage , class TOutputImage >
unsigned int itk::RegionGrowImageFilter< TInputImage, TOutputImage >::m_MaximumNumberOfRegions [private]

Definition at line 136 of file itkRegionGrowImageFilter.h.


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