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

#include <itkWatershedEquivalenceRelabeler.h>

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

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

List of all members.

Public Types
typedef DataObject::Pointer	DataObjectPointer
typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef EquivalencyTable	EquivalencyTableType
typedef Image< IdentifierType, TImageDimension >	ImageType
typedef TScalarType	ScalarType
typedef Segmenter< Image < ScalarType, TImageDimension > >	SegmenterType
typedef EquivalenceRelabeler	Self
typedef ProcessObject	Superclass
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 ()
EquivalencyTableType::Pointer	GetEquivalencyTable ()
ImageType::Pointer	GetOutputImage ()
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)
void	SetEquivalencyTable (EquivalencyTableType *et)
void	SetOutputImage (ImageType *img)
void	SetInputImage (ImageType *img)
const ImageType *	GetInputImage (void)
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
	EquivalenceRelabeler ()
	EquivalenceRelabeler (const Self &)
void	GenerateInputRequestedRegion ()
void	GenerateOutputRequestedRegion (DataObject *output)
void	operator= (const Self &)
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~EquivalenceRelabeler ()
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 ()
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
Protected Attributes inherited from itk::ProcessObject
bool	m_Updating
TimeStamp	m_OutputInformationMTime

---

Detailed Description

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

This class is part of the set of watershed segmentation component objects. It is an image-to-image filter that relabels its input according to a set of equivalencies defined in a table. The filter is used in itk::WatershedImageFilter, for example, to relabel a segmented image at different hierarchies in the merge tree (see itk::WatershedImageFilter for documentation on terminology). It simply takes its input and changes any values found in the equivalency table.

Inputs

There are two inputs to this filter, an IdentifierType itk::Image of arbitrary dimension, and an itk::EquivalencyTable. The input image is the image to be relabeled and copied to the output, and the EquivalencyTable identifies how to relabel the values.

Output

The output of this filter is the relabeled IdentifierType itk::Image of same dimension and size as the input.

See also:

itk::WatershedImageFilter

EquivalencyTable

Definition at line 53 of file itkWatershedEquivalenceRelabeler.h.

---

Member Typedef Documentation

template<class TScalarType , unsigned int TImageDimension>

typedef SmartPointer< const Self > itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::ConstPointer

Define smart pointers for this object.

Reimplemented from itk::ProcessObject.

Definition at line 71 of file itkWatershedEquivalenceRelabeler.h.

template<class TScalarType , unsigned int TImageDimension>

typedef DataObject::Pointer itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::DataObjectPointer

Smart Pointer type to a DataObject.

Reimplemented from itk::ProcessObject.

Definition at line 67 of file itkWatershedEquivalenceRelabeler.h.

template<class TScalarType , unsigned int TImageDimension>

typedef ProcessObject::DataObjectPointerArraySizeType itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::DataObjectPointerArraySizeType

Standard itk::ProcessObject subclass method.

Reimplemented from itk::ProcessObject.

Definition at line 114 of file itkWatershedEquivalenceRelabeler.h.

template<class TScalarType , unsigned int TImageDimension>

typedef EquivalencyTable itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::EquivalencyTableType

Definition at line 65 of file itkWatershedEquivalenceRelabeler.h.

template<class TScalarType , unsigned int TImageDimension>

typedef Image< IdentifierType, TImageDimension > itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::ImageType

Some convenient typedefs.

Definition at line 61 of file itkWatershedEquivalenceRelabeler.h.

template<class TScalarType , unsigned int TImageDimension>

typedef SmartPointer< Self > itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::Pointer

Define smart pointers for this object.

Reimplemented from itk::ProcessObject.

Definition at line 70 of file itkWatershedEquivalenceRelabeler.h.

template<class TScalarType , unsigned int TImageDimension>

typedef TScalarType itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::ScalarType

Definition at line 64 of file itkWatershedEquivalenceRelabeler.h.

template<class TScalarType , unsigned int TImageDimension>

typedef Segmenter< Image< ScalarType, TImageDimension > > itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SegmenterType

Definition at line 66 of file itkWatershedEquivalenceRelabeler.h.

template<class TScalarType , unsigned int TImageDimension>

typedef EquivalenceRelabeler itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::Self

Standard class typedefs.

Reimplemented from itk::ProcessObject.

Definition at line 62 of file itkWatershedEquivalenceRelabeler.h.

template<class TScalarType , unsigned int TImageDimension>

typedef ProcessObject itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::Superclass

Reimplemented from itk::ProcessObject.

Definition at line 63 of file itkWatershedEquivalenceRelabeler.h.

---

Constructor & Destructor Documentation

template<class TScalarType , unsigned int TImageDimension>

itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::EquivalenceRelabeler ( )

inlineprotected

Definition at line 119 of file itkWatershedEquivalenceRelabeler.h.

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

template<class TScalarType , unsigned int TImageDimension>

virtual itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::~EquivalenceRelabeler ( )

inlineprotectedvirtual

Definition at line 127 of file itkWatershedEquivalenceRelabeler.h.

template<class TScalarType , unsigned int TImageDimension>

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

inlineprotected

Definition at line 128 of file itkWatershedEquivalenceRelabeler.h.

---

Member Function Documentation

template<class TScalarType , unsigned int TImageDimension>

virtual::itk::LightObject::Pointer itk::watershed::EquivalenceRelabeler< 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::EquivalenceRelabeler< TScalarType, TImageDimension >::GenerateData ( )

virtual

Standard non-threaded pipeline method

Reimplemented from itk::ProcessObject.

template<class TScalarType , unsigned int TImageDimension>

void itk::watershed::EquivalenceRelabeler< 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::EquivalenceRelabeler< 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>

EquivalencyTableType::Pointer itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::GetEquivalencyTable ( )

inline

Definition at line 104 of file itkWatershedEquivalenceRelabeler.h.

References itk::ProcessObject::GetInput().

template<class TScalarType , unsigned int TImageDimension>

const ImageType* itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::GetInputImage ( void  )

inline

Set/Get the image to relabel.

Definition at line 79 of file itkWatershedEquivalenceRelabeler.h.

References itk::ProcessObject::GetInput().

template<class TScalarType , unsigned int TImageDimension>

virtual const char* itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::GetNameOfClass ( ) const

virtual

Define smart pointers for this object.

Reimplemented from itk::ProcessObject.

template<class TScalarType , unsigned int TImageDimension>

ImageType::Pointer itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::GetOutputImage ( )

inline

Definition at line 92 of file itkWatershedEquivalenceRelabeler.h.

References itk::ProcessObject::GetOutput().

template<class TScalarType , unsigned int TImageDimension>

virtual DataObjectPointer itk::watershed::EquivalenceRelabeler< 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::EquivalenceRelabeler< TScalarType, TImageDimension >::New ( )

static

Define smart pointers for this object.

Reimplemented from itk::Object.

template<class TScalarType , unsigned int TImageDimension>

void itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::operator= ( const Self &  )

inlineprotected

Time when GenerateOutputInformation was last called.

Reimplemented from itk::ProcessObject.

Definition at line 129 of file itkWatershedEquivalenceRelabeler.h.

template<class TScalarType , unsigned int TImageDimension>

void itk::watershed::EquivalenceRelabeler< 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>

void itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetEquivalencyTable ( EquivalencyTableType *  et )

inline

Set/Get the table to use in relabeling the input image.

Definition at line 99 of file itkWatershedEquivalenceRelabeler.h.

References itk::ProcessObject::SetNthInput().

template<class TScalarType , unsigned int TImageDimension>

void itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetInputImage ( ImageType *  img )

inline

Set/Get the image to relabel.

Definition at line 77 of file itkWatershedEquivalenceRelabeler.h.

References itk::ProcessObject::SetNthInput().

template<class TScalarType , unsigned int TImageDimension>

void itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetOutputImage ( ImageType *  img )

inline

Set/Get the output image

Definition at line 87 of file itkWatershedEquivalenceRelabeler.h.

References itk::ProcessObject::SetNthOutput().

---

Member Data Documentation

template<class TScalarType , unsigned int TImageDimension>

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

static

Expose templated image dimension parameter at run time

Definition at line 58 of file itkWatershedEquivalenceRelabeler.h.

---

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

• itkWatershedEquivalenceRelabeler.h