ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members

#include <itkWatershedRelabeler.h>

Detailed Description

template<typename TScalar, unsigned int TImageDimension>
class itk::watershed::Relabeler< TScalar, 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 65 of file itkWatershedRelabeler.h.

+ Inheritance diagram for itk::watershed::Relabeler< TScalar, TImageDimension >:
+ Collaboration diagram for itk::watershed::Relabeler< TScalar, TImageDimension >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 
using ImageType = Image< IdentifierType, TImageDimension >
 
using Pointer = SmartPointer< Self >
 
using ScalarType = TScalar
 
using SegmenterType = Segmenter< Image< ScalarType, TImageDimension > >
 
using SegmentTreeType = SegmentTree< ScalarType >
 
using Self = Relabeler
 
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
 
ImageTypeGetInputImage ()
 
SegmentTreeTypeGetInputSegmentTree ()
 
ImageTypeGetOutputImage ()
 
void GraftNthOutput (unsigned int idx, ImageType *graft)
 
void GraftOutput (ImageType *graft)
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
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 AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
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 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 ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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
 
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
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TImageDimension
 

Protected Member Functions

void GenerateInputRequestedRegion () override
 
void GenerateOutputRequestedRegion (DataObject *output) override
 
void operator= (const Self &)
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 Relabeler ()
 
 Relabeler (const Self &)
 
 ~Relabeler () 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 GenerateOutputInformation ()
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () 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 ()
 
 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 () ITKv5_CONST
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () 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
 
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 PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

double m_FloodLevel { 0.0 }
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 
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
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 

Member Typedef Documentation

◆ ConstPointer

template<typename TScalar, unsigned int TImageDimension>
using itk::watershed::Relabeler< TScalar, TImageDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 73 of file itkWatershedRelabeler.h.

◆ DataObjectPointer

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

Definition at line 88 of file itkWatershedRelabeler.h.

◆ DataObjectPointerArraySizeType

template<typename TScalar, unsigned int TImageDimension>
using itk::watershed::Relabeler< TScalar, TImageDimension >::DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

Standard itk::ProcessObject subclass method.

Definition at line 91 of file itkWatershedRelabeler.h.

◆ ImageType

template<typename TScalar, unsigned int TImageDimension>
using itk::watershed::Relabeler< TScalar, TImageDimension >::ImageType = Image<IdentifierType, TImageDimension>

Definition at line 85 of file itkWatershedRelabeler.h.

◆ Pointer

template<typename TScalar, unsigned int TImageDimension>
using itk::watershed::Relabeler< TScalar, TImageDimension >::Pointer = SmartPointer<Self>

Definition at line 72 of file itkWatershedRelabeler.h.

◆ ScalarType

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

Some convenient type alias

Definition at line 84 of file itkWatershedRelabeler.h.

◆ SegmenterType

template<typename TScalar, unsigned int TImageDimension>
using itk::watershed::Relabeler< TScalar, TImageDimension >::SegmenterType = Segmenter<Image<ScalarType, TImageDimension> >

Definition at line 87 of file itkWatershedRelabeler.h.

◆ SegmentTreeType

template<typename TScalar, unsigned int TImageDimension>
using itk::watershed::Relabeler< TScalar, TImageDimension >::SegmentTreeType = SegmentTree<ScalarType>

Definition at line 86 of file itkWatershedRelabeler.h.

◆ Self

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

Define smart pointers for this object

Definition at line 70 of file itkWatershedRelabeler.h.

◆ Superclass

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

Definition at line 71 of file itkWatershedRelabeler.h.

Constructor & Destructor Documentation

◆ Relabeler() [1/2]

template<typename TScalar, unsigned int TImageDimension>
itk::watershed::Relabeler< TScalar, TImageDimension >::Relabeler ( )
protected

◆ ~Relabeler()

template<typename TScalar, unsigned int TImageDimension>
itk::watershed::Relabeler< TScalar, TImageDimension >::~Relabeler ( )
overrideprotecteddefault

◆ Relabeler() [2/2]

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

Definition at line 155 of file itkWatershedRelabeler.h.

Member Function Documentation

◆ GenerateData()

template<typename TScalar, unsigned int TImageDimension>
void itk::watershed::Relabeler< TScalar, TImageDimension >::GenerateData ( )
overridevirtual

Standard non-threaded pipeline method

Reimplemented from itk::ProcessObject.

◆ GenerateInputRequestedRegion()

template<typename TScalar, unsigned int TImageDimension>
void itk::watershed::Relabeler< 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::Relabeler< 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.

◆ GetFloodLevel()

template<typename TScalar, unsigned int TImageDimension>
virtual double itk::watershed::Relabeler< TScalar, TImageDimension >::GetFloodLevel ( ) const
virtual

Set/Get the percentage of the maximum saliency level to merge to.

◆ GetInputImage()

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

Definition at line 104 of file itkWatershedRelabeler.h.

◆ GetInputSegmentTree()

template<typename TScalar, unsigned int TImageDimension>
SegmentTreeType* itk::watershed::Relabeler< TScalar, TImageDimension >::GetInputSegmentTree ( )
inline

Definition at line 130 of file itkWatershedRelabeler.h.

◆ GetNameOfClass()

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

Method for creation through the object factory.

Reimplemented from itk::ProcessObject.

◆ GetOutputImage()

template<typename TScalar, unsigned int TImageDimension>
ImageType* itk::watershed::Relabeler< TScalar, TImageDimension >::GetOutputImage ( )
inline

Definition at line 117 of file itkWatershedRelabeler.h.

◆ GraftNthOutput()

template<typename TScalar, unsigned int TImageDimension>
void itk::watershed::Relabeler< TScalar, TImageDimension >::GraftNthOutput ( unsigned int  idx,
ImageType graft 
)

◆ GraftOutput()

template<typename TScalar, unsigned int TImageDimension>
void itk::watershed::Relabeler< TScalar, TImageDimension >::GraftOutput ( ImageType graft)

Standard ProcessObject method used in implementing mini-pipelines

◆ MakeOutput()

template<typename TScalar, unsigned int TImageDimension>
DataObjectPointer itk::watershed::Relabeler< 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::Relabeler< TScalar, TImageDimension >::New ( )
static

Method for creation through the object factory.

◆ operator=()

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

Definition at line 157 of file itkWatershedRelabeler.h.

◆ PrintSelf()

template<typename TScalar, unsigned int TImageDimension>
void itk::watershed::Relabeler< 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.

◆ SetFloodLevel()

template<typename TScalar, unsigned int TImageDimension>
virtual void itk::watershed::Relabeler< TScalar, TImageDimension >::SetFloodLevel ( double  _arg)
virtual

Set/Get the percentage of the maximum saliency level to merge to.

◆ SetInputImage()

template<typename TScalar, unsigned int TImageDimension>
void itk::watershed::Relabeler< TScalar, TImageDimension >::SetInputImage ( ImageType img)
inline

Set/Get the input image

Definition at line 98 of file itkWatershedRelabeler.h.

◆ SetInputSegmentTree()

template<typename TScalar, unsigned int TImageDimension>
void itk::watershed::Relabeler< TScalar, TImageDimension >::SetInputSegmentTree ( SegmentTreeType et)
inline

Set/Get the input tree that defines segment merges

Definition at line 124 of file itkWatershedRelabeler.h.

◆ SetOutputImage()

template<typename TScalar, unsigned int TImageDimension>
void itk::watershed::Relabeler< TScalar, TImageDimension >::SetOutputImage ( ImageType img)
inline

Set/Get the output image

Definition at line 111 of file itkWatershedRelabeler.h.

Member Data Documentation

◆ ImageDimension

template<typename TScalar, unsigned int TImageDimension>
constexpr unsigned int itk::watershed::Relabeler< TScalar, TImageDimension >::ImageDimension = TImageDimension
staticconstexpr

Expose the ImageDimension template parameter at run time

Definition at line 81 of file itkWatershedRelabeler.h.

◆ m_FloodLevel

template<typename TScalar, unsigned int TImageDimension>
double itk::watershed::Relabeler< TScalar, TImageDimension >::m_FloodLevel { 0.0 }
protected

Definition at line 162 of file itkWatershedRelabeler.h.


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