ITK  5.2.0
Insight Toolkit
Public Types | Static Public Attributes | List of all members

#include <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 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
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TImageDimension
 
using Pointer = SmartPointer< Self >
 
using ConstPointer = SmartPointer< const Self >
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 
static Pointer New ()
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
void SetInputImage (ImageType *img)
 
const ImageTypeGetInputImage ()
 
void SetOutputImage (ImageType *img)
 
ImageType::Pointer GetOutputImage ()
 
void SetEquivalencyTable (EquivalencyTableType *et)
 
EquivalencyTableType::Pointer GetEquivalencyTable ()
 
void GenerateData () override
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
 EquivalenceRelabeler ()
 
 ~EquivalenceRelabeler () override=default
 
 EquivalenceRelabeler (const Self &)
 
void operator= (const Self &)
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void GenerateOutputRequestedRegion (DataObject *output) override
 
void GenerateInputRequestedRegion () override
 

Additional Inherited Members

- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
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 void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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)
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void GenerateOutputInformation ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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.

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 72 of file itkWatershedEquivalenceRelabeler.h.

◆ DataObjectPointer

template<typename TScalar , unsigned int TImageDimension>
using itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::DataObjectPointer = DataObject::Pointer

Definition at line 68 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 121 of file itkWatershedEquivalenceRelabeler.h.

◆ EquivalencyTableType

template<typename TScalar , unsigned int TImageDimension>
using itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::EquivalencyTableType = EquivalencyTable

Definition at line 66 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 62 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 71 of file itkWatershedEquivalenceRelabeler.h.

◆ ScalarType

template<typename TScalar , unsigned int TImageDimension>
using itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::ScalarType = TScalar

Definition at line 65 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 67 of file itkWatershedEquivalenceRelabeler.h.

◆ Self

template<typename TScalar , unsigned int TImageDimension>
using itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::Self = EquivalenceRelabeler

Definition at line 63 of file itkWatershedEquivalenceRelabeler.h.

◆ Superclass

template<typename TScalar , unsigned int TImageDimension>
using itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::Superclass = ProcessObject

Definition at line 64 of file itkWatershedEquivalenceRelabeler.h.

Constructor & Destructor Documentation

◆ EquivalenceRelabeler() [1/2]

template<typename TScalar , unsigned int TImageDimension>
itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::EquivalenceRelabeler ( )
inlineprotected

Define smart pointers for this object.

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

Define smart pointers for this object.

◆ EquivalenceRelabeler() [2/2]

template<typename TScalar , unsigned int TImageDimension>
itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::EquivalenceRelabeler ( const Self )
inlineprotected

Define smart pointers for this object.

Definition at line 135 of file itkWatershedEquivalenceRelabeler.h.

Member Function Documentation

◆ CreateAnother()

template<typename TScalar , unsigned int TImageDimension>
virtual::itk::LightObject::Pointer itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::CreateAnother ( ) const
virtual

Define smart pointers for this object.

Reimplemented from itk::Object.

◆ 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

Define smart pointers for this object.

Reimplemented from itk::ProcessObject.

◆ GenerateOutputRequestedRegion()

template<typename TScalar , unsigned int TImageDimension>
void itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::GenerateOutputRequestedRegion ( DataObject output)
overrideprotectedvirtual

Define smart pointers for this object.

Reimplemented from itk::ProcessObject.

◆ GetEquivalencyTable()

template<typename TScalar , unsigned int TImageDimension>
EquivalencyTableType::Pointer itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::GetEquivalencyTable ( )
inline

Define smart pointers for this object.

Definition at line 111 of file itkWatershedEquivalenceRelabeler.h.

References itk::ProcessObject::GetInput().

◆ GetInputImage()

template<typename TScalar , unsigned int TImageDimension>
const ImageType* itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::GetInputImage ( )
inline

Define smart pointers for this object.

Definition at line 84 of file itkWatershedEquivalenceRelabeler.h.

References itk::ProcessObject::GetInput().

◆ GetNameOfClass()

template<typename TScalar , unsigned int TImageDimension>
virtual const char* itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::GetNameOfClass ( ) const
virtual

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

Define smart pointers for this object.

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

Define smart pointers for this object.

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.

◆ operator=()

template<typename TScalar , unsigned int TImageDimension>
void itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::operator= ( const Self )
inlineprotected

Define smart pointers for this object.

Definition at line 137 of file itkWatershedEquivalenceRelabeler.h.

◆ PrintSelf()

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

Define smart pointers for this object.

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 105 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 79 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 92 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 59 of file itkWatershedEquivalenceRelabeler.h.


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