itk::KLMSegmentationRegion Class Reference
[Region Growing Filters]

Base class for KLMSegmentationRegion object. More...

#include <itkKLMSegmentationRegion.h>

Inheritance diagram for itk::KLMSegmentationRegion:

[legend]Collaboration diagram for itk::KLMSegmentationRegion:

[legend]List of all members.

Public Types
typedef KLMSegmentationRegion	Self
typedef SegmentationRegion	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef std::vector< KLMSegmentationBorder * >	RegionBorderVectorType
typedef RegionBorderVectorType::iterator	RegionBorderVectorIterator
Public Methods
virtual const char *	GetClassName () const
void	SetRegion (VectorOfDoubleType regionMeanIntensity, unsigned int regionArea, unsigned int label)
void	SetRegionBorder (KLMSegmentationBorder *pNewRegionBorder)
void	SetRegionBorder3d (KLMSegmentationBorder *pNewRegionBorder)
KLMSegmentationBorder *	GetFirstRegionBorder ()
void	DeleteRegionBorder (KLMSegmentationBorder *pBorderCandidate)
void	InsertRegionBorder (RegionBorderVectorIterator it, KLMSegmentationBorder *pBorderCandidate)
void	DeleteAllRegionBorders ()
void	ReorderRegionBorders (KLMSegmentationBorder *pBorderCandidate)
RegionBorderVectorIterator	GetRegionBorderItBegin ()
RegionBorderVectorIterator	GetRegionBorderItEnd ()
void	UpdateRegionBorderLambda ()
void	PrintRegionInfo ()
Static Public Methods
Pointer	New ()
Protected Methods
	KLMSegmentationRegion ()
	~KLMSegmentationRegion ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

Base class for KLMSegmentationRegion object.

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

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.

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.

Data structures for a regions ============================= A region is defined as a closed area in the image that is surrounded by a list of borders objects (see itkKLMSegmentationBorder class).

Shown below is an initial 4x3 grid size partition of a 8x9 image. The initial region blocks are labeled in hexadecimal, and the region borders are shown as E = border pixel, and C = non-border pixel. Note that the border pixel grid is one pixel larger than the region grid. The border pixel grid can be considered to lie interspersed within the region pixel grid with four border pixels surrounding each interior region pixel.

\begin{center} Initial regions of a 8 by 9 image with a 4 by 3 grid partition. \ \begin{tabular}{|c|c|c|c|c|c|c|c|c|} \hline 1 & 1 & 1 & 2 & 2 & 2 & 3 & 3 & 3 \ \hline 1 & 1 & 1 & 2 & 2 & 2 & 3 & 3 & 3 \ \hline 4 & 4 & 4 & 5 & 5 & 5 & 6 & 6 & 6 \ \hline 4 & 4 & 4 & 5 & 5 & 5 & 6 & 6 & 6 \ \hline 7 & 7 & 7 & 8 & 8 & 8 & 9 & 9 & 9 \ \hline 7 & 7 & 7 & 8 & 8 & 8 & 9 & 9 & 9 \ \hline a & a & a & b & b & b & c & c & c \ \hline a & a & a & b & b & b & c & c & c \ \hline \end{tabular} \end{center}

\begin{center} Region borders are shown as ``E''. \ \begin{tabular}{|c|c|c|c|c|c|c|c|c|c|} \hline C & C & C & E & C & C & E & C & C & C \ \hline C & C & C & E & C & C & E & C & C & C \ \hline E & E & E & E & E & E & E & E & E & E \ \hline C & C & C & E & C & C & E & C & C & C \ \hline E & E & E & E & E & E & E & E & E & E \ \hline C & C & C & E & C & C & E & C & C & C \ \hline E & E & E & E & E & E & E & E & E & E \ \hline C & C & C & E & C & C & E & C & C & C \ \hline C & C & C & E & C & C & E & C & C & C \ \hline \end{tabular} \end{center}

Definition at line 96 of file itkKLMSegmentationRegion.h.

---

Member Typedef Documentation

typedef SmartPointer<const Self> itk::KLMSegmentationRegion::ConstPointer

Reimplemented from itk::SegmentationRegion. Definition at line 107 of file itkKLMSegmentationRegion.h.

typedef SmartPointer<Self> itk::KLMSegmentationRegion::Pointer

Reimplemented from itk::SegmentationRegion. Definition at line 106 of file itkKLMSegmentationRegion.h.

typedef RegionBorderVectorType::iterator itk::KLMSegmentationRegion::RegionBorderVectorIterator

Type definition for the region border vector iterators to be used. Definition at line 121 of file itkKLMSegmentationRegion.h.

typedef std::vector< KLMSegmentationBorder* > itk::KLMSegmentationRegion::RegionBorderVectorType

Type definition for vector container that stores the borders associated with a current region. Definition at line 118 of file itkKLMSegmentationRegion.h.

typedef KLMSegmentationRegion itk::KLMSegmentationRegion::Self

Standard class typedefs. Reimplemented from itk::SegmentationRegion. Definition at line 104 of file itkKLMSegmentationRegion.h.

typedef SegmentationRegion itk::KLMSegmentationRegion::Superclass

Reimplemented from itk::SegmentationRegion. Definition at line 105 of file itkKLMSegmentationRegion.h.

---

Constructor & Destructor Documentation

itk::KLMSegmentationRegion::KLMSegmentationRegion (    )  [protected]

itk::KLMSegmentationRegion::~KLMSegmentationRegion (    )  [protected]

---

Member Function Documentation

void itk::KLMSegmentationRegion::DeleteAllRegionBorders (    )

Delete all region borders

void itk::KLMSegmentationRegion::DeleteRegionBorder (  KLMSegmentationBorder *    pBorderCandidate )

Delete a region border.

virtual const char* itk::KLMSegmentationRegion::GetClassName (    )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::SegmentationRegion.

KLMSegmentationBorder* itk::KLMSegmentationRegion::GetFirstRegionBorder (    )

Get the first border associated with a region.

RegionBorderVectorIterator itk::KLMSegmentationRegion::GetRegionBorderItBegin (    )

Get a head pointer to the vector containter storing the borders associated with a region.

RegionBorderVectorIterator itk::KLMSegmentationRegion::GetRegionBorderItEnd (    )

Get a tail pointer to the vector containter storing the borders associated with a region.

void itk::KLMSegmentationRegion::InsertRegionBorder (  RegionBorderVectorIterator    it, KLMSegmentationBorder *    pBorderCandidate )

Insert a region border.

Pointer itk::KLMSegmentationRegion::New (    )  [static]

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

void itk::KLMSegmentationRegion::PrintRegionInfo (    )

Function that allows printing of the region parameters using std::cout.

void itk::KLMSegmentationRegion::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::SegmentationRegion.

void itk::KLMSegmentationRegion::ReorderRegionBorders (  KLMSegmentationBorder *    pBorderCandidate )

Reorder the region borders given a candidate border after region merging.

void itk::KLMSegmentationRegion::SetRegion (  VectorOfDoubleType    regionMeanIntensity, unsigned int    regionArea, unsigned int    label )

Set the region with parameter values defining the region.

void itk::KLMSegmentationRegion::SetRegionBorder (  KLMSegmentationBorder *    pNewRegionBorder )

Set the border associated with a region.

void itk::KLMSegmentationRegion::SetRegionBorder3d (  KLMSegmentationBorder *    pNewRegionBorder )

Set the border associated with a region.

void itk::KLMSegmentationRegion::UpdateRegionBorderLambda (    )

Recalculate the lambda values for all the borders defining the region and resort the entire border list in decending order of the lambda values.

---

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

• itkKLMSegmentationRegion.h

---