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 Types inherited from itk::ProcessObject
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

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 ()
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

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 Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyInputInformation ()
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Protected Attributes
unsigned short	m_Face
Protected Attributes inherited from itk::ProcessObject
bool	m_Updating
TimeStamp	m_OutputInformationMTime
typedef BoundaryResolver	Self
typedef ProcessObject	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
static Pointer	New ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const

Additional Inherited Members

---

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 indices 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 ( )

inlineprotected

Definition at line 127 of file itkWatershedBoundaryResolver.h.

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

template<class TPixelType , unsigned int TDimension>

virtual itk::watershed::BoundaryResolver< TPixelType, TDimension >::~BoundaryResolver ( )

inlineprotectedvirtual

Definition at line 136 of file itkWatershedBoundaryResolver.h.

template<class TPixelType , unsigned int TDimension>

itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryResolver ( const Self &  )

inlineprotected

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 )

protectedvirtual

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 &  )

inlineprotected

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

protectedvirtual

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:

• itkWatershedBoundaryResolver.h