ITK  5.2.0
Insight Toolkit
List of all members

#include <itkWatershedBoundaryResolver.h>

+ Inheritance diagram for itk::watershed::BoundaryResolver< TPixelType, TDimension >:
+ Collaboration diagram for itk::watershed::BoundaryResolver< TPixelType, TDimension >:
using Self = BoundaryResolver
 
using Superclass = ProcessObject
 
using Pointer = SmartPointer< Self >
 
using ConstPointer = SmartPointer< const Self >
 
using PixelType = TPixelType
 
using BoundaryType = Boundary< PixelType, TDimension >
 
using EquivalencyTableType = EquivalencyTable
 
using SegmenterType = Segmenter< Image< TPixelType, TDimension > >
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 
static constexpr unsigned int ImageDimension = TDimension
 
unsigned short m_Face { 0 }
 
static Pointer New ()
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
void SetBoundaryA (BoundaryType *bd)
 
BoundaryType::Pointer GetBoundaryA ()
 
void SetBoundaryB (BoundaryType *bd)
 
BoundaryType::Pointer GetBoundaryB ()
 
virtual void SetFace (unsigned short _arg)
 
virtual unsigned short GetFace () const
 
void SetEquivalencyTable (EquivalencyTableType::Pointer a)
 
EquivalencyTableType::Pointer GetEquivalencyTable ()
 
void GenerateData () override
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
 BoundaryResolver ()
 
 ~BoundaryResolver () override=default
 
 BoundaryResolver (const Self &)
 
void operator= (const Self &)
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void GenerateOutputRequestedRegion (DataObject *output) override
 

Additional Inherited Members

- 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 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 GenerateInputRequestedRegion ()
 
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 TPixelType, unsigned int TDimension>
class itk::watershed::BoundaryResolver< TPixelType, TDimension >

This filter implements a piece of the streaming watershed segmentation algorithm. It takes in pairs of itk::watershed::Boundary objects and connects the labeling of pixels across image chunk boundaries. Read the documentation found in itk::WatershedImageFilter and the other watershed segmentation component objects for more information.

A note on terminology in itk watershed segmentation code
For streamed segmentation of images in the watershed framework, the documentation refers to the complete data set at the "image volume." The image volume is assumed to be partitioned into pieces referred to as image chunks. Each chunk is processed in sequence through the pipeline. The "face" of an image chunk is an N-1 dimensional boundary region of an N dimensional chunk (the planar faces of a cube, for example).
Input
The input to this filter is a pair of itk::watershed::Boundary pointers (BoundaryA and BoundaryB). The algorithm assumes that these Boundaries come from facing chunks in the image volume. The faces that align need to be specified in the parameters of the filter.
Output
This filter outputs a table of equivalencies among labels. See itk::EquivalencyTable for more information.
Parameters
The only parameters to set on this filter are the indices of the faces that align in the boundary object inputs. See itk::Boundary for a description of how boundary faces are indexed.
See also
itk::watershed::Boundary

Definition at line 65 of file itkWatershedBoundaryResolver.h.

Member Typedef Documentation

◆ BoundaryType

template<typename TPixelType , unsigned int TDimension>
using itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryType = Boundary<PixelType, TDimension>

Set up smart pointer and object factory definitions.

Definition at line 82 of file itkWatershedBoundaryResolver.h.

◆ ConstPointer

template<typename TPixelType , unsigned int TDimension>
using itk::watershed::BoundaryResolver< TPixelType, TDimension >::ConstPointer = SmartPointer<const Self>

Set up smart pointer and object factory definitions.

Definition at line 72 of file itkWatershedBoundaryResolver.h.

◆ DataObjectPointer

template<typename TPixelType , unsigned int TDimension>
using itk::watershed::BoundaryResolver< TPixelType, TDimension >::DataObjectPointer = DataObject::Pointer

Set up smart pointer and object factory definitions.

Definition at line 85 of file itkWatershedBoundaryResolver.h.

◆ DataObjectPointerArraySizeType

template<typename TPixelType , unsigned int TDimension>
using itk::watershed::BoundaryResolver< TPixelType, TDimension >::DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

Standard itk::ProcessObject subclass method.

Definition at line 139 of file itkWatershedBoundaryResolver.h.

◆ EquivalencyTableType

template<typename TPixelType , unsigned int TDimension>
using itk::watershed::BoundaryResolver< TPixelType, TDimension >::EquivalencyTableType = EquivalencyTable

Set up smart pointer and object factory definitions.

Definition at line 83 of file itkWatershedBoundaryResolver.h.

◆ PixelType

template<typename TPixelType , unsigned int TDimension>
using itk::watershed::BoundaryResolver< TPixelType, TDimension >::PixelType = TPixelType

Some convenient type alias.

Definition at line 81 of file itkWatershedBoundaryResolver.h.

◆ Pointer

template<typename TPixelType , unsigned int TDimension>
using itk::watershed::BoundaryResolver< TPixelType, TDimension >::Pointer = SmartPointer<Self>

Set up smart pointer and object factory definitions.

Definition at line 71 of file itkWatershedBoundaryResolver.h.

◆ SegmenterType

template<typename TPixelType , unsigned int TDimension>
using itk::watershed::BoundaryResolver< TPixelType, TDimension >::SegmenterType = Segmenter<Image<TPixelType, TDimension> >

Set up smart pointer and object factory definitions.

Definition at line 84 of file itkWatershedBoundaryResolver.h.

◆ Self

template<typename TPixelType , unsigned int TDimension>
using itk::watershed::BoundaryResolver< TPixelType, TDimension >::Self = BoundaryResolver

Set up smart pointer and object factory definitions.

Definition at line 69 of file itkWatershedBoundaryResolver.h.

◆ Superclass

template<typename TPixelType , unsigned int TDimension>
using itk::watershed::BoundaryResolver< TPixelType, TDimension >::Superclass = ProcessObject

Set up smart pointer and object factory definitions.

Definition at line 70 of file itkWatershedBoundaryResolver.h.

Constructor & Destructor Documentation

◆ BoundaryResolver() [1/2]

template<typename TPixelType , unsigned int TDimension>
itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryResolver ( )
inlineprotected

Set up smart pointer and object factory definitions.

Definition at line 145 of file itkWatershedBoundaryResolver.h.

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

◆ ~BoundaryResolver()

template<typename TPixelType , unsigned int TDimension>
itk::watershed::BoundaryResolver< TPixelType, TDimension >::~BoundaryResolver ( )
overrideprotecteddefault

Set up smart pointer and object factory definitions.

◆ BoundaryResolver() [2/2]

template<typename TPixelType , unsigned int TDimension>
itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryResolver ( const Self )
inlineprotected

Set up smart pointer and object factory definitions.

Definition at line 154 of file itkWatershedBoundaryResolver.h.

Member Function Documentation

◆ CreateAnother()

template<typename TPixelType , unsigned int TDimension>
virtual::itk::LightObject::Pointer itk::watershed::BoundaryResolver< TPixelType, TDimension >::CreateAnother ( ) const
virtual

Set up smart pointer and object factory definitions.

Reimplemented from itk::Object.

◆ GenerateData()

template<typename TPixelType , unsigned int TDimension>
void itk::watershed::BoundaryResolver< TPixelType, TDimension >::GenerateData ( )
overridevirtual

Standard non-threaded pipeline method

Reimplemented from itk::ProcessObject.

◆ GenerateOutputRequestedRegion()

template<typename TPixelType , unsigned int TDimension>
void itk::watershed::BoundaryResolver< TPixelType, TDimension >::GenerateOutputRequestedRegion ( DataObject output)
overrideprotectedvirtual

Set up smart pointer and object factory definitions.

Reimplemented from itk::ProcessObject.

◆ GetBoundaryA()

template<typename TPixelType , unsigned int TDimension>
BoundaryType::Pointer itk::watershed::BoundaryResolver< TPixelType, TDimension >::GetBoundaryA ( )
inline

Set up smart pointer and object factory definitions.

Definition at line 94 of file itkWatershedBoundaryResolver.h.

◆ GetBoundaryB()

template<typename TPixelType , unsigned int TDimension>
BoundaryType::Pointer itk::watershed::BoundaryResolver< TPixelType, TDimension >::GetBoundaryB ( )
inline

Set up smart pointer and object factory definitions.

Definition at line 107 of file itkWatershedBoundaryResolver.h.

◆ GetEquivalencyTable()

template<typename TPixelType , unsigned int TDimension>
EquivalencyTableType::Pointer itk::watershed::BoundaryResolver< TPixelType, TDimension >::GetEquivalencyTable ( )
inline

Set up smart pointer and object factory definitions.

Definition at line 128 of file itkWatershedBoundaryResolver.h.

References itk::ProcessObject::GetOutput().

◆ GetFace()

template<typename TPixelType , unsigned int TDimension>
virtual unsigned short itk::watershed::BoundaryResolver< TPixelType, TDimension >::GetFace ( ) const
virtual

Set up smart pointer and object factory definitions.

◆ GetNameOfClass()

template<typename TPixelType , unsigned int TDimension>
virtual const char* itk::watershed::BoundaryResolver< TPixelType, TDimension >::GetNameOfClass ( ) const
virtual

Set up smart pointer and object factory definitions.

Reimplemented from itk::ProcessObject.

◆ MakeOutput()

template<typename TPixelType , unsigned int TDimension>
DataObjectPointer itk::watershed::BoundaryResolver< TPixelType, TDimension >::MakeOutput ( DataObjectPointerArraySizeType  idx)
overridevirtual

Set up smart pointer and object factory definitions.

Reimplemented from itk::ProcessObject.

◆ New()

template<typename TPixelType , unsigned int TDimension>
static Pointer itk::watershed::BoundaryResolver< TPixelType, TDimension >::New ( )
static

Set up smart pointer and object factory definitions.

◆ operator=()

template<typename TPixelType , unsigned int TDimension>
void itk::watershed::BoundaryResolver< TPixelType, TDimension >::operator= ( const Self )
inlineprotected

Set up smart pointer and object factory definitions.

Definition at line 156 of file itkWatershedBoundaryResolver.h.

◆ PrintSelf()

template<typename TPixelType , unsigned int TDimension>
void itk::watershed::BoundaryResolver< TPixelType, TDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Set up smart pointer and object factory definitions.

Reimplemented from itk::ProcessObject.

◆ SetBoundaryA()

template<typename TPixelType , unsigned int TDimension>
void itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryA ( BoundaryType bd)
inline

Set/Get the first of two boundaries that are to be resolved.

Definition at line 89 of file itkWatershedBoundaryResolver.h.

References itk::ProcessObject::SetNthInput().

◆ SetBoundaryB()

template<typename TPixelType , unsigned int TDimension>
void itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryB ( BoundaryType bd)
inline

Set/Get the second of two boundaries that are to be resolved.

Definition at line 102 of file itkWatershedBoundaryResolver.h.

References itk::ProcessObject::SetNthInput().

◆ SetEquivalencyTable()

template<typename TPixelType , unsigned int TDimension>
void itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetEquivalencyTable ( EquivalencyTableType::Pointer  a)
inline

This method sets/gets the equivalency table used to store equivalencies among segments that are generated from the boundary resolution algorithm.

Definition at line 123 of file itkWatershedBoundaryResolver.h.

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

◆ SetFace()

template<typename TPixelType , unsigned int TDimension>
virtual void itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetFace ( unsigned short  _arg)
virtual

Set/Get the face of the boundary object that we are going to resolve.

Member Data Documentation

◆ ImageDimension

template<typename TPixelType , unsigned int TDimension>
constexpr unsigned int itk::watershed::BoundaryResolver< TPixelType, TDimension >::ImageDimension = TDimension
staticconstexpr

Expose the image dimension at run time.

Definition at line 78 of file itkWatershedBoundaryResolver.h.

◆ m_Face

template<typename TPixelType , unsigned int TDimension>
unsigned short itk::watershed::BoundaryResolver< TPixelType, TDimension >::m_Face { 0 }
protected

Set up smart pointer and object factory definitions.

Definition at line 161 of file itkWatershedBoundaryResolver.h.


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