ITK  4.9.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
itk::watershed::Boundary< TScalar, TDimension > Class Template Reference
Watershed-based Segmentation Filters | Module ITKWatersheds

#include <itkWatershedBoundary.h>

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

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 54 of file itkWatershedBoundary.h.

Classes

struct  face_pixel_t
 
struct  flat_region_t
 

Public Types

typedef Image< face_pixel_t,
TDimension > 		face_t
 
typedef face_t::Pointer FacePointer
 
typedef itksys::hash_map
< IdentifierType,
flat_region_t, itksys::hash
< IdentifierType > > 		flat_hash_t
 
typedef flat_hash_t::value_type FlatHashValueType
 
typedef ImageType::IndexType ImageIndexType
 
typedef Image< IdentifierType,
TDimension > 		ImageType
 
typedef std::pair< unsigned,
unsigned > 		IndexType
 
typedef TScalar ScalarType
 
- Public Types inherited from itk::DataObject
typedef SmartPointer< const Self > ConstPointer
 
typedef std::string DataObjectIdentifierType
 
typedef std::vector< Pointer >
::size_type 		DataObjectPointerArraySizeType
 
typedef SmartPointer< Self > Pointer
 
typedef DataObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef LightObject Self
 

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
 
SmartPointerForwardReference
< 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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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 const unsigned int Dimension = TDimension
 

Protected Member Functions

 Boundary ()
 
 Boundary (const Self &)
 
void operator= (const Self &)
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~Boundary ()
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
 ~DataObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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
AtomicInt< int > m_ReferenceCount
 
typedef Boundary Self
 
typedef DataObject Superclass
 
typedef SmartPointer< Self > Pointer
 
typedef SmartPointer< const Self > ConstPointer
 
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 ()
 

Member Typedef Documentation

template<typename TScalar , unsigned int TDimension>
typedef SmartPointer< const Self > itk::watershed::Boundary< TScalar, TDimension >::ConstPointer

Itk typedefs and macros defining smart pointer and type identification.

Definition at line 129 of file itkWatershedBoundary.h.

template<typename TScalar , unsigned int TDimension>
typedef Image< face_pixel_t, TDimension > itk::watershed::Boundary< TScalar, TDimension >::face_t

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

Definition at line 117 of file itkWatershedBoundary.h.

template<typename TScalar , unsigned int TDimension>
typedef face_t::Pointer itk::watershed::Boundary< TScalar, TDimension >::FacePointer

The following averts an internal compiler error on microsoft compilers

Definition at line 131 of file itkWatershedBoundary.h.

template<typename TScalar , unsigned int TDimension>
typedef itksys::hash_map< IdentifierType, flat_region_t, itksys::hash< IdentifierType > > itk::watershed::Boundary< TScalar, TDimension >::flat_hash_t

A hash table holding flat region data structures.

Definition at line 121 of file itkWatershedBoundary.h.

template<typename TScalar , unsigned int TDimension>
typedef flat_hash_t::value_type itk::watershed::Boundary< TScalar, TDimension >::FlatHashValueType

Definition at line 122 of file itkWatershedBoundary.h.

template<typename TScalar , unsigned int TDimension>
typedef ImageType::IndexType itk::watershed::Boundary< TScalar, TDimension >::ImageIndexType

Definition at line 69 of file itkWatershedBoundary.h.

template<typename TScalar , unsigned int TDimension>
typedef Image< IdentifierType, TDimension > itk::watershed::Boundary< TScalar, TDimension >::ImageType

Definition at line 68 of file itkWatershedBoundary.h.

template<typename TScalar , unsigned int TDimension>
typedef std::pair< unsigned, unsigned > itk::watershed::Boundary< TScalar, TDimension >::IndexType

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.

template<typename TScalar , unsigned int TDimension>
typedef SmartPointer< Self > itk::watershed::Boundary< TScalar, TDimension >::Pointer

Itk typedefs and macros defining smart pointer and type identification.

Definition at line 128 of file itkWatershedBoundary.h.

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

Definition at line 70 of file itkWatershedBoundary.h.

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

Itk typedefs and macros defining smart pointer and type identification.

Definition at line 126 of file itkWatershedBoundary.h.

template<typename TScalar , unsigned int TDimension>
typedef DataObject itk::watershed::Boundary< TScalar, TDimension >::Superclass

Itk typedefs and macros defining smart pointer and type identification.

Definition at line 127 of file itkWatershedBoundary.h.

Constructor & Destructor Documentation

template<typename TScalar , unsigned int TDimension>
itk::watershed::Boundary< TScalar, TDimension >::Boundary ( )
protected
template<typename TScalar , unsigned int TDimension>
virtual itk::watershed::Boundary< TScalar, TDimension >::~Boundary ( )
inlineprotectedvirtual

Definition at line 206 of file itkWatershedBoundary.h.

template<typename TScalar , unsigned int TDimension>
itk::watershed::Boundary< TScalar, TDimension >::Boundary ( const Self &  )
inlineprotected

Definition at line 207 of file itkWatershedBoundary.h.

Member Function Documentation

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

Itk typedefs and macros defining smart pointer and type identification.

Reimplemented from itk::Object.

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 138 of file itkWatershedBoundary.h.

template<typename TScalar , unsigned int TDimension>
FacePointer itk::watershed::Boundary< TScalar, TDimension >::GetFace ( unsigned  dimension,
unsigned  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 144 of file itkWatershedBoundary.h.

References itk::watershed::Boundary< TScalar, TDimension >::m_Faces.

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 162 of file itkWatershedBoundary.h.

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

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

Definition at line 164 of file itkWatershedBoundary.h.

References itk::watershed::Boundary< TScalar, TDimension >::m_FlatHashes.

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

Itk typedefs and macros defining smart pointer and type identification.

Reimplemented from itk::DataObject.

template<typename TScalar , unsigned int TDimension>
bool itk::watershed::Boundary< TScalar, TDimension >::GetValid ( const IndexType &  idx) const
inline

Definition at line 196 of file itkWatershedBoundary.h.

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

Definition at line 198 of file itkWatershedBoundary.h.

References itk::watershed::Boundary< TScalar, TDimension >::m_Valid.

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

Itk typedefs and macros defining smart pointer and type identification.

template<typename TScalar , unsigned int TDimension>
void itk::watershed::Boundary< TScalar, TDimension >::operator= ( const Self &  )
inlineprotected

Definition at line 208 of file itkWatershedBoundary.h.

template<typename TScalar , unsigned int TDimension>
virtual 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::DataObject.

template<typename TScalar , unsigned int TDimension>
void itk::watershed::Boundary< TScalar, TDimension >::SetFace ( FacePointer  f,
const IndexType &  idx 
)
inline

Definition at line 151 of file itkWatershedBoundary.h.

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

Definition at line 154 of file itkWatershedBoundary.h.

References itk::watershed::Boundary< TScalar, TDimension >::m_Faces, and itk::Object::Modified().

template<typename TScalar , unsigned int TDimension>
void itk::watershed::Boundary< TScalar, TDimension >::SetFlatHash ( flat_hash_t &  l,
const IndexType &  idx 
)
inline

Definition at line 171 of file itkWatershedBoundary.h.

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

Definition at line 173 of file itkWatershedBoundary.h.

References itk::watershed::Boundary< TScalar, TDimension >::m_FlatHashes, and itk::Object::Modified().

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 185 of file itkWatershedBoundary.h.

template<typename TScalar , unsigned int TDimension>
void itk::watershed::Boundary< TScalar, TDimension >::SetValid ( bool  b,
unsigned  dimension,
unsigned  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 187 of file itkWatershedBoundary.h.

References itk::watershed::Boundary< TScalar, TDimension >::m_Valid, and itk::Object::Modified().

Member Data Documentation

template<typename TScalar , unsigned int TDimension>
const unsigned int itk::watershed::Boundary< TScalar, TDimension >::Dimension = TDimension
static

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.

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 212 of file itkWatershedBoundary.h.

Referenced by itk::watershed::Boundary< TScalar, TDimension >::GetFace(), and itk::watershed::Boundary< TScalar, TDimension >::SetFace().

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 216 of file itkWatershedBoundary.h.

Referenced by itk::watershed::Boundary< TScalar, TDimension >::GetFlatHash(), and itk::watershed::Boundary< TScalar, TDimension >::SetFlatHash().

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 220 of file itkWatershedBoundary.h.

Referenced by itk::watershed::Boundary< TScalar, TDimension >::GetValid(), and itk::watershed::Boundary< TScalar, TDimension >::SetValid().

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Sat Jan 30 2016 05:28:50 for ITK by   doxygen 1.8.5