#include <itkWatershedEquivalenceRelabeler.h>

Detailed Description

template<typename TScalar, unsigned int TImageDimension>
class itk::watershed::EquivalenceRelabeler< TScalar, 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 54 of file itkWatershedEquivalenceRelabeler.h.

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

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

Public Types
using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

using	EquivalencyTableType = EquivalencyTable

using	ImageType = Image< IdentifierType, TImageDimension >

using	ScalarType = TScalar

using	SegmenterType = Segmenter< Image< ScalarType, TImageDimension > >

using	Self = EquivalenceRelabeler

using	Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
void	GenerateData () override

EquivalencyTableType::Pointer	GetEquivalencyTable ()

ImageType::Pointer	GetOutputImage ()

DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx) override

void	SetEquivalencyTable (EquivalencyTableType *et)

void	SetOutputImage (ImageType *img)


void	SetInputImage (ImageType *img)

const ImageType *	GetInputImage ()

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Attributes
static constexpr unsigned int	ImageDimension = TImageDimension

Protected Member Functions
	EquivalenceRelabeler ()

void	GenerateInputRequestedRegion () override

void	GenerateOutputRequestedRegion (DataObject *output) override

void	PrintSelf (std::ostream &os, Indent indent) const override

	~EquivalenceRelabeler () override=default

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

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 idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () const

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

using	Pointer = SmartPointer< Self >

using	ConstPointer = SmartPointer< const Self >

static Pointer	New ()

const char *	GetNameOfClass () const override

Additional Inherited Members
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TScalar , unsigned int TImageDimension>

using itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::ConstPointer = SmartPointer<const Self>

Define smart pointers for this object.

Definition at line 73 of file itkWatershedEquivalenceRelabeler.h.

◆ DataObjectPointer

template<typename TScalar , unsigned int TImageDimension>

using itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::DataObjectPointer = DataObject::Pointer

Definition at line 69 of file itkWatershedEquivalenceRelabeler.h.

◆ DataObjectPointerArraySizeType

template<typename TScalar , unsigned int TImageDimension>

using itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

Standard itk::ProcessObject subclass method.

Definition at line 122 of file itkWatershedEquivalenceRelabeler.h.

◆ EquivalencyTableType

template<typename TScalar , unsigned int TImageDimension>

using itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::EquivalencyTableType = EquivalencyTable

Definition at line 67 of file itkWatershedEquivalenceRelabeler.h.

◆ ImageType

template<typename TScalar , unsigned int TImageDimension>

using itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::ImageType = Image<IdentifierType, TImageDimension>

Some convenient type alias.

Definition at line 63 of file itkWatershedEquivalenceRelabeler.h.

◆ Pointer

template<typename TScalar , unsigned int TImageDimension>

using itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::Pointer = SmartPointer<Self>

Define smart pointers for this object.

Definition at line 72 of file itkWatershedEquivalenceRelabeler.h.

◆ ScalarType

template<typename TScalar , unsigned int TImageDimension>

using itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::ScalarType = TScalar

Definition at line 66 of file itkWatershedEquivalenceRelabeler.h.

◆ SegmenterType

template<typename TScalar , unsigned int TImageDimension>

using itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::SegmenterType = Segmenter<Image<ScalarType, TImageDimension> >

Definition at line 68 of file itkWatershedEquivalenceRelabeler.h.

◆ Self

template<typename TScalar , unsigned int TImageDimension>

using itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::Self = EquivalenceRelabeler

Definition at line 64 of file itkWatershedEquivalenceRelabeler.h.

◆ Superclass

template<typename TScalar , unsigned int TImageDimension>

using itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::Superclass = ProcessObject

Definition at line 65 of file itkWatershedEquivalenceRelabeler.h.

Constructor & Destructor Documentation

◆ EquivalenceRelabeler()

template<typename TScalar , unsigned int TImageDimension>

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

inlineprotected

Definition at line 128 of file itkWatershedEquivalenceRelabeler.h.

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

◆ ~EquivalenceRelabeler()

template<typename TScalar , unsigned int TImageDimension>

itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::~EquivalenceRelabeler ( )

overrideprotecteddefault

Member Function Documentation

◆ GenerateData()

template<typename TScalar , unsigned int TImageDimension>

void itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::GenerateData ( )

overridevirtual

Standard non-threaded pipeline method

Reimplemented from itk::ProcessObject.

◆ GenerateInputRequestedRegion()

template<typename TScalar , unsigned int TImageDimension>

void itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

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.

◆ GenerateOutputRequestedRegion()

template<typename TScalar , unsigned int TImageDimension>

void itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::GenerateOutputRequestedRegion ( DataObject * output )

overrideprotectedvirtual

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 appropriately.

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.

◆ GetEquivalencyTable()

template<typename TScalar , unsigned int TImageDimension>

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

inline

Definition at line 112 of file itkWatershedEquivalenceRelabeler.h.

References itk::ProcessObject::GetInput().

◆ GetInputImage()

template<typename TScalar , unsigned int TImageDimension>

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

inline

Set/Get the image to relabel.

Definition at line 85 of file itkWatershedEquivalenceRelabeler.h.

References itk::ProcessObject::GetInput().

◆ GetNameOfClass()

template<typename TScalar , unsigned int TImageDimension>

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

overridevirtual

Define smart pointers for this object.

Reimplemented from itk::ProcessObject.

◆ GetOutputImage()

template<typename TScalar , unsigned int TImageDimension>

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

inline

Definition at line 99 of file itkWatershedEquivalenceRelabeler.h.

References itk::ProcessObject::GetOutput().

◆ MakeOutput()

template<typename TScalar , unsigned int TImageDimension>

DataObjectPointer itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::MakeOutput ( DataObjectPointerArraySizeType idx )

overridevirtual

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.

◆ New()

template<typename TScalar , unsigned int TImageDimension>

static Pointer itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::New ( )

static

Define smart pointers for this object.

◆ PrintSelf()

template<typename TScalar , unsigned int TImageDimension>

void itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

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.

◆ SetEquivalencyTable()

template<typename TScalar , unsigned int TImageDimension>

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

inline

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

Definition at line 106 of file itkWatershedEquivalenceRelabeler.h.

References itk::ProcessObject::SetNthInput().

◆ SetInputImage()

template<typename TScalar , unsigned int TImageDimension>

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

inline

Set/Get the image to relabel.

Definition at line 80 of file itkWatershedEquivalenceRelabeler.h.

References itk::ProcessObject::SetNthInput().

◆ SetOutputImage()

template<typename TScalar , unsigned int TImageDimension>

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

inline

Set/Get the output image

Definition at line 93 of file itkWatershedEquivalenceRelabeler.h.

References itk::ProcessObject::SetNthOutput().

Member Data Documentation

◆ ImageDimension

template<typename TScalar , unsigned int TImageDimension>

constexpr unsigned int itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::ImageDimension = TImageDimension

staticconstexpr

Expose templated image dimension parameter at run time

Definition at line 60 of file itkWatershedEquivalenceRelabeler.h.

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

itkWatershedEquivalenceRelabeler.h

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ DataObjectPointer

◆ DataObjectPointerArraySizeType

◆ EquivalencyTableType

◆ ImageType

◆ Pointer

◆ ScalarType

◆ SegmenterType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ EquivalenceRelabeler()

◆ ~EquivalenceRelabeler()

Member Function Documentation

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GenerateOutputRequestedRegion()

◆ GetEquivalencyTable()

◆ GetInputImage()

◆ GetNameOfClass()

◆ GetOutputImage()

◆ MakeOutput()

◆ New()

◆ PrintSelf()

◆ SetEquivalencyTable()

◆ SetInputImage()

◆ SetOutputImage()

Member Data Documentation

◆ ImageDimension