#include <itkWatershedBoundary.h>

Detailed Description

template<typename TScalar, unsigned int TDimension>
class itk::watershed::Boundary< TScalar, TDimension >

: A data object for used by watershed segmentation process objects in streaming applications. A "boundary" represents the single-pixel wide surface of an image chunk. This class is used to store information needed to resolve processing at chunk boundaries after data streaming of the watershed segmentation algorithm.

: This is an itkDataObject. It contains a matrix of "faces" of an N-dimensional hypercube. A chunk of a volume with \( N \) dimensions has \( 2N \) faces of dimension \( N-1 \). Some examples: A 2-dimensional image has 4 faces that are lines. A 3-dimensional image has 6 faces that are planes. A 4-dimensional image has 8 faces which are cubes. Faces are indexed as \( N \) sets of pairs \( (low, high) \).

See also: WatershedSegmenter; WatershedBoundaryResolver

Definition at line 52 of file itkWatershedBoundary.h.

Inheritance diagram for itk::watershed::Boundary< TScalar, TDimension >:

Collaboration diagram for itk::watershed::Boundary< TScalar, TDimension >:

Classes
struct	face_pixel_t

struct	flat_region_t

Public Types
using	face_t = Image<face_pixel_t, TDimension>

using	FacePointer = typename face_t::Pointer

using	flat_hash_t = std::unordered_map<IdentifierType, flat_region_t>

using	FlatHashValueType = typename flat_hash_t::value_type

using	ImageIndexType = typename ImageType::IndexType

using	ImageType = Image<IdentifierType, TDimension>

using	IndexType = std::pair<unsigned int, unsigned int>

using	ScalarType = TScalar

Public Types inherited from itk::DataObject
using	ConstPointer = SmartPointer<const Self>

using	DataObjectIdentifierType = std::string

using	DataObjectPointerArraySizeType = std::vector<Pointer>::size_type

using	Pointer = SmartPointer<Self>

using	Self = DataObject

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
FacePointer	GetFace (const IndexType &idx)

FacePointer	GetFace (unsigned int dimension, unsigned int highlow)

void	SetFace (FacePointer f, const IndexType &idx)

void	SetFace (FacePointer f, unsigned int dimension, unsigned int highlow)


flat_hash_t *	GetFlatHash (const IndexType &idx)

flat_hash_t *	GetFlatHash (unsigned int dimension, unsigned int highlow)

void	SetFlatHash (flat_hash_t &l, const IndexType &idx)

void	SetFlatHash (flat_hash_t &l, unsigned int dimension, unsigned int highlow)


void	SetValid (bool &l, const IndexType &idx)

void	SetValid (bool b, unsigned int dimension, unsigned int highlow)

bool	GetValid (const IndexType &idx) const

bool	GetValid (unsigned int dimension, unsigned int highlow) const

Public Member Functions inherited from itk::DataObject
virtual void	CopyInformation (const DataObject *)

virtual void	DataHasBeenGenerated ()

void	DisconnectPipeline ()

bool	GetDataReleased () const

virtual const bool &	GetReleaseDataFlag () const

SmartPointer< ProcessObject >	GetSource () const

DataObjectPointerArraySizeType	GetSourceOutputIndex () const

const DataObjectIdentifierType &	GetSourceOutputName () const

virtual ModifiedTimeType	GetUpdateMTime () const

virtual void	Graft (const DataObject *)

virtual void	Initialize ()

virtual void	PrepareForNewData ()

virtual void	PropagateRequestedRegion ()

void	ReleaseData ()

virtual void	ReleaseDataFlagOff ()

virtual void	ReleaseDataFlagOn ()

virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()

virtual void	ResetPipeline ()

void	SetReleaseDataFlag (bool flag)

virtual void	SetRequestedRegion (const DataObject *)

virtual void	SetRequestedRegionToLargestPossibleRegion ()

bool	ShouldIReleaseData () const

virtual void	Update ()

virtual void	UpdateOutputData ()

virtual void	UpdateOutputInformation ()

void	UpdateSource () const

virtual bool	VerifyRequestedRegion ()

void	SetPipelineMTime (ModifiedTimeType time)

virtual const ModifiedTimeType &	GetPipelineMTime () const

virtual void	SetRealTimeStamp (RealTimeStamp _arg)

virtual const RealTimeStamp &	GetRealTimeStamp () 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

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

virtual int	GetReferenceCount () const

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

Static Public Attributes
static constexpr unsigned int	Dimension = TDimension

Protected Member Functions
	Boundary ()

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

	~Boundary () override=default

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

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

virtual void	PropagateResetPipeline ()

	~DataObject () override

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	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Attributes
std::vector< std::pair< FacePointer, FacePointer > >	m_Faces {}

std::vector< std::pair< flat_hash_t, flat_hash_t > >	m_FlatHashes {}

std::vector< std::pair< bool, bool > >	m_Valid {}

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

using	Self = Boundary

using	Superclass = DataObject

using	Pointer = SmartPointer<Self>

using	ConstPointer = SmartPointer<const Self>

static Pointer	New ()

virtual::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

Additional Inherited Members
Static Public Member Functions inherited from itk::DataObject
static bool	GetGlobalReleaseDataFlag ()

static void	GlobalReleaseDataFlagOff ()

static void	GlobalReleaseDataFlagOn ()

static Pointer	New ()

static void	SetGlobalReleaseDataFlag (bool val)

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

Member Typedef Documentation

◆ ConstPointer

template<typename TScalar, unsigned int TDimension>

using itk::watershed::Boundary< TScalar, TDimension >::ConstPointer = SmartPointer<const Self>

Itk type alias and macros defining smart pointer and type identification.

Definition at line 131 of file itkWatershedBoundary.h.

◆ face_t

template<typename TScalar, unsigned int TDimension>

using itk::watershed::Boundary< TScalar, TDimension >::face_t = Image<face_pixel_t, TDimension>

The face data structure. This is just an Image of face pixel types.

Definition at line 119 of file itkWatershedBoundary.h.

◆ FacePointer

template<typename TScalar, unsigned int TDimension>

using itk::watershed::Boundary< TScalar, TDimension >::FacePointer = typename face_t::Pointer

The following averts an internal compiler error on microsoft compilers

Definition at line 136 of file itkWatershedBoundary.h.

◆ flat_hash_t

template<typename TScalar, unsigned int TDimension>

using itk::watershed::Boundary< TScalar, TDimension >::flat_hash_t = std::unordered_map<IdentifierType, flat_region_t>

A hash table holding flat region data structures.

Definition at line 122 of file itkWatershedBoundary.h.

◆ FlatHashValueType

template<typename TScalar, unsigned int TDimension>

using itk::watershed::Boundary< TScalar, TDimension >::FlatHashValueType = typename flat_hash_t::value_type

Definition at line 123 of file itkWatershedBoundary.h.

◆ ImageIndexType

template<typename TScalar, unsigned int TDimension>

using itk::watershed::Boundary< TScalar, TDimension >::ImageIndexType = typename ImageType::IndexType

Definition at line 69 of file itkWatershedBoundary.h.

◆ ImageType

template<typename TScalar, unsigned int TDimension>

using itk::watershed::Boundary< TScalar, TDimension >::ImageType = Image<IdentifierType, TDimension>

Definition at line 68 of file itkWatershedBoundary.h.

◆ IndexType

template<typename TScalar, unsigned int TDimension>

using itk::watershed::Boundary< TScalar, TDimension >::IndexType = std::pair<unsigned int, unsigned int>

A pair of values used to index into the boundary data structure. The IndexType.first is the dimension of the face and IndexType.second is a binary value 0 or 1 indicating the LOW face or the HIGH face, respectively.

Definition at line 67 of file itkWatershedBoundary.h.

◆ Pointer

template<typename TScalar, unsigned int TDimension>

using itk::watershed::Boundary< TScalar, TDimension >::Pointer = SmartPointer<Self>

Itk type alias and macros defining smart pointer and type identification.

Definition at line 130 of file itkWatershedBoundary.h.

◆ ScalarType

template<typename TScalar, unsigned int TDimension>

using itk::watershed::Boundary< TScalar, TDimension >::ScalarType = TScalar

Definition at line 70 of file itkWatershedBoundary.h.

◆ Self

template<typename TScalar, unsigned int TDimension>

using itk::watershed::Boundary< TScalar, TDimension >::Self = Boundary

Itk type alias and macros defining smart pointer and type identification.

Definition at line 128 of file itkWatershedBoundary.h.

◆ Superclass

template<typename TScalar, unsigned int TDimension>

using itk::watershed::Boundary< TScalar, TDimension >::Superclass = DataObject

Itk type alias and macros defining smart pointer and type identification.

Definition at line 129 of file itkWatershedBoundary.h.

Constructor & Destructor Documentation

◆ Boundary()

template<typename TScalar, unsigned int TDimension>

itk::watershed::Boundary< TScalar, TDimension >::Boundary ( )

protected

◆ ~Boundary()

template<typename TScalar, unsigned int TDimension>

itk::watershed::Boundary< TScalar, TDimension >::~Boundary ( )

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TScalar, unsigned int TDimension>

virtual::itk::LightObject::Pointer itk::watershed::Boundary< TScalar, TDimension >::CreateAnother ( ) const

virtual

Itk type alias and macros defining smart pointer and type identification.

Reimplemented from itk::LightObject.

◆ GetFace() [1/2]

template<typename TScalar, unsigned int TDimension>

FacePointer itk::watershed::Boundary< TScalar, TDimension >::GetFace ( const IndexType & idx )

inline

Returns the face at the specified index

Definition at line 140 of file itkWatershedBoundary.h.

◆ GetFace() [2/2]

template<typename TScalar, unsigned int TDimension>

FacePointer itk::watershed::Boundary< TScalar, TDimension >::GetFace	(	unsigned int	dimension,
		unsigned int	highlow )

inline

Returns the face at the specified index, where dimension is the number of the axial dimension and highlow is 0 for the LOW face and 1 for the HIGH face.

Definition at line 149 of file itkWatershedBoundary.h.

◆ GetFlatHash() [1/2]

template<typename TScalar, unsigned int TDimension>

flat_hash_t * itk::watershed::Boundary< TScalar, TDimension >::GetFlatHash ( const IndexType & idx )

inline

Get/Set the table of flat region connections specified by the index.

Definition at line 182 of file itkWatershedBoundary.h.

◆ GetFlatHash() [2/2]

template<typename TScalar, unsigned int TDimension>

flat_hash_t * itk::watershed::Boundary< TScalar, TDimension >::GetFlatHash	(	unsigned int	dimension,
		unsigned int	highlow )

inline

Get/Set the table of flat region connections specified by the index.

Definition at line 187 of file itkWatershedBoundary.h.

◆ GetNameOfClass()

template<typename TScalar, unsigned int TDimension>

virtual const char * itk::watershed::Boundary< TScalar, TDimension >::GetNameOfClass ( ) const

virtual

Itk type alias and macros defining smart pointer and type identification.

Reimplemented from itk::DataObject.

◆ GetValid() [1/2]

template<typename TScalar, unsigned int TDimension>

bool itk::watershed::Boundary< TScalar, TDimension >::GetValid ( const IndexType & idx ) const

inline

Marks a face in the boundary object as either valid (true) or invalid (false). A valid face is assumed to be initialized and contain information. No assumptions are made about an invalid face.

Definition at line 242 of file itkWatershedBoundary.h.

◆ GetValid() [2/2]

template<typename TScalar, unsigned int TDimension>

bool itk::watershed::Boundary< TScalar, TDimension >::GetValid	(	unsigned int	dimension,
		unsigned int	highlow ) const

inline

Marks a face in the boundary object as either valid (true) or invalid (false). A valid face is assumed to be initialized and contain information. No assumptions are made about an invalid face.

Definition at line 247 of file itkWatershedBoundary.h.

◆ New()

template<typename TScalar, unsigned int TDimension>

static Pointer itk::watershed::Boundary< TScalar, TDimension >::New ( )

static

Itk type alias and macros defining smart pointer and type identification.

◆ PrintSelf()

template<typename TScalar, unsigned int TDimension>

void itk::watershed::Boundary< TScalar, TDimension >::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::LightObject.

◆ SetFace() [1/2]

template<typename TScalar, unsigned int TDimension>

void itk::watershed::Boundary< TScalar, TDimension >::SetFace	(	FacePointer	f,
		const IndexType &	idx )

inline

Definition at line 160 of file itkWatershedBoundary.h.

◆ SetFace() [2/2]

template<typename TScalar, unsigned int TDimension>

void itk::watershed::Boundary< TScalar, TDimension >::SetFace	(	FacePointer	f,
		unsigned int	dimension,
		unsigned int	highlow )

inline

Definition at line 166 of file itkWatershedBoundary.h.

◆ SetFlatHash() [1/2]

template<typename TScalar, unsigned int TDimension>

void itk::watershed::Boundary< TScalar, TDimension >::SetFlatHash	(	flat_hash_t &	l,
		const IndexType &	idx )

inline

Get/Set the table of flat region connections specified by the index.

Definition at line 198 of file itkWatershedBoundary.h.

◆ SetFlatHash() [2/2]

template<typename TScalar, unsigned int TDimension>

void itk::watershed::Boundary< TScalar, TDimension >::SetFlatHash	(	flat_hash_t &	l,
		unsigned int	dimension,
		unsigned int	highlow )

inline

Get/Set the table of flat region connections specified by the index.

Definition at line 203 of file itkWatershedBoundary.h.

◆ SetValid() [1/2]

template<typename TScalar, unsigned int TDimension>

void itk::watershed::Boundary< TScalar, TDimension >::SetValid	(	bool &	l,
		const IndexType &	idx )

inline

Marks a face in the boundary object as either valid (true) or invalid (false). A valid face is assumed to be initialized and contain information. No assumptions are made about an invalid face.

Definition at line 223 of file itkWatershedBoundary.h.

◆ SetValid() [2/2]

template<typename TScalar, unsigned int TDimension>

void itk::watershed::Boundary< TScalar, TDimension >::SetValid	(	bool	b,
		unsigned int	dimension,
		unsigned int	highlow )

inline

Marks a face in the boundary object as either valid (true) or invalid (false). A valid face is assumed to be initialized and contain information. No assumptions are made about an invalid face.

Definition at line 228 of file itkWatershedBoundary.h.

Member Data Documentation

◆ Dimension

template<typename TScalar, unsigned int TDimension>

unsigned int itk::watershed::Boundary< TScalar, TDimension >::Dimension = TDimension

staticconstexpr

The dimensionality of this boundary. For example, if the boundary of a set of planes, it has dimensionality 2. If the boundary is a set of lines, it has dimensionality 1. Dimensionality is one less than the image chunks from which the boundary is derived.

Definition at line 61 of file itkWatershedBoundary.h.

◆ m_Faces

template<typename TScalar, unsigned int TDimension>

std::vector<std::pair<FacePointer, FacePointer> > itk::watershed::Boundary< TScalar, TDimension >::m_Faces {}

protected

The Nx2 matrix of faces of this boundary.

Definition at line 266 of file itkWatershedBoundary.h.

◆ m_FlatHashes

template<typename TScalar, unsigned int TDimension>

std::vector<std::pair<flat_hash_t, flat_hash_t> > itk::watershed::Boundary< TScalar, TDimension >::m_FlatHashes {}

protected

The Nx2 matrix flat region connections associated with this boundary.

Definition at line 270 of file itkWatershedBoundary.h.

◆ m_Valid

template<typename TScalar, unsigned int TDimension>

std::vector<std::pair<bool, bool> > itk::watershed::Boundary< TScalar, TDimension >::m_Valid {}

protected

The Nx2 matrix of boolean flags indicating which faces contain information.

Definition at line 274 of file itkWatershedBoundary.h.

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

itkWatershedBoundary.h

Detailed Description

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ face_t

◆ FacePointer

◆ flat_hash_t

◆ FlatHashValueType

◆ ImageIndexType

◆ ImageType

◆ IndexType

◆ Pointer

◆ ScalarType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ Boundary()

◆ ~Boundary()

Member Function Documentation

◆ CreateAnother()

◆ GetFace() [1/2]

◆ GetFace() [2/2]

◆ GetFlatHash() [1/2]

◆ GetFlatHash() [2/2]

◆ GetNameOfClass()

◆ GetValid() [1/2]

◆ GetValid() [2/2]

◆ New()

◆ PrintSelf()

◆ SetFace() [1/2]

◆ SetFace() [2/2]

◆ SetFlatHash() [1/2]

◆ SetFlatHash() [2/2]

◆ SetValid() [1/2]

◆ SetValid() [2/2]

Member Data Documentation

◆ Dimension

◆ m_Faces

◆ m_FlatHashes

◆ m_Valid