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 dimensions has faces of dimension . 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 sets of pairs .

See Also: WatershedSegmenter; WatershedBoundaryResolver

Definition at line 54 of file itkWatershedBoundary.h.

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 = itksys::hash_map< IdentifierType, flat_region_t, itksys::hash< IdentifierType > >

using	FlatHashValueType = typename flat_hash_t::value_type

using	ImageIndexType = typename ImageType::IndexType

using	ImageType = Image< IdentifierType, TDimension >

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

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)

bool	GetValid (const IndexType &idx) const

bool	GetValid (unsigned dimension, unsigned highlow) const

void	SetFace (FacePointer f, const IndexType &idx)

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

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

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


FacePointer	GetFace (unsigned dimension, unsigned highlow)


flat_hash_t *	GetFlatHash (const IndexType &idx)

flat_hash_t *	GetFlatHash (unsigned dimension, unsigned highlow)


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

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

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

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

unsigned long	AddObserver (const EventObject &event, Command *) const

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)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexceptoverride

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 Attributes
static constexpr unsigned int	Dimension = TDimension

Protected Member Functions
	Boundary ()

	Boundary (const Self &)

void	operator= (const Self &)

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

	~Boundary () override=default

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

virtual void	PropagateResetPipeline ()

	~DataObject () override

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

	~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 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 flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()