Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::watershed::Relabeler< TScalarType, TImageDimension > Class Template Reference
[Watershed-based Segmentation Filters]

#include <itkWatershedRelabeler.h>

Inheritance diagram for itk::watershed::Relabeler< TScalarType, TImageDimension >:

Inheritance graph
[legend]
Collaboration diagram for itk::watershed::Relabeler< TScalarType, TImageDimension >:

Collaboration graph
[legend]
List of all members.

[NOHEADER]

typedef Relabeler Self
typedef ProcessObject Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
virtual const char * GetNameOfClass () const
Pointer New ()

Public Types

typedef TScalarType ScalarType
typedef Image< unsigned long,
TImageDimension > 
ImageType
typedef SegmentTree< ScalarTypeSegmentTreeType
typedef Segmenter< Image<
ScalarType, TImageDimension > > 
SegmenterType
typedef DataObject::Pointer DataObjectPointer

Public Member Functions

 itkStaticConstMacro (ImageDimension, unsigned int, TImageDimension)
virtual DataObjectPointer MakeOutput (unsigned int idx)
void GenerateData ()
void SetInputImage (ImageType *img)
ImageTypeGetInputImage (void)
void SetOutputImage (ImageType *img)
ImageTypeGetOutputImage (void)
void SetInputSegmentTree (SegmentTreeType *et)
SegmentTreeTypeGetInputSegmentTree (void)
virtual void SetFloodLevel (double _arg)
virtual double GetFloodLevel ()
void GraftOutput (ImageType *graft)
void GraftNthOutput (unsigned int idx, ImageType *graft)

Protected Member Functions

 Relabeler ()
virtual ~Relabeler ()
 Relabeler (const Self &)
void operator= (const Self &)
void PrintSelf (std::ostream &os, Indent indent) const
void GenerateOutputRequestedRegion (DataObject *output)
void GenerateInputRequestedRegion ()

Protected Attributes

double m_FloodLevel

Detailed Description

template<class TScalarType, unsigned int TImageDimension>
class itk::watershed::Relabeler< TScalarType, TImageDimension >

This filter implements the final step in the watershed segmentation algorithm. It is responsible for relabeling a segmented image according to a specified saliency level (flood level) in a merge tree. (See itk::WatershedImageFilter for information on terminology used in this documentation.)

Inputs
There are two inputs to this filter. The first input is a labeled image of unsigned long integers, such as is produced by itk::watershed::Segmenter. The second input is an itk::watershed::SegmentTree, which is the merge tree data structure produced by the itk::watershed::SegmentTreeGenerator filter. The merge tree represents the hierarchy of merges among adjacent segments in the initial segmentation image.
Output
The output of this filter is a relabeled image of unsigned long integers of dimension and size matching the input.
Parameters
There is a single parameter FloodLevel for this filter. FloodLevel is given in percentage points (0.0 - 1.0) of the maximum saliency found in the merge tree. A FloodLevel of 0.0 will produce an output in which no segments are relabeled (merged). A FloodLevel of 1.0 will produce an output in which all the entries in the merge tree are used to relabel the image. FloodLevel controls which level in the segmentation hierarchy to produce on the output.
See also:
itk::WatershedImageFilter

itk::EquivalencyTable

itk::watershed::SegmentTree

Definition at line 64 of file itkWatershedRelabeler.h.


Member Typedef Documentation

template<class TScalarType, unsigned int TImageDimension>
typedef SmartPointer<const Self> itk::watershed::Relabeler< TScalarType, TImageDimension >::ConstPointer
 

Define smart pointers for this object

Reimplemented from itk::ProcessObject.

Definition at line 72 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>
typedef DataObject::Pointer itk::watershed::Relabeler< TScalarType, TImageDimension >::DataObjectPointer
 

Smart Pointer type to a DataObject.

Reimplemented from itk::ProcessObject.

Definition at line 85 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>
typedef Image<unsigned long, TImageDimension> itk::watershed::Relabeler< TScalarType, TImageDimension >::ImageType
 

Definition at line 82 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>
typedef SmartPointer<Self> itk::watershed::Relabeler< TScalarType, TImageDimension >::Pointer
 

Define smart pointers for this object

Reimplemented from itk::ProcessObject.

Definition at line 71 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>
typedef TScalarType itk::watershed::Relabeler< TScalarType, TImageDimension >::ScalarType
 

Some convenient typedefs

Definition at line 81 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>
typedef Segmenter<Image<ScalarType, TImageDimension> > itk::watershed::Relabeler< TScalarType, TImageDimension >::SegmenterType
 

Definition at line 84 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>
typedef SegmentTree<ScalarType> itk::watershed::Relabeler< TScalarType, TImageDimension >::SegmentTreeType
 

Definition at line 83 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>
typedef Relabeler itk::watershed::Relabeler< TScalarType, TImageDimension >::Self
 

Define smart pointers for this object

Reimplemented from itk::ProcessObject.

Definition at line 69 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>
typedef ProcessObject itk::watershed::Relabeler< TScalarType, TImageDimension >::Superclass
 

Define smart pointers for this object

Reimplemented from itk::ProcessObject.

Definition at line 70 of file itkWatershedRelabeler.h.


Constructor & Destructor Documentation

template<class TScalarType, unsigned int TImageDimension>
itk::watershed::Relabeler< TScalarType, TImageDimension >::Relabeler  )  [protected]
 

template<class TScalarType, unsigned int TImageDimension>
virtual itk::watershed::Relabeler< TScalarType, TImageDimension >::~Relabeler  )  [inline, protected, virtual]
 

Definition at line 140 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>
itk::watershed::Relabeler< TScalarType, TImageDimension >::Relabeler const Self  )  [inline, protected]
 

Definition at line 141 of file itkWatershedRelabeler.h.


Member Function Documentation

template<class TScalarType, unsigned int TImageDimension>
void itk::watershed::Relabeler< TScalarType, TImageDimension >::GenerateData  )  [virtual]
 

Standard non-threaded pipeline method

Reimplemented from itk::ProcessObject.

template<class TScalarType, unsigned int TImageDimension>
void itk::watershed::Relabeler< TScalarType, TImageDimension >::GenerateInputRequestedRegion  )  [protected, virtual]
 

What is the input requested region that is required to produce the output requested region? By default, the largest possible region is always required but this is overridden in many subclasses. For instance, for an image processing filter where an output pixel is a simple function of an input pixel, the input requested region will be set to the output requested region. For an image processing filter where an output pixel is a function of the pixels in a neighborhood of an input pixel, then the input requested region will need to be larger than the output requested region (to avoid introducing artificial boundary conditions). This function should never request an input region that is outside the the input largest possible region (i.e. implementations of this method should crop the input requested region at the boundaries of the input largest possible region).

Reimplemented from itk::ProcessObject.

template<class TScalarType, unsigned int TImageDimension>
void itk::watershed::Relabeler< TScalarType, TImageDimension >::GenerateOutputRequestedRegion DataObject output  )  [protected, virtual]
 

Given one output whose requested region has been set, how should the requested regions for the remaining outputs of the process object be set? By default, all the outputs are set to the same requested region. If a filter needs to produce different requested regions for each output, for instance an image processing filter producing several outputs at different resolutions, then that filter may override this method and set the requested regions appropriatedly.

Note that a filter producing multiple outputs of different types is required to override this method. The default implementation can only correctly handle multiple outputs of the same type.

Reimplemented from itk::ProcessObject.

template<class TScalarType, unsigned int TImageDimension>
virtual double itk::watershed::Relabeler< TScalarType, TImageDimension >::GetFloodLevel  )  [virtual]
 

Set/Get the percentage of the maximum saliency level to merge to.

template<class TScalarType, unsigned int TImageDimension>
ImageType* itk::watershed::Relabeler< TScalarType, TImageDimension >::GetInputImage void   )  [inline]
 

Set/Get the input image

Definition at line 95 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>
SegmentTreeType* itk::watershed::Relabeler< TScalarType, TImageDimension >::GetInputSegmentTree void   )  [inline]
 

Set/Get the input tree that defines segment merges

Definition at line 117 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>
virtual const char* itk::watershed::Relabeler< TScalarType, TImageDimension >::GetNameOfClass  )  const [virtual]
 

Define smart pointers for this object

Reimplemented from itk::ProcessObject.

template<class TScalarType, unsigned int TImageDimension>
ImageType* itk::watershed::Relabeler< TScalarType, TImageDimension >::GetOutputImage void   )  [inline]
 

Set/Get the output image

Definition at line 107 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>
void itk::watershed::Relabeler< TScalarType, TImageDimension >::GraftNthOutput unsigned int  idx,
ImageType graft
 

Standard ProcessObject method used in implementing mini-pipelines

template<class TScalarType, unsigned int TImageDimension>
void itk::watershed::Relabeler< TScalarType, TImageDimension >::GraftOutput ImageType graft  ) 
 

Standard ProcessObject method used in implementing mini-pipelines

template<class TScalarType, unsigned int TImageDimension>
itk::watershed::Relabeler< TScalarType, TImageDimension >::itkStaticConstMacro ImageDimension  ,
unsigned  int,
TImageDimension 
 

Expose the ImageDimension template parameter at run time

template<class TScalarType, unsigned int TImageDimension>
virtual DataObjectPointer itk::watershed::Relabeler< TScalarType, TImageDimension >::MakeOutput unsigned int  idx  )  [virtual]
 

Standard itk::ProcessObject subclass method.

Reimplemented from itk::ProcessObject.

template<class TScalarType, unsigned int TImageDimension>
Pointer itk::watershed::Relabeler< TScalarType, TImageDimension >::New  )  [static]
 

Define smart pointers for this object

Reimplemented from itk::Object.

template<class TScalarType, unsigned int TImageDimension>
void itk::watershed::Relabeler< TScalarType, TImageDimension >::operator= const Self  )  [inline, protected]
 

Reimplemented from itk::ProcessObject.

Definition at line 142 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>
void itk::watershed::Relabeler< TScalarType, TImageDimension >::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::ProcessObject.

template<class TScalarType, unsigned int TImageDimension>
virtual void itk::watershed::Relabeler< TScalarType, TImageDimension >::SetFloodLevel double  _arg  )  [virtual]
 

Set/Get the percentage of the maximum saliency level to merge to.

template<class TScalarType, unsigned int TImageDimension>
void itk::watershed::Relabeler< TScalarType, TImageDimension >::SetInputImage ImageType img  )  [inline]
 

Set/Get the input image

Definition at line 91 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>
void itk::watershed::Relabeler< TScalarType, TImageDimension >::SetInputSegmentTree SegmentTreeType et  )  [inline]
 

Set/Get the input tree that defines segment merges

Definition at line 113 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>
void itk::watershed::Relabeler< TScalarType, TImageDimension >::SetOutputImage ImageType img  )  [inline]
 

Set/Get the output image

Definition at line 103 of file itkWatershedRelabeler.h.


Member Data Documentation

template<class TScalarType, unsigned int TImageDimension>
double itk::watershed::Relabeler< TScalarType, TImageDimension >::m_FloodLevel [protected]
 

Definition at line 145 of file itkWatershedRelabeler.h.


The documentation for this class was generated from the following file:
Generated at Thu May 25 03:17:40 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000