#include <itkWatershedSegmentTreeGenerator.h>

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::SegmentTree 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.

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

using	EquivalencyTableType = EquivalencyTable

using	OneWayEquivalencyTableType = OneWayEquivalencyTable

using	OneWayEquivalencyTableTypePointer = typename OneWayEquivalencyTableType::Pointer

using	Pointer = SmartPointer< Self >

using	ScalarType = TScalar

using	SegmentTableType = SegmentTable< ScalarType >

using	SegmentTableTypePointer = typename SegmentTableType::Pointer

using	SegmentTreeType = SegmentTree< ScalarType >

using	SegmentTreeTypePointer = typename SegmentTreeType::Pointer

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

Public Member Functions
void	GenerateData () override

virtual double	GetFloodLevel () const

EquivalencyTableType *	GetInputEquivalencyTable ()

SegmentTableType *	GetInputSegmentTable ()

SegmentTreeType *	GetOutputSegmentTree ()

DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx) override

void	SetFloodLevel (double)

void	SetInputEquivalencyTable (EquivalencyTableType *eq)

void	SetInputSegmentTable (SegmentTableType *st)


virtual void	SetMerge (bool _arg)

virtual bool	GetMerge () const


virtual void	SetHighestCalculatedFloodLevel (double _arg)

virtual double	GetHighestCalculatedFloodLevel () const


virtual void	SetConsumeInput (bool _arg)

virtual bool	GetConsumeInput () 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 ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

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

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

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

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

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static void	MergeSegments (SegmentTableTypePointer, OneWayEquivalencyTableTypePointer, const IdentifierType, const IdentifierType)

static void	PruneMergeSegments (SegmentTableTypePointer, OneWayEquivalencyTableTypePointer, const IdentifierType, const IdentifierType, ScalarType)

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 ()

Protected Member Functions
void	CompileMergeList (SegmentTableTypePointer, SegmentTreeTypePointer)

void	ExtractMergeHierarchy (SegmentTableTypePointer, SegmentTreeTypePointer)

void	GenerateInputRequestedRegion () override

void	GenerateOutputRequestedRegion (DataObject *output) override

void	MergeEquivalencies ()

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

	SegmentTreeGenerator ()

	~SegmentTreeGenerator () override=default

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

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

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

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

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

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () const

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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

	LightObject ()

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

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

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

virtual	~LightObject ()

Private Types
using	HashMapType = std::unordered_map< IdentifierType, bool >

Private Attributes
bool	m_ConsumeInput { false }

double	m_FloodLevel { 0.0 }

double	m_HighestCalculatedFloodLevel { 0.0 }

bool	m_Merge { false }

OneWayEquivalencyTableType::Pointer	m_MergedSegmentsTable {}

static Pointer	New ()

const char *	GetNameOfClass () const override

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

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

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

bool	m_Updating {}

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

Member Typedef Documentation

◆ ConstPointer

template<typename TScalar >

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

Definition at line 87 of file itkWatershedSegmentTreeGenerator.h.

◆ DataObjectPointer

template<typename TScalar >

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

Definition at line 100 of file itkWatershedSegmentTreeGenerator.h.

◆ DataObjectPointerArraySizeType

template<typename TScalar >

using itk::watershed::SegmentTreeGenerator< TScalar >::DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

Standard itk::ProcessObject subclass method.

Definition at line 201 of file itkWatershedSegmentTreeGenerator.h.

◆ EquivalencyTableType

template<typename TScalar >

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

Definition at line 98 of file itkWatershedSegmentTreeGenerator.h.

◆ HashMapType

template<typename TScalar >

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

private

Definition at line 236 of file itkWatershedSegmentTreeGenerator.h.

◆ OneWayEquivalencyTableType

template<typename TScalar >

using itk::watershed::SegmentTreeGenerator< TScalar >::OneWayEquivalencyTableType = OneWayEquivalencyTable

Definition at line 99 of file itkWatershedSegmentTreeGenerator.h.

◆ OneWayEquivalencyTableTypePointer

template<typename TScalar >

using itk::watershed::SegmentTreeGenerator< TScalar >::OneWayEquivalencyTableTypePointer = typename OneWayEquivalencyTableType::Pointer

Definition at line 104 of file itkWatershedSegmentTreeGenerator.h.

◆ Pointer

template<typename TScalar >

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

Definition at line 86 of file itkWatershedSegmentTreeGenerator.h.

◆ ScalarType

template<typename TScalar >

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

Convenient type definitions

Definition at line 95 of file itkWatershedSegmentTreeGenerator.h.

◆ SegmentTableType

template<typename TScalar >

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

Definition at line 96 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 103 of file itkWatershedSegmentTreeGenerator.h.

◆ SegmentTreeType

template<typename TScalar >

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

Definition at line 97 of file itkWatershedSegmentTreeGenerator.h.

◆ SegmentTreeTypePointer

template<typename TScalar >

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

Definition at line 105 of file itkWatershedSegmentTreeGenerator.h.

◆ Self

template<typename TScalar >

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

Standard itk smart pointer declarations

Definition at line 84 of file itkWatershedSegmentTreeGenerator.h.

◆ Superclass

template<typename TScalar >

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

Definition at line 85 of file itkWatershedSegmentTreeGenerator.h.

Constructor & Destructor Documentation

◆ SegmentTreeGenerator()

template<typename TScalar >

itk::watershed::SegmentTreeGenerator< TScalar >::SegmentTreeGenerator ( )

protected

◆ ~SegmentTreeGenerator()

template<typename TScalar >

itk::watershed::SegmentTreeGenerator< TScalar >::~SegmentTreeGenerator ( )

overrideprotecteddefault

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.

◆ 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

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 >

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

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.

◆ GetFloodLevel()

template<typename TScalar >

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

virtual

◆ GetHighestCalculatedFloodLevel()

template<typename TScalar >

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

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.

◆ GetInputEquivalencyTable()

template<typename TScalar >

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

inline

Definition at line 136 of file itkWatershedSegmentTreeGenerator.h.

References itk::ProcessObject::GetInput().

◆ GetInputSegmentTable()

template<typename TScalar >

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

inline

Get/Set the input table of segments to process

Definition at line 109 of file itkWatershedSegmentTreeGenerator.h.

References itk::ProcessObject::GetInput().

◆ GetMerge()

template<typename TScalar >

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

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

◆ GetNameOfClass()

template<typename TScalar >

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

overridevirtual

Method for creation through the object factory.

Reimplemented from itk::ProcessObject.

◆ GetOutputSegmentTree()

template<typename TScalar >

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

inline

Get/Set the output data

Definition at line 143 of file itkWatershedSegmentTreeGenerator.h.

References itk::ProcessObject::GetOutput().

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

◆ MakeOutput()

template<typename TScalar >

DataObjectPointer itk::watershed::SegmentTreeGenerator< TScalar >::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.

◆ MergeEquivalencies()

template<typename TScalar >

void itk::watershed::SegmentTreeGenerator< TScalar >::MergeEquivalencies ( )

protected

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

◆ PrintSelf()

template<typename TScalar >

void itk::watershed::SegmentTreeGenerator< TScalar >::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.

◆ 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 130 of file itkWatershedSegmentTreeGenerator.h.

References itk::ProcessObject::SetNthInput().

◆ SetInputSegmentTable()

template<typename TScalar >

void itk::watershed::SegmentTreeGenerator< TScalar >::SetInputSegmentTable ( SegmentTableType * st )

inline

Definition at line 115 of file itkWatershedSegmentTreeGenerator.h.

References itk::ProcessObject::SetNthInput().

◆ 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

Definition at line 234 of file itkWatershedSegmentTreeGenerator.h.

◆ m_FloodLevel

template<typename TScalar >

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

private

Definition at line 233 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 244 of file itkWatershedSegmentTreeGenerator.h.

◆ m_Merge

template<typename TScalar >

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

private

Definition at line 232 of file itkWatershedSegmentTreeGenerator.h.

◆ m_MergedSegmentsTable

template<typename TScalar >

OneWayEquivalencyTableType::Pointer itk::watershed::SegmentTreeGenerator< TScalar >::m_MergedSegmentsTable {}

private

Definition at line 238 of file itkWatershedSegmentTreeGenerator.h.

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

itkWatershedSegmentTreeGenerator.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ DataObjectPointer

◆ DataObjectPointerArraySizeType

◆ EquivalencyTableType

◆ HashMapType

◆ OneWayEquivalencyTableType

◆ OneWayEquivalencyTableTypePointer

◆ Pointer

◆ ScalarType

◆ SegmentTableType

◆ SegmentTableTypePointer

◆ SegmentTreeType

◆ SegmentTreeTypePointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ SegmentTreeGenerator()

◆ ~SegmentTreeGenerator()

Member Function Documentation

◆ CompileMergeList()

◆ ExtractMergeHierarchy()

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GenerateOutputRequestedRegion()

◆ GetConsumeInput()

◆ GetFloodLevel()

◆ GetHighestCalculatedFloodLevel()

◆ GetInputEquivalencyTable()

◆ GetInputSegmentTable()

◆ GetMerge()

◆ GetNameOfClass()

◆ GetOutputSegmentTree()

◆ MakeOutput()

◆ MergeEquivalencies()

◆ MergeSegments()

◆ New()

◆ PrintSelf()

◆ PruneMergeSegments()

◆ SetConsumeInput()

◆ SetFloodLevel()

◆ SetHighestCalculatedFloodLevel()

◆ SetInputEquivalencyTable()

◆ SetInputSegmentTable()

◆ SetMerge()

Member Data Documentation

◆ m_ConsumeInput

◆ m_FloodLevel

◆ m_HighestCalculatedFloodLevel

◆ m_Merge

◆ m_MergedSegmentsTable