ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes
itk::watershed::BoundaryResolver< TPixelType, TDimension > Class Template Reference

#include <itkWatershedBoundaryResolver.h>

+ Inheritance diagram for itk::watershed::BoundaryResolver< TPixelType, TDimension >:
+ Collaboration diagram for itk::watershed::BoundaryResolver< TPixelType, TDimension >:

List of all members.

Public Types

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

Public Member Functions

void GenerateData ()
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
void SetBoundaryA (BoundaryType *bd)
BoundaryType::Pointer GetBoundaryA ()
void SetBoundaryB (BoundaryType *bd)
BoundaryType::Pointer GetBoundaryB ()
virtual void SetFace (unsigned short _arg)
virtual unsigned short GetFace () const
void SetEquivalencyTable (EquivalencyTableType::Pointer a)
EquivalencyTableType::Pointer GetEquivalencyTable ()

Static Public Attributes

static const unsigned int ImageDimension = TDimension

Protected Member Functions

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

Protected Attributes

unsigned short m_Face
typedef BoundaryResolver Self
typedef ProcessObject Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const SelfConstPointer
static Pointer New ()
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const

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::EquivalencyTable 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 64 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 81 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 71 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 84 of file itkWatershedBoundaryResolver.h.

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

Standard itk::ProcessObject subclass method.

Reimplemented from itk::ProcessObject.

Definition at line 122 of file itkWatershedBoundaryResolver.h.

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

Definition at line 82 of file itkWatershedBoundaryResolver.h.

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

Some convenient typedefs.

Definition at line 80 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 70 of file itkWatershedBoundaryResolver.h.

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

Definition at line 83 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 68 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 69 of file itkWatershedBoundaryResolver.h.


Constructor & Destructor Documentation

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

Definition at line 136 of file itkWatershedBoundaryResolver.h.

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

Definition at line 137 of file itkWatershedBoundaryResolver.h.


Member Function Documentation

template<class TPixelType , unsigned int TDimension>
virtual::itk::LightObject::Pointer itk::watershed::BoundaryResolver< TPixelType, TDimension >::CreateAnother ( void  ) const [virtual]

Set up smart pointer and object factory definitions.

Reimplemented from itk::Object.

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 89 of file itkWatershedBoundaryResolver.h.

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 96 of file itkWatershedBoundaryResolver.h.

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 111 of file itkWatershedBoundaryResolver.h.

References itk::ProcessObject::GetOutput().

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

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

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

Set up smart pointer and object factory definitions.

Reimplemented from itk::ProcessObject.

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

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

template<class TPixelType , unsigned int TDimension>
static 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]

Time when GenerateOutputInformation was last called.

Reimplemented from itk::ProcessObject.

Definition at line 138 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]

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 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 87 of file itkWatershedBoundaryResolver.h.

References itk::ProcessObject::SetNthInput().

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 94 of file itkWatershedBoundaryResolver.h.

References itk::ProcessObject::SetNthInput().

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 109 of file itkWatershedBoundaryResolver.h.

References itk::SmartPointer< TObjectType >::GetPointer(), and itk::ProcessObject::SetNthOutput().

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>
const unsigned int itk::watershed::BoundaryResolver< TPixelType, TDimension >::ImageDimension = TDimension [static]

Expose the image dimension at run time.

Definition at line 77 of file itkWatershedBoundaryResolver.h.

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

Definition at line 141 of file itkWatershedBoundaryResolver.h.


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