itk::RegionGrowImageFilter< TInputImage, TOutputImage > Class Template Reference
[Region Growing Filters]

Base class for RegionGrowImageFilter object. More...

#include <itkRegionGrowImageFilter.h>

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

[legend]Collaboration diagram for itk::RegionGrowImageFilter< TInputImage, TOutputImage >:

[legend]List of all members.

Public Types
typedef RegionGrowImageFilter	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef TInputImage::Pointer	InputImagePointer
typedef TInputImage::ConstPointer	InputImageConstPointer
typedef TInputImage::PixelType	InputImagePixelType
typedef TOutputImage	OutputImageType
typedef TOutputImage::Pointer	OutputImagePointer
typedef TOutputImage::PixelType	OutputImagePixelType
typedef TInputImage::SizeType	GridSizeType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual void	ApplyRegionGrowImageFilter ()
virtual void	MergeRegions ()
virtual void	SetGridSize (GridSizeType _arg)
virtual const GridSizeType &	GetGridSize ()
virtual void	SetMaximumNumberOfRegions (unsigned int _arg)
virtual const unsigned int &	GetMaximumNumberOfRegions ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	RegionGrowImageFilter ()
	~RegionGrowImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

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 79 of file itkRegionGrowImageFilter.h.

---

Member Typedef Documentation

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >. Definition at line 87 of file itkRegionGrowImageFilter.h.

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 111 of file itkRegionGrowImageFilter.h. Referenced by itk::RegionGrowImageFilter< TInputImage, TOutputImage >::MergeRegions().

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >. Definition at line 98 of file itkRegionGrowImageFilter.h.

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 101 of file itkRegionGrowImageFilter.h.

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >. Definition at line 97 of file itkRegionGrowImageFilter.h.

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 96 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::ImageSource< TOutputImage >. Reimplemented in itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >. Definition at line 108 of file itkRegionGrowImageFilter.h.

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

Reimplemented from itk::ImageSource< TOutputImage >. Reimplemented in itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >. Definition at line 105 of file itkRegionGrowImageFilter.h.

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 104 of file itkRegionGrowImageFilter.h.

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >. Definition at line 86 of file itkRegionGrowImageFilter.h.

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 84 of file itkRegionGrowImageFilter.h. Referenced by itk::RegionGrowImageFilter< TInputImage, TOutputImage >::MergeRegions().

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >. Definition at line 85 of file itkRegionGrowImageFilter.h.

---

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]

---

Member Function Documentation

template<class TInputImage, class TOutputImage> virtual void itk::RegionGrowImageFilter< TInputImage, TOutputImage >::ApplyRegionGrowImageFilter (   )  [inline, virtual]

Define a virtual RegionGrowImageFilter function. Reimplemented in itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >. Definition at line 124 of file itkRegionGrowImageFilter.h.

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 (   )  [inline, virtual]

Merge two regions. Reimplemented in itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >. Definition at line 127 of file itkRegionGrowImageFilter.h. References itk::RegionGrowImageFilter< TInputImage, TOutputImage >::GridSizeType, and itk::RegionGrowImageFilter< TInputImage, TOutputImage >::Self.

template<class TInputImage, class TOutputImage> Pointer itk::RegionGrowImageFilter< TInputImage, TOutputImage >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object. 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.

---

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

• itkRegionGrowImageFilter.h

---