ITK  5.2.0
Insight Toolkit
Public Types | List of all members

#include <itkWatershedSegmentTreeGenerator.h>

+ Inheritance diagram for itk::watershed::SegmentTreeGenerator< TScalar >:
+ Collaboration diagram for itk::watershed::SegmentTreeGenerator< TScalar >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = SegmentTreeGenerator
 
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
 
using ScalarType = TScalar
 
using SegmentTableType = SegmentTable< ScalarType >
 
using SegmentTreeType = SegmentTree< ScalarType >
 
using EquivalencyTableType = EquivalencyTable
 
using OneWayEquivalencyTableType = OneWayEquivalencyTable
 
using DataObjectPointer = DataObject::Pointer
 
using SegmentTableTypePointer = typename SegmentTableType::Pointer
 
using OneWayEquivalencyTableTypePointer = typename OneWayEquivalencyTableType::Pointer
 
using SegmentTreeTypePointer = typename SegmentTreeType::Pointer
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 
using HashMapType = std::unordered_map< IdentifierType, bool >
 
bool m_Merge { false }
 
double m_FloodLevel { 0.0 }
 
bool m_ConsumeInput { false }
 
OneWayEquivalencyTableType::Pointer m_MergedSegmentsTable
 
double m_HighestCalculatedFloodLevel { 0.0 }
 
static Pointer New ()
 
static void MergeSegments (SegmentTableTypePointer, OneWayEquivalencyTableTypePointer, const IdentifierType, const IdentifierType)
 
static void PruneMergeSegments (SegmentTableTypePointer, OneWayEquivalencyTableTypePointer, const IdentifierType, const IdentifierType, ScalarType)
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
SegmentTableTypeGetInputSegmentTable ()
 
void SetInputSegmentTable (SegmentTableType *st)
 
void SetInputEquivalencyTable (EquivalencyTableType *eq)
 
EquivalencyTableTypeGetInputEquivalencyTable ()
 
SegmentTreeTypeGetOutputSegmentTree ()
 
void GenerateData () override
 
virtual void SetMerge (bool _arg)
 
virtual bool GetMerge () const
 
void SetFloodLevel (double)
 
virtual double GetFloodLevel () const
 
virtual void SetHighestCalculatedFloodLevel (double _arg)
 
virtual double GetHighestCalculatedFloodLevel () const
 
virtual void SetConsumeInput (bool _arg)
 
virtual bool GetConsumeInput () const
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
 SegmentTreeGenerator ()
 
 ~SegmentTreeGenerator () override=default
 
 SegmentTreeGenerator (const Self &)
 
void operator= (const Self &)
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void CompileMergeList (SegmentTableTypePointer, SegmentTreeTypePointer)
 
void ExtractMergeHierarchy (SegmentTableTypePointer, SegmentTreeTypePointer)
 
void MergeEquivalencies ()
 
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>
class itk::watershed::SegmentTreeGenerator< TScalar >

This filter is a process object class that implements a step in the N-d watershed segmentation algorithm. It produces an ordered list (SegmentTree) of binary merges between segments at increasing saliency levels. This filter is used in conjunction with WatershedSegmenter and WatershedRelabeler to process an initial segmentation into a final relabeled volume. See itk::WatershedImageFilter for an overview of watershed segmentation.

Inputs
There are two inputs to this filter, the second is optional. (1) A table of segments (SegmentTable) derived from a labeled image. (2) Optionally, a table of predetermined equivalencies among segments (EquivalencyTable), necessary for streaming applications where segments may be joined across streamed chunk boundaries. The flag Merge must be set to true to enable this functionality.
Outputs
The output of this filter is a list of binary merges of segments at increasing saliency. This is the data structure itk::watershed::WatershedSegmentTree referred to as a "merge tree" in the itk::WatershedImageFilter documentation.
Parameters
There are two parameters to this filter described below.
FloodLevel is specified as a percentage (0.0 - 1.0) of the maximum possible saliency value in the initial image from which the segment table was derived. A value of 0.0 calculates no merges. A value of 1.0 calculates all of the potential merges that can occur as the FloodLevel is increased to the maximum saliency value. Typically, there is no need to calculate merges past about 40% of the total depth. Because this is the most computationally intensive piece of the watershed segmentation algorithm, it is a good idea to tune this parameter as low as possible on larger volumes.
Merge is a boolean flag indicating whether or not to pre-merge the segments marked as equivalent in the EquivalencyTable. This is only useful for streaming applications and is turned off by default. (TRUE == merge, FALSE == do not merge).
See also
itk::WatershedImageFilter

Definition at line 78 of file itkWatershedSegmentTreeGenerator.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TScalar>
using itk::watershed::SegmentTreeGenerator< TScalar >::ConstPointer = SmartPointer<const Self>

Definition at line 86 of file itkWatershedSegmentTreeGenerator.h.

◆ DataObjectPointer

template<typename TScalar>
using itk::watershed::SegmentTreeGenerator< TScalar >::DataObjectPointer = DataObject::Pointer

Convenient type definitions

Definition at line 99 of file itkWatershedSegmentTreeGenerator.h.

◆ DataObjectPointerArraySizeType

Standard itk::ProcessObject subclass method.

Definition at line 200 of file itkWatershedSegmentTreeGenerator.h.

◆ EquivalencyTableType

template<typename TScalar>
using itk::watershed::SegmentTreeGenerator< TScalar >::EquivalencyTableType = EquivalencyTable

Convenient type definitions

Definition at line 97 of file itkWatershedSegmentTreeGenerator.h.

◆ HashMapType

template<typename TScalar>
using itk::watershed::SegmentTreeGenerator< TScalar >::HashMapType = std::unordered_map<IdentifierType, bool>
private

Convenient type definitions

Definition at line 238 of file itkWatershedSegmentTreeGenerator.h.

◆ OneWayEquivalencyTableType

Convenient type definitions

Definition at line 98 of file itkWatershedSegmentTreeGenerator.h.

◆ OneWayEquivalencyTableTypePointer

Convenient type definitions

Definition at line 103 of file itkWatershedSegmentTreeGenerator.h.

◆ Pointer

template<typename TScalar>
using itk::watershed::SegmentTreeGenerator< TScalar >::Pointer = SmartPointer<Self>

Definition at line 85 of file itkWatershedSegmentTreeGenerator.h.

◆ ScalarType

template<typename TScalar>
using itk::watershed::SegmentTreeGenerator< TScalar >::ScalarType = TScalar

Convenient type definitions

Definition at line 94 of file itkWatershedSegmentTreeGenerator.h.

◆ SegmentTableType

template<typename TScalar>
using itk::watershed::SegmentTreeGenerator< TScalar >::SegmentTableType = SegmentTable<ScalarType>

Convenient type definitions

Definition at line 95 of file itkWatershedSegmentTreeGenerator.h.

◆ SegmentTableTypePointer

template<typename TScalar>
using itk::watershed::SegmentTreeGenerator< TScalar >::SegmentTableTypePointer = typename SegmentTableType::Pointer

Typedefs to avoid internal compiler error bug on Microsoft VC++

Definition at line 102 of file itkWatershedSegmentTreeGenerator.h.

◆ SegmentTreeType

template<typename TScalar>
using itk::watershed::SegmentTreeGenerator< TScalar >::SegmentTreeType = SegmentTree<ScalarType>

Convenient type definitions

Definition at line 96 of file itkWatershedSegmentTreeGenerator.h.

◆ SegmentTreeTypePointer

template<typename TScalar>
using itk::watershed::SegmentTreeGenerator< TScalar >::SegmentTreeTypePointer = typename SegmentTreeType::Pointer

Convenient type definitions

Definition at line 104 of file itkWatershedSegmentTreeGenerator.h.

◆ Self

template<typename TScalar>
using itk::watershed::SegmentTreeGenerator< TScalar >::Self = SegmentTreeGenerator

Standard itk smart pointer declarations

Definition at line 83 of file itkWatershedSegmentTreeGenerator.h.

◆ Superclass

template<typename TScalar>
using itk::watershed::SegmentTreeGenerator< TScalar >::Superclass = ProcessObject

Definition at line 84 of file itkWatershedSegmentTreeGenerator.h.

Constructor & Destructor Documentation

◆ SegmentTreeGenerator() [1/2]

template<typename TScalar>
itk::watershed::SegmentTreeGenerator< TScalar >::SegmentTreeGenerator ( )
protected

Convenient type definitions

◆ ~SegmentTreeGenerator()

template<typename TScalar>
itk::watershed::SegmentTreeGenerator< TScalar >::~SegmentTreeGenerator ( )
overrideprotecteddefault

Convenient type definitions

◆ SegmentTreeGenerator() [2/2]

template<typename TScalar>
itk::watershed::SegmentTreeGenerator< TScalar >::SegmentTreeGenerator ( const Self )
inlineprotected

Convenient type definitions

Definition at line 208 of file itkWatershedSegmentTreeGenerator.h.

Member Function Documentation

◆ CompileMergeList()

template<typename TScalar>
void itk::watershed::SegmentTreeGenerator< TScalar >::CompileMergeList ( SegmentTableTypePointer  ,
SegmentTreeTypePointer   
)
protected

Generates an initial list of all potential merges in the segment table.

◆ CreateAnother()

template<typename TScalar>
virtual::itk::LightObject::Pointer itk::watershed::SegmentTreeGenerator< TScalar >::CreateAnother ( ) const
virtual

Convenient type definitions

Reimplemented from itk::Object.

◆ ExtractMergeHierarchy()

template<typename TScalar>
void itk::watershed::SegmentTreeGenerator< TScalar >::ExtractMergeHierarchy ( SegmentTableTypePointer  ,
SegmentTreeTypePointer   
)
protected

Compiles a list of all the actual segment merges up to the specified flood level, recomputing new potential merges as it goes.

◆ GenerateData()

template<typename TScalar>
void itk::watershed::SegmentTreeGenerator< TScalar >::GenerateData ( )
overridevirtual

Standard non-threaded itk pipeline method

Reimplemented from itk::ProcessObject.

◆ GenerateInputRequestedRegion()

template<typename TScalar>
void itk::watershed::SegmentTreeGenerator< TScalar >::GenerateInputRequestedRegion ( )
overrideprotectedvirtual

Convenient type definitions

Reimplemented from itk::ProcessObject.

◆ GenerateOutputRequestedRegion()

template<typename TScalar>
void itk::watershed::SegmentTreeGenerator< TScalar >::GenerateOutputRequestedRegion ( DataObject output)
overrideprotectedvirtual

Methods required by the itk pipeline

Reimplemented from itk::ProcessObject.

◆ GetConsumeInput()

template<typename TScalar>
virtual bool itk::watershed::SegmentTreeGenerator< TScalar >::GetConsumeInput ( ) const
virtual

Convenient type definitions

◆ GetFloodLevel()

template<typename TScalar>
virtual double itk::watershed::SegmentTreeGenerator< TScalar >::GetFloodLevel ( ) const
virtual

Convenient type definitions

◆ GetHighestCalculatedFloodLevel()

template<typename TScalar>
virtual double itk::watershed::SegmentTreeGenerator< TScalar >::GetHighestCalculatedFloodLevel ( ) const
virtual

Convenient type definitions

◆ GetInputEquivalencyTable()

template<typename TScalar>
EquivalencyTableType* itk::watershed::SegmentTreeGenerator< TScalar >::GetInputEquivalencyTable ( )
inline

Convenient type definitions

Definition at line 135 of file itkWatershedSegmentTreeGenerator.h.

◆ GetInputSegmentTable()

template<typename TScalar>
SegmentTableType* itk::watershed::SegmentTreeGenerator< TScalar >::GetInputSegmentTable ( )
inline

Get/Set the input table of segments to process

Definition at line 108 of file itkWatershedSegmentTreeGenerator.h.

◆ GetMerge()

template<typename TScalar>
virtual bool itk::watershed::SegmentTreeGenerator< TScalar >::GetMerge ( ) const
virtual

Convenient type definitions

◆ GetNameOfClass()

template<typename TScalar>
virtual const char* itk::watershed::SegmentTreeGenerator< TScalar >::GetNameOfClass ( ) const
virtual

Convenient type definitions

Reimplemented from itk::ProcessObject.

◆ GetOutputSegmentTree()

template<typename TScalar>
SegmentTreeType* itk::watershed::SegmentTreeGenerator< TScalar >::GetOutputSegmentTree ( )
inline

Get/Set the output data

Definition at line 142 of file itkWatershedSegmentTreeGenerator.h.

Referenced by itk::WatershedImageFilter< TInputImage >::GetSegmentTree().

◆ MakeOutput()

template<typename TScalar>
DataObjectPointer itk::watershed::SegmentTreeGenerator< TScalar >::MakeOutput ( DataObjectPointerArraySizeType  idx)
overridevirtual

Convenient type definitions

Reimplemented from itk::ProcessObject.

◆ MergeEquivalencies()

template<typename TScalar>
void itk::watershed::SegmentTreeGenerator< TScalar >::MergeEquivalencies ( )
protected

Convenient type definitions

◆ MergeSegments()

template<typename TScalar>
static void itk::watershed::SegmentTreeGenerator< TScalar >::MergeSegments ( SegmentTableTypePointer  ,
OneWayEquivalencyTableTypePointer  ,
const  IdentifierType,
const  IdentifierType 
)
static

Performs a merge of two segments in a SegmentTable according to criteria specific to this algorithm.

◆ New()

template<typename TScalar>
static Pointer itk::watershed::SegmentTreeGenerator< TScalar >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<typename TScalar>
void itk::watershed::SegmentTreeGenerator< TScalar >::operator= ( const Self )
inlineprotected

Convenient type definitions

Definition at line 210 of file itkWatershedSegmentTreeGenerator.h.

◆ PrintSelf()

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

Convenient type definitions

Reimplemented from itk::ProcessObject.

◆ PruneMergeSegments()

template<typename TScalar>
static void itk::watershed::SegmentTreeGenerator< TScalar >::PruneMergeSegments ( SegmentTableTypePointer  ,
OneWayEquivalencyTableTypePointer  ,
const  IdentifierType,
const  IdentifierType,
ScalarType   
)
static

This method should not be used. It will be removed in future versions of this filter.

◆ SetConsumeInput()

template<typename TScalar>
virtual void itk::watershed::SegmentTreeGenerator< TScalar >::SetConsumeInput ( bool  _arg)
virtual

Get/Set a flag that prevents the filter from copying its input segment table before executing. This can be enabled to conserve memory, especially in streaming applications where memory is a concern. If enabled, the input to this filter must always be re-executed on updates. Default is false.

◆ SetFloodLevel()

template<typename TScalar>
void itk::watershed::SegmentTreeGenerator< TScalar >::SetFloodLevel ( double  )

Get/Set FloodLevel. FloodLevel is specified as a percentage (0.0 - 1.0) of the maximum possible saliency value in the initial image from which the segment table was derived. A value of 0.0 calculates no merges. A value of 1.0 calculates all of the potential merges that can occur as the FloodLevel is increased to the maximum saliency value.

◆ SetHighestCalculatedFloodLevel()

template<typename TScalar>
virtual void itk::watershed::SegmentTreeGenerator< TScalar >::SetHighestCalculatedFloodLevel ( double  _arg)
virtual

Get/Set HighestCalculatedFloodLevel. HighestCalculatedFloodLevel keeps track of the highest level this filter has computed. It is used to prevent unnecessary re-execution of the filter.

◆ SetInputEquivalencyTable()

template<typename TScalar>
void itk::watershed::SegmentTreeGenerator< TScalar >::SetInputEquivalencyTable ( EquivalencyTableType eq)
inline

Get/Set input table of equivalencies to pre-merge before running the tree generator algorithm. Only useful for streaming applications

Definition at line 129 of file itkWatershedSegmentTreeGenerator.h.

◆ SetInputSegmentTable()

template<typename TScalar>
void itk::watershed::SegmentTreeGenerator< TScalar >::SetInputSegmentTable ( SegmentTableType st)
inline

Convenient type definitions

Definition at line 114 of file itkWatershedSegmentTreeGenerator.h.

◆ SetMerge()

template<typename TScalar>
virtual void itk::watershed::SegmentTreeGenerator< TScalar >::SetMerge ( bool  _arg)
virtual

Get/Set a boolean flag indicating whether or not to pre-merge the segments marked as equivalent in the EquivalencyTable. This is only useful for streaming applications and is turned off by default. (TRUE == merge, FALSE == do not merge).

Member Data Documentation

◆ m_ConsumeInput

template<typename TScalar>
bool itk::watershed::SegmentTreeGenerator< TScalar >::m_ConsumeInput { false }
private

Convenient type definitions

Definition at line 236 of file itkWatershedSegmentTreeGenerator.h.

◆ m_FloodLevel

template<typename TScalar>
double itk::watershed::SegmentTreeGenerator< TScalar >::m_FloodLevel { 0.0 }
private

Convenient type definitions

Definition at line 235 of file itkWatershedSegmentTreeGenerator.h.

◆ m_HighestCalculatedFloodLevel

template<typename TScalar>
double itk::watershed::SegmentTreeGenerator< TScalar >::m_HighestCalculatedFloodLevel { 0.0 }
private

This value keeps track of the highest level this filter has been calculated. m_FloodLevel can be manipulated anywhere below this level without re-executing the filter, preventing unnecessary updates.

Definition at line 246 of file itkWatershedSegmentTreeGenerator.h.

◆ m_Merge

template<typename TScalar>
bool itk::watershed::SegmentTreeGenerator< TScalar >::m_Merge { false }
private

Convenient type definitions

Definition at line 234 of file itkWatershedSegmentTreeGenerator.h.

◆ m_MergedSegmentsTable

template<typename TScalar>
OneWayEquivalencyTableType::Pointer itk::watershed::SegmentTreeGenerator< TScalar >::m_MergedSegmentsTable
private

Convenient type definitions

Definition at line 240 of file itkWatershedSegmentTreeGenerator.h.


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