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

itk::watershed::BoundaryResolver< TPixelType, TDimension > Class Template Reference
[Watershed-based Segmentation FiltersWatershed-based Segmentation Filters]

#include <itkWatershedBoundaryResolver.h>

Inheritance diagram for itk::watershed::BoundaryResolver:

Inheritance graph
[legend]
Collaboration diagram for itk::watershed::BoundaryResolver< TPixelType, TDimension >:

Collaboration graph
[legend]
List of all members.

[NOHEADER]

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

[NOHEADER]

virtual DataObjectPointer MakeOutput (unsigned int idx)
 BoundaryResolver ()
virtual ~BoundaryResolver ()
 BoundaryResolver (const Self &)
void operator= (const Self &)
void PrintSelf (std::ostream &os, Indent indent) const

Public Types

typedef TPixelType PixelType
typedef Boundary< PixelType,
TDimension > 
BoundaryType
typedef EquivalencyTable EquivalencyTableType
typedef Segmenter< Image<
TPixelType, TDimension > > 
SegmenterType
typedef DataObject::Pointer DataObjectPointer

Public Methods

 itkStaticConstMacro (ImageDimension, unsigned int, TDimension)
void GenerateData ()
void SetBoundaryA (BoundaryType *bd)
BoundaryType::Pointer GetBoundaryA ()
void SetBoundaryB (BoundaryType *bd)
BoundaryType::Pointer GetBoundaryB ()
virtual void SetFace (unsigned short _arg)
virtual unsigned short GetFace ()
void SetEquivalencyTable (EquivalencyTableType::Pointer a)
EquivalencyTableType::Pointer GetEquivalencyTable ()

Protected Methods

void GenerateOutputRequestedRegion (DataObject *output)

Protected Attributes

unsigned short m_Face

Detailed Description

template<class TPixelType, unsigned int TDimension>
class itk::watershed::BoundaryResolver< TPixelType, TDimension >

This filter implements a piece of the streaming watershed segmentation algorithm. It takes in pairs of itk::watershed::Boundary objects and connects the labeling of pixels across image chunk boundaries. Read the documentation found in itk::WatershedImageFilter and the other watershed segmentation component objects for more information.
A note on terminology in itk watershed segmentation code
For streamed segmentation of images in the watershed framework, the documentation refers to the complete data set at the ``image volume.'' The image volume is assumed to be partitioned into pieces referred to as image chunks. Each chunk is processed in sequence through the pipeline. The ``face'' of an image chunk is an N-1 dimensional boundary region of an N dimensional chunk (the planar faces of a cube, for example).
Input
The input to this filter is a pair of itk::watershed::Boundary pointers (BoundaryA and BoundaryB). The algorithm assumes that these Boundaries come from facing chunks in the image volume. The faces that align need to be specified in the parameters of the filter.
Output
This filter outputs a table of equivalencies among labels. See itk::WatershedEquivalencyTable for more information.
Parameters
The only parameters to set on this filter are the indicies of the faces that align in the boundary object inputs. See itk::Boundary for a description of how boundary faces are indexed.
See also:
itk::watershed::Boundary

Definition at line 66 of file itkWatershedBoundaryResolver.h.


Member Typedef Documentation

template<class TPixelType, unsigned int TDimension>
typedef Boundary<PixelType, TDimension> itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryType
 

Definition at line 83 of file itkWatershedBoundaryResolver.h.

template<class TPixelType, unsigned int TDimension>
typedef SmartPointer<const Self> itk::watershed::BoundaryResolver< TPixelType, TDimension >::ConstPointer
 

Set up smart pointer and object factory definitions.

Reimplemented from itk::ProcessObject.

Definition at line 73 of file itkWatershedBoundaryResolver.h.

template<class TPixelType, unsigned int TDimension>
typedef DataObject::Pointer itk::watershed::BoundaryResolver< TPixelType, TDimension >::DataObjectPointer
 

Smart Pointer type to a DataObject.

Reimplemented from itk::ProcessObject.

Definition at line 86 of file itkWatershedBoundaryResolver.h.

template<class TPixelType, unsigned int TDimension>
typedef EquivalencyTable itk::watershed::BoundaryResolver< TPixelType, TDimension >::EquivalencyTableType
 

Definition at line 84 of file itkWatershedBoundaryResolver.h.

template<class TPixelType, unsigned int TDimension>
typedef TPixelType itk::watershed::BoundaryResolver< TPixelType, TDimension >::PixelType
 

Some convenient typedefs.

Definition at line 82 of file itkWatershedBoundaryResolver.h.

template<class TPixelType, unsigned int TDimension>
typedef SmartPointer<Self> itk::watershed::BoundaryResolver< TPixelType, TDimension >::Pointer
 

Set up smart pointer and object factory definitions.

Reimplemented from itk::ProcessObject.

Definition at line 72 of file itkWatershedBoundaryResolver.h.

template<class TPixelType, unsigned int TDimension>
typedef Segmenter<Image<TPixelType, TDimension> > itk::watershed::BoundaryResolver< TPixelType, TDimension >::SegmenterType
 

Definition at line 85 of file itkWatershedBoundaryResolver.h.

template<class TPixelType, unsigned int TDimension>
typedef BoundaryResolver itk::watershed::BoundaryResolver< TPixelType, TDimension >::Self
 

Set up smart pointer and object factory definitions.

Reimplemented from itk::ProcessObject.

Definition at line 70 of file itkWatershedBoundaryResolver.h.

template<class TPixelType, unsigned int TDimension>
typedef ProcessObject itk::watershed::BoundaryResolver< TPixelType, TDimension >::Superclass
 

Set up smart pointer and object factory definitions.

Reimplemented from itk::ProcessObject.

Definition at line 71 of file itkWatershedBoundaryResolver.h.


Constructor & Destructor Documentation

template<class TPixelType, unsigned int TDimension>
itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryResolver   [inline, protected]
 

Standard itk::ProcessObject subclass method.

Definition at line 124 of file itkWatershedBoundaryResolver.h.

template<class TPixelType, unsigned int TDimension>
virtual itk::watershed::BoundaryResolver< TPixelType, TDimension >::~BoundaryResolver   [inline, protected, virtual]
 

Standard itk::ProcessObject subclass method.

Definition at line 131 of file itkWatershedBoundaryResolver.h.

References itk::watershed::BoundaryResolver< TPixelType, TDimension >::m_Face.

template<class TPixelType, unsigned int TDimension>
itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryResolver const Self   [inline, protected]
 

Standard itk::ProcessObject subclass method.

Definition at line 132 of file itkWatershedBoundaryResolver.h.


Member Function Documentation

template<class TPixelType, unsigned int TDimension>
void itk::watershed::BoundaryResolver< TPixelType, TDimension >::GenerateData   [virtual]
 

Standard non-threaded pipeline method

Reimplemented from itk::ProcessObject.

template<class TPixelType, unsigned int TDimension>
void itk::watershed::BoundaryResolver< TPixelType, TDimension >::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 TPixelType, unsigned int TDimension>
BoundaryType::Pointer itk::watershed::BoundaryResolver< TPixelType, TDimension >::GetBoundaryA   [inline]
 

Set/Get the first of two boundaries that are to be resolved.

Definition at line 91 of file itkWatershedBoundaryResolver.h.

References itk::ProcessObject::GetInput().

template<class TPixelType, unsigned int TDimension>
BoundaryType::Pointer itk::watershed::BoundaryResolver< TPixelType, TDimension >::GetBoundaryB   [inline]
 

Set/Get the second of two boundaries that are to be resolved.

Definition at line 98 of file itkWatershedBoundaryResolver.h.

template<class TPixelType, unsigned int TDimension>
virtual const char* itk::watershed::BoundaryResolver< TPixelType, TDimension >::GetClassName   const [virtual]
 

Set up smart pointer and object factory definitions.

Reimplemented from itk::ProcessObject.

template<class TPixelType, unsigned int TDimension>
EquivalencyTableType::Pointer itk::watershed::BoundaryResolver< TPixelType, TDimension >::GetEquivalencyTable   [inline]
 

This method sets/gets the equivalency table used to store equivalencies among segments that are generated from the boundary resolution algorithm.

Definition at line 113 of file itkWatershedBoundaryResolver.h.

template<class TPixelType, unsigned int TDimension>
virtual unsigned short itk::watershed::BoundaryResolver< TPixelType, TDimension >::GetFace   [virtual]
 

Set/Get the face of the boundary object that we are going to resolve.

template<class TPixelType, unsigned int TDimension>
itk::watershed::BoundaryResolver< TPixelType, TDimension >::itkStaticConstMacro ImageDimension   ,
unsigned    int,
TDimension   
 

Expose the image dimension at run time.

template<class TPixelType, unsigned int TDimension>
virtual DataObjectPointer itk::watershed::BoundaryResolver< TPixelType, TDimension >::MakeOutput unsigned int    idx [virtual]
 

Standard itk::ProcessObject subclass method.

Reimplemented from itk::ProcessObject.

template<class TPixelType, unsigned int TDimension>
Pointer itk::watershed::BoundaryResolver< TPixelType, TDimension >::New   [static]
 

Set up smart pointer and object factory definitions.

Reimplemented from itk::Object.

template<class TPixelType, unsigned int TDimension>
void itk::watershed::BoundaryResolver< TPixelType, TDimension >::operator= const Self   [inline, protected]
 

Standard itk::ProcessObject subclass method.

Reimplemented from itk::ProcessObject.

Definition at line 133 of file itkWatershedBoundaryResolver.h.

template<class TPixelType, unsigned int TDimension>
void itk::watershed::BoundaryResolver< TPixelType, TDimension >::PrintSelf std::ostream &    os,
Indent    indent
const [protected, virtual]
 

Standard itk::ProcessObject subclass method.

Reimplemented from itk::ProcessObject.

template<class TPixelType, unsigned int TDimension>
void itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryA BoundaryType   bd [inline]
 

Set/Get the first of two boundaries that are to be resolved.

Definition at line 89 of file itkWatershedBoundaryResolver.h.

template<class TPixelType, unsigned int TDimension>
void itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryB BoundaryType   bd [inline]
 

Set/Get the second of two boundaries that are to be resolved.

Definition at line 96 of file itkWatershedBoundaryResolver.h.

References itk::ProcessObject::GetInput().

template<class TPixelType, unsigned int TDimension>
void itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetEquivalencyTable EquivalencyTableType::Pointer    a [inline]
 

This method sets/gets the equivalency table used to store equivalencies among segments that are generated from the boundary resolution algorithm.

Definition at line 111 of file itkWatershedBoundaryResolver.h.

template<class TPixelType, unsigned int TDimension>
virtual void itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetFace unsigned short    _arg [virtual]
 

Set/Get the face of the boundary object that we are going to resolve.


Member Data Documentation

template<class TPixelType, unsigned int TDimension>
unsigned short itk::watershed::BoundaryResolver< TPixelType, TDimension >::m_Face [protected]
 

Definition at line 137 of file itkWatershedBoundaryResolver.h.

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::~BoundaryResolver().


The documentation for this class was generated from the following file:
Generated at Fri May 21 01:54:22 2004 for ITK by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2000