itk::watershed::Relabeler< TScalarType, TImageDimension > Class Template Reference

#include <itkWatershedRelabeler.h>

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

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

List of all members.

Public Types
typedef DataObject::Pointer	DataObjectPointer
typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef Image< IdentifierType, TImageDimension >	ImageType
typedef TScalarType	ScalarType
typedef Segmenter< Image < ScalarType, TImageDimension > >	SegmenterType
typedef SegmentTree< ScalarType >	SegmentTreeType
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 ()
ImageType *	GetInputImage (void)
SegmentTreeType *	GetInputSegmentTree (void)
ImageType *	GetOutputImage (void)
void	GraftNthOutput (unsigned int idx, ImageType *graft)
void	GraftOutput (ImageType *graft)
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)
void	SetInputImage (ImageType *img)
void	SetInputSegmentTree (SegmentTreeType *et)
void	SetOutputImage (ImageType *img)
virtual void	SetFloodLevel (double _arg)
virtual double	GetFloodLevel () const
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 = TImageDimension

Protected Member Functions
void	GenerateInputRequestedRegion ()
void	GenerateOutputRequestedRegion (DataObject *output)
void	operator= (const Self &)
void	PrintSelf (std::ostream &os, Indent indent) const
	Relabeler ()
	Relabeler (const Self &)
virtual	~Relabeler ()
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	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
double	m_FloodLevel
Protected Attributes inherited from itk::ProcessObject
bool	m_Updating
TimeStamp	m_OutputInformationMTime
typedef Relabeler	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 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 ProcessObject::DataObjectPointerArraySizeType itk::watershed::Relabeler< TScalarType, TImageDimension >::DataObjectPointerArraySizeType

Standard itk::ProcessObject subclass method.

Reimplemented from itk::ProcessObject.

Definition at line 88 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>

typedef Image< IdentifierType, 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 ( )

inlineprotectedvirtual

Definition at line 144 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>

itk::watershed::Relabeler< TScalarType, TImageDimension >::Relabeler ( const Self &  )

inlineprotected

Definition at line 145 of file itkWatershedRelabeler.h.

---

Member Function Documentation

template<class TScalarType, unsigned int TImageDimension>

virtual::itk::LightObject::Pointer itk::watershed::Relabeler< TScalarType, TImageDimension >::CreateAnother ( void  ) const

virtual

Define smart pointers for this object

Reimplemented from itk::Object.

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

protectedvirtual

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 )

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 TScalarType, unsigned int TImageDimension>

virtual double itk::watershed::Relabeler< TScalarType, TImageDimension >::GetFloodLevel ( ) const

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

Definition at line 98 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>

SegmentTreeType* itk::watershed::Relabeler< TScalarType, TImageDimension >::GetInputSegmentTree ( void  )

inline

Definition at line 122 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

Definition at line 110 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>

void itk::watershed::Relabeler< TScalarType, TImageDimension >::GraftNthOutput	(	unsigned int	idx,
		ImageType *	graft
	)

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>

virtual DataObjectPointer itk::watershed::Relabeler< TScalarType, TImageDimension >::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 TScalarType, unsigned int TImageDimension>

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

inlineprotected

Time when GenerateOutputInformation was last called.

Reimplemented from itk::ProcessObject.

Definition at line 146 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>

void itk::watershed::Relabeler< TScalarType, TImageDimension >::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 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 93 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 117 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 105 of file itkWatershedRelabeler.h.

---

Member Data Documentation

template<class TScalarType, unsigned int TImageDimension>

const unsigned int itk::watershed::Relabeler< TScalarType, TImageDimension >::ImageDimension = TImageDimension

static

Expose the ImageDimension template parameter at run time

Definition at line 78 of file itkWatershedRelabeler.h.

template<class TScalarType, unsigned int TImageDimension>

double itk::watershed::Relabeler< TScalarType, TImageDimension >::m_FloodLevel

protected

Definition at line 149 of file itkWatershedRelabeler.h.

---

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

• itkWatershedRelabeler.h