#include <itkWatershedBoundary.h>

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

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

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 itk::hash_map < unsigned long, flat_region_t, itk::hash< unsigned long > >	flat_hash_t
typedef flat_hash_t::value_type	FlatHashValueType
typedef Image< unsigned long, TDimension >::IndexType	ImageIndexType
typedef std::pair< unsigned, unsigned >	IndexType
typedef TScalarType	ScalarType
Public Member Functions
virtual void	CopyInformation (const DataObject *)
virtual LightObject::Pointer	CreateAnother () const
void	DataHasBeenGenerated ()
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
void	DisconnectPipeline ()
Command *	GetCommand (unsigned long tag)
bool	GetDataReleased () const
bool	GetDebug () const
FacePointer	GetFace (const IndexType &idx)
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual int	GetReferenceCount () const
SmartPointerForwardReference < ProcessObject >	GetSource () const
unsigned int	GetSourceOutputIndex () const
virtual unsigned long	GetUpdateMTime () const
virtual void	Graft (const DataObject *)
bool	HasObserver (const EventObject &event) const
virtual void	Initialize ()
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	PrepareForNewData ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	ReleaseData ()
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual void	ResetPipeline ()
void	SetDebug (bool debugFlag) const
void	SetFace (FacePointer f, unsigned dimension, unsigned highlow)
void	SetFace (FacePointer f, const IndexType &idx)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	SetRequestedRegion (DataObject *)
virtual void	SetRequestedRegionToLargestPossibleRegion ()
bool	ShouldIReleaseData () const
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateOutputInformation ()
virtual bool	VerifyRequestedRegion ()


FacePointer	GetFace (unsigned dimension, unsigned highlow)


flat_hash_t *	GetFlatHash (const IndexType &idx)
flat_hash_t *	GetFlatHash (unsigned dimension, unsigned highlow)
void	SetFlatHash (flat_hash_t &l, const IndexType &idx)
void	SetFlatHash (flat_hash_t &l, unsigned dimension, unsigned highlow)


void	SetValid (bool &l, const IndexType &idx)
void	SetValid (bool b, unsigned dimension, unsigned highlow)
bool	GetValid (const IndexType &idx) const
bool	GetValid (unsigned dimension, unsigned highlow) const


void	SetReleaseDataFlag (bool flag)
virtual const bool &	GetReleaseDataFlag ()
virtual void	ReleaseDataFlagOn ()
virtual void	ReleaseDataFlagOff ()


virtual void	PropagateRequestedRegion () throw (InvalidRequestedRegionError)
virtual void	UpdateOutputData ()


void	SetPipelineMTime (unsigned long time)
virtual const unsigned long &	GetPipelineMTime ()


unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
Static Public Member Functions
static void	BreakOnError ()


static void	SetGlobalReleaseDataFlag (bool val)
static bool	GetGlobalReleaseDataFlag ()
static void	GlobalReleaseDataFlagOn ()
static void	GlobalReleaseDataFlagOff ()


static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
Static Public Attributes
static const unsigned int	Dimension = TDimension
Protected Types


typedef int	InternalReferenceCountType
Protected Member Functions
	Boundary ()
	Boundary (const Self &)
void	operator= (const Self &)
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
virtual	~Boundary ()


virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
std::vector< std::pair < FacePointer, FacePointer > >	m_Faces
std::vector< std::pair < flat_hash_t, flat_hash_t > >	m_FlatHashes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
std::vector< std::pair< bool, bool > >	m_Valid

typedef Boundary	Self
typedef DataObject	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
static Pointer	New ()
virtual const char *	GetNameOfClass () const

Detailed Description

template<class TScalarType, unsigned int TDimension>
class itk::watershed::Boundary< TScalarType, 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 56 of file itkWatershedBoundary.h.

Member Typedef Documentation

template<class TScalarType , unsigned int TDimension>

typedef SmartPointer<const Self> itk::watershed::Boundary< TScalarType, TDimension >::ConstPointer

Itk typedefs and macros defining smart pointer and type identification.

Reimplemented from itk::DataObject.

Definition at line 132 of file itkWatershedBoundary.h.

template<class TScalarType , unsigned int TDimension>

typedef Image<face_pixel_t, TDimension> itk::watershed::Boundary< TScalarType, TDimension >::face_t

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

Definition at line 120 of file itkWatershedBoundary.h.

template<class TScalarType , unsigned int TDimension>

typedef face_t::Pointer itk::watershed::Boundary< TScalarType, TDimension >::FacePointer

The following averts an internal compiler error on microsoft compilers

Definition at line 134 of file itkWatershedBoundary.h.

template<class TScalarType , unsigned int TDimension>

typedef itk::hash_map<unsigned long, flat_region_t, itk::hash<unsigned long> > itk::watershed::Boundary< TScalarType, TDimension >::flat_hash_t

A hash table holding flat region data structures.

Definition at line 124 of file itkWatershedBoundary.h.

template<class TScalarType , unsigned int TDimension>

typedef flat_hash_t::value_type itk::watershed::Boundary< TScalarType, TDimension >::FlatHashValueType

Definition at line 125 of file itkWatershedBoundary.h.

template<class TScalarType , unsigned int TDimension>

typedef Image<unsigned long, TDimension>::IndexType itk::watershed::Boundary< TScalarType, TDimension >::ImageIndexType

Definition at line 70 of file itkWatershedBoundary.h.

template<class TScalarType , unsigned int TDimension>

typedef std::pair<unsigned, unsigned> itk::watershed::Boundary< TScalarType, 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 69 of file itkWatershedBoundary.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

template<class TScalarType , unsigned int TDimension>

typedef SmartPointer<Self> itk::watershed::Boundary< TScalarType, TDimension >::Pointer

Itk typedefs and macros defining smart pointer and type identification.

Reimplemented from itk::DataObject.

Definition at line 131 of file itkWatershedBoundary.h.

template<class TScalarType , unsigned int TDimension>

typedef TScalarType itk::watershed::Boundary< TScalarType, TDimension >::ScalarType

Definition at line 71 of file itkWatershedBoundary.h.

template<class TScalarType , unsigned int TDimension>

typedef Boundary itk::watershed::Boundary< TScalarType, TDimension >::Self

Itk typedefs and macros defining smart pointer and type identification.

Reimplemented from itk::DataObject.

Definition at line 129 of file itkWatershedBoundary.h.

template<class TScalarType , unsigned int TDimension>

typedef DataObject itk::watershed::Boundary< TScalarType, TDimension >::Superclass

Itk typedefs and macros defining smart pointer and type identification.

Reimplemented from itk::DataObject.

Definition at line 130 of file itkWatershedBoundary.h.

Constructor & Destructor Documentation

template<class TScalarType , unsigned int TDimension>

itk::watershed::Boundary< TScalarType, TDimension >::Boundary ( ) [protected]

template<class TScalarType , unsigned int TDimension>

virtual itk::watershed::Boundary< TScalarType, TDimension >::~Boundary ( ) [inline, protected, virtual]

Definition at line 208 of file itkWatershedBoundary.h.

template<class TScalarType , unsigned int TDimension>

itk::watershed::Boundary< TScalarType, TDimension >::Boundary ( const Self & ) [inline, protected]

Definition at line 209 of file itkWatershedBoundary.h.

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual void itk::DataObject::CopyInformation ( const DataObject * ) [inline, virtual, inherited]

Copy information from the specified data set. This method is part of the pipeline execution model. By default, a ProcessObject will copy meta-data from the first input to all of its outputs. See ProcessObject::GenerateOutputInformation(). Each subclass of DataObject is responsible for being able to copy whatever meta-data it needs from from another DataObject. The default implementation of this method is empty. If a subclass overrides this method, it should always call its superclass' version.

Definition at line 439 of file itkDataObject.h.

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

void itk::DataObject::DataHasBeenGenerated ( ) [inherited]

Inform the pipeline mechanism that data has been generated. This method is called by ProcessObject::UpdateOutputData() once the process object has finished generating its data. This essentially marks the DataObject as being updated and ready for use.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

void itk::DataObject::DisconnectPipeline ( ) [inherited]

Separate this data object from the pipeline. This routine disconnects a data object from the upstream pipeline. Hence an Update() from downstream will not propagate back past this data object. To completely isolate this data object from the pipeline, the application must remove this data object from any filters which it is connected as the input.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::DataObject::GetDataReleased ( ) const [inline, inherited]

Get the flag indicating the data has been released.

Definition at line 334 of file itkDataObject.h.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

template<class TScalarType , unsigned int TDimension>

FacePointer itk::watershed::Boundary< TScalarType, 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 148 of file itkWatershedBoundary.h.

template<class TScalarType , unsigned int TDimension>

FacePointer itk::watershed::Boundary< TScalarType, TDimension >::GetFace ( const IndexType & idx ) [inline]

Returns the face at the specified index

Definition at line 142 of file itkWatershedBoundary.h.

References itk::watershed::Boundary< TScalarType, TDimension >::GetFace().

Referenced by itk::watershed::Boundary< TScalarType, TDimension >::GetFace().

template<class TScalarType , unsigned int TDimension>

flat_hash_t* itk::watershed::Boundary< TScalarType, TDimension >::GetFlatHash	(	unsigned	dimension,
		unsigned	highlow
	)			`[inline]`

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

Definition at line 168 of file itkWatershedBoundary.h.

template<class TScalarType , unsigned int TDimension>

flat_hash_t* itk::watershed::Boundary< TScalarType, TDimension >::GetFlatHash ( const IndexType & idx ) [inline]

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

Definition at line 166 of file itkWatershedBoundary.h.

References itk::watershed::Boundary< TScalarType, TDimension >::GetFlatHash().

Referenced by itk::watershed::Boundary< TScalarType, TDimension >::GetFlatHash().

static bool itk::DataObject::GetGlobalReleaseDataFlag ( ) [static, inherited]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

template<class TScalarType , unsigned int TDimension>

virtual const char* itk::watershed::Boundary< TScalarType, TDimension >::GetNameOfClass ( ) const [virtual]

Itk typedefs and macros defining smart pointer and type identification.

Reimplemented from itk::DataObject.

virtual const unsigned long& itk::DataObject::GetPipelineMTime ( ) [virtual, inherited]

The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object.

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

virtual const bool& itk::DataObject::GetReleaseDataFlag ( ) [virtual, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

SmartPointerForwardReference<ProcessObject> itk::DataObject::GetSource ( ) const [inherited]

Get the process object that generated this data object. If there is no process object, then the data object has been disconnected from the pipeline, or the data object was created manually. (Note: we cannot use the GetObjectMacro() defined in itkMacro because the mutual dependency of DataObject and ProcessObject causes compile problems. Also, a forward reference smart pointer is returned, not a smart pointer, because of the circular dependency between the process and data object.)

GetSource() returns a SmartPointerForwardReference and not a WeakPointer because it is assumed the code calling GetSource() wants to hold a long term reference to the source.

unsigned int itk::DataObject::GetSourceOutputIndex ( ) const [inherited]

Which of the source's outputs corresponds to this data object?

virtual unsigned long itk::DataObject::GetUpdateMTime ( ) const [virtual, inherited]

MTime for the last time this DataObject was generated.

template<class TScalarType , unsigned int TDimension>

bool itk::watershed::Boundary< TScalarType, 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 197 of file itkWatershedBoundary.h.

References itk::watershed::Boundary< TScalarType, TDimension >::GetValid().

Referenced by itk::watershed::Boundary< TScalarType, TDimension >::GetValid().

template<class TScalarType , unsigned int TDimension>

bool itk::watershed::Boundary< TScalarType, TDimension >::GetValid	(	unsigned	dimension,
		unsigned	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 199 of file itkWatershedBoundary.h.

static void itk::DataObject::GlobalReleaseDataFlagOff ( ) [inline, static, inherited]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

Definition at line 319 of file itkDataObject.h.

static void itk::DataObject::GlobalReleaseDataFlagOn ( ) [inline, static, inherited]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

Definition at line 317 of file itkDataObject.h.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

virtual void itk::DataObject::Graft ( const DataObject * ) [inline, virtual, inherited]

Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.

Definition at line 453 of file itkDataObject.h.

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

virtual void itk::DataObject::Initialize ( ) [virtual, inherited]

Restore the data object to its initial state. This means releasing memory.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TScalarType , unsigned int TDimension>

static Pointer itk::watershed::Boundary< TScalarType, TDimension >::New ( ) [static]

Itk typedefs and macros defining smart pointer and type identification.

Reimplemented from itk::Object.

template<class TScalarType , unsigned int TDimension>

void itk::watershed::Boundary< TScalarType, TDimension >::operator= ( const Self & ) [inline, protected]

Definition at line 210 of file itkWatershedBoundary.h.

virtual void itk::DataObject::PrepareForNewData ( ) [inline, virtual, inherited]

Setup a DataObject to receive new data. This method is called by the pipeline mechanism on each output of filter that needs to execute. The default implementation is to return a DataObject to its initial state. This may involve releasing previously allocated bulk data. Subclasses of DataObject may want to override this method and/or the Initialize() method if they want a different default behavior (for instance a DataObject might want finer control over its bulk data memory management).

Definition at line 389 of file itkDataObject.h.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

template<class TScalarType , unsigned int TDimension>

void itk::watershed::Boundary< TScalarType, TDimension >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual]`

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.

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

virtual void itk::DataObject::PropagateRequestedRegion ( ) throw (InvalidRequestedRegionError) [virtual, inherited]

Methods to update the pipeline. Called internally by the pipeline mechanism.

virtual void itk::DataObject::PropagateResetPipeline ( ) [protected, virtual, inherited]

Propagate a call to ResetPipeline(). Called only from ProcessObject.

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

void itk::DataObject::ReleaseData ( ) [inherited]

Release data back to system to conserve memory resource. Used during pipeline execution. Releasing this data does not make down-stream data invalid, so it does not modify the MTime of this data object.

virtual void itk::DataObject::ReleaseDataFlagOff ( ) [virtual, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

virtual void itk::DataObject::ReleaseDataFlagOn ( ) [virtual, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

virtual bool itk::DataObject::RequestedRegionIsOutsideOfTheBufferedRegion ( ) [inline, virtual, inherited]

Determine whether the RequestedRegion is outside of the BufferedRegion. This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute

Reimplemented in itk::ImageBase< VImageDimension >, itk::PointSet< TPixelType, VDimension, TMeshTraits >, itk::QuadEdgeMesh< TPixel, VDimension, TTraits >, itk::SpatialObject< TDimension >, itk::ImageBase< ::itk::GetImageDimension< TLabelObject >::ImageDimension >, itk::ImageBase< ::itk::GetImageDimension< VectorImage< TPixelType, Dimension > >::ImageDimension >, itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >, itk::PointSet< TPixel, VDimension, TTraits >, itk::PointSet< TCoordType, VDimension, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >, itk::SpatialObject< 3 >, and itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >.

Definition at line 413 of file itkDataObject.h.

virtual void itk::DataObject::ResetPipeline ( ) [virtual, inherited]

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

template<class TScalarType , unsigned int TDimension>

void itk::watershed::Boundary< TScalarType, TDimension >::SetFace	(	FacePointer	f,
		const IndexType &	idx
	)			`[inline]`

Definition at line 155 of file itkWatershedBoundary.h.

References itk::watershed::Boundary< TScalarType, TDimension >::SetFace().

Referenced by itk::watershed::Boundary< TScalarType, TDimension >::SetFace().

template<class TScalarType , unsigned int TDimension>

void itk::watershed::Boundary< TScalarType, TDimension >::SetFace	(	FacePointer	f,
		unsigned	dimension,
		unsigned	highlow
	)			`[inline]`

Definition at line 158 of file itkWatershedBoundary.h.

template<class TScalarType , unsigned int TDimension>

void itk::watershed::Boundary< TScalarType, 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 173 of file itkWatershedBoundary.h.

References itk::watershed::Boundary< TScalarType, TDimension >::SetFlatHash().

Referenced by itk::watershed::Boundary< TScalarType, TDimension >::SetFlatHash().

template<class TScalarType , unsigned int TDimension>

void itk::watershed::Boundary< TScalarType, TDimension >::SetFlatHash	(	flat_hash_t &	l,
		unsigned	dimension,
		unsigned	highlow
	)			`[inline]`

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

Definition at line 175 of file itkWatershedBoundary.h.

static void itk::DataObject::SetGlobalReleaseDataFlag ( bool val ) [static, inherited]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

void itk::DataObject::SetPipelineMTime ( unsigned long time ) [inline, inherited]

The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object.

Definition at line 373 of file itkDataObject.h.

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

void itk::DataObject::SetReleaseDataFlag ( bool flag ) [inline, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

Definition at line 304 of file itkDataObject.h.

virtual void itk::DataObject::SetRequestedRegion ( DataObject * ) [inline, virtual, inherited]

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. For DataObject's that do not support Regions, this method does nothing. Subclasses of DataObject that do support Regions, provide an alternative implementation.

Definition at line 446 of file itkDataObject.h.

virtual void itk::DataObject::SetRequestedRegionToLargestPossibleRegion ( ) [inline, virtual, inherited]

Set the RequestedRegion to the LargestPossibleRegion. This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update().

Definition at line 402 of file itkDataObject.h.

template<class TScalarType , unsigned int TDimension>

void itk::watershed::Boundary< TScalarType, 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 188 of file itkWatershedBoundary.h.

References itk::watershed::Boundary< TScalarType, TDimension >::SetValid().

Referenced by itk::watershed::Boundary< TScalarType, TDimension >::SetValid().

template<class TScalarType , unsigned int TDimension>

void itk::watershed::Boundary< TScalarType, 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 190 of file itkWatershedBoundary.h.

bool itk::DataObject::ShouldIReleaseData ( ) const [inherited]

Return flag indicating whether data should be released after use by a filter.

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

virtual void itk::DataObject::Update ( ) [virtual, inherited]

Provides opportunity for the data object to insure internal consistency before access. Also causes owning source/filter (if any) to update itself. The Update() method is composed of UpdateOutputInformation(), PropagateRequestedRegion(), and UpdateOutputData(). This method may call methods that throw an InvalidRequestedRegionError exception. This exception will leave the pipeline in an inconsistent state. You will need to call ResetPipeline() on the last ProcessObject in your pipeline in order to restore the pipeline to a state where you can call Update() again.

virtual void itk::DataObject::UpdateOutputData ( ) [virtual, inherited]

Methods to update the pipeline. Called internally by the pipeline mechanism.

virtual void itk::DataObject::UpdateOutputInformation ( ) [virtual, inherited]

Update the information for this DataObject so that it can be used as an output of a ProcessObject. This method is used in the pipeline mechanism to propagate information and initialize the meta data associated with a DataObject. Any implementation of this method in a derived class is assumed to call its source's ProcessObject::UpdateOutputInformation() which determines modified times, LargestPossibleRegions, and any extra meta data like spacing, origin, etc. Default implementation simply call's it's source's UpdateOutputInformation().

virtual bool itk::DataObject::VerifyRequestedRegion ( ) [inline, virtual, inherited]

Verify that the RequestedRegion is within the LargestPossibleRegion.

If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possibly satisfy the request. This method returns true if the request can be satisfied (even if it will be necessary to process the entire LargestPossibleRegion) and returns false otherwise. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception if the requested region is not within the LargestPossibleRegion. Default implementation simply returns true in order to support DataObjects that do not need regions (for instance itk::EquivalencyTable).

Definition at line 428 of file itkDataObject.h.

Member Data Documentation

template<class TScalarType , unsigned int TDimension>

const unsigned int itk::watershed::Boundary< TScalarType, 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 63 of file itkWatershedBoundary.h.

template<class TScalarType , unsigned int TDimension>

std::vector<std::pair<FacePointer, FacePointer> > itk::watershed::Boundary< TScalarType, TDimension >::m_Faces [protected]

The Nx2 matrix of faces of this boundary.

Definition at line 214 of file itkWatershedBoundary.h.

template<class TScalarType , unsigned int TDimension>

std::vector<std::pair<flat_hash_t, flat_hash_t> > itk::watershed::Boundary< TScalarType, TDimension >::m_FlatHashes [protected]

The Nx2 matrix flat region connections associated with this boundary.

Definition at line 218 of file itkWatershedBoundary.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

template<class TScalarType , unsigned int TDimension>

std::vector<std::pair<bool,bool> > itk::watershed::Boundary< TScalarType, TDimension >::m_Valid [protected]

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

Definition at line 222 of file itkWatershedBoundary.h.

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

itkWatershedBoundary.h

itk::watershed::Boundary< TScalarType, TDimension > Class Template Reference [Watershed-based Segmentation Filters]

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

itk::watershed::Boundary< TScalarType, TDimension > Class Template Reference
[Watershed-based Segmentation Filters]

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