itk::SparseFieldLayer< TNodeType > Class Template Reference

#include <itkSparseFieldLayer.h>

Inheritance diagram for itk::SparseFieldLayer< TNodeType >:

Collaboration diagram for itk::SparseFieldLayer< TNodeType >:

Detailed Description

template<typename TNodeType>
class itk::SparseFieldLayer< TNodeType >

A very simple linked list that is used to manage nodes in a layer of a sparse field level-set solver.

This class implements a very simple linked list that is used to manage nodes in a layer of a sparse field level-set solver. For more information on the sparse field level-set solver, see documentation for itk::SparseFieldLevelSetImageFilter.

IMPORTANT!

One important and distinctive feature of this list implementation (in fact, the entire reason for this object's existence) is that no memory allocation/deallocation occurs during linking or unlinking of nodes. The nodes themselves are expected to carry the appropriate "Next" & "Previous" fields used to link. Guaranteeing that no calls to new or delete are ever made for normal list operations allows us to safely use this class in a multithread environment without incurring penalties from heap contention among threads. Because no allocation/deallocation occurs, it is entirely up to the calling program to manage the allocating and freeing of the list nodes.

Definition at line 152 of file itkSparseFieldLayer.h.

Classes
struct	RegionType

Public Types
typedef ConstSparseFieldLayerIterator < NodeType >	ConstIterator
typedef SmartPointer< const Self >	ConstPointer
typedef SparseFieldLayerIterator < NodeType >	Iterator
typedef TNodeType	NodeType
typedef SmartPointer< Self >	Pointer
typedef std::vector< RegionType >	RegionListType
typedef SparseFieldLayer	Self
typedef Object	Superclass
typedef NodeType	ValueType
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
Iterator	Begin ()
ConstIterator	Begin () const
virtual ::itk::LightObject::Pointer	CreateAnother () const
Iterator	End ()
ConstIterator	End () const
NodeType *	Front ()
const NodeType *	Front () const
virtual const char *	GetNameOfClass () const
void	PopFront ()
void	PushFront (NodeType *n)
unsigned int	Size () const
RegionListType	SplitRegions (int num) const
void	Unlink (NodeType *n)
bool	Empty () 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 Member Functions
static Pointer	New ()
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 ()

Protected Member Functions
virtual void	PrintSelf (std::ostream &os, Indent indent) const override
	SparseFieldLayer ()
	~SparseFieldLayer ()
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 ()

Private Member Functions
void	operator= (const Self &)
	SparseFieldLayer (const Self &)

Private Attributes
NodeType *	m_HeadNode
unsigned int	m_Size

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TNodeType >

typedef ConstSparseFieldLayerIterator< NodeType > itk::SparseFieldLayer< TNodeType >::ConstIterator

Const iterator type for the list.

Definition at line 179 of file itkSparseFieldLayer.h.

template<typename TNodeType >

typedef SmartPointer< const Self > itk::SparseFieldLayer< TNodeType >::ConstPointer

Definition at line 160 of file itkSparseFieldLayer.h.

template<typename TNodeType >

typedef SparseFieldLayerIterator< NodeType > itk::SparseFieldLayer< TNodeType >::Iterator

Iterator type for the list.

Definition at line 176 of file itkSparseFieldLayer.h.

template<typename TNodeType >

typedef TNodeType itk::SparseFieldLayer< TNodeType >::NodeType

Type of node stored in the linked list.

Definition at line 166 of file itkSparseFieldLayer.h.

template<typename TNodeType >

typedef SmartPointer< Self > itk::SparseFieldLayer< TNodeType >::Pointer

Definition at line 159 of file itkSparseFieldLayer.h.

template<typename TNodeType >

typedef std::vector< RegionType > itk::SparseFieldLayer< TNodeType >::RegionListType

Definition at line 187 of file itkSparseFieldLayer.h.

template<typename TNodeType >

typedef SparseFieldLayer itk::SparseFieldLayer< TNodeType >::Self

Standard typedefs.

Definition at line 157 of file itkSparseFieldLayer.h.

template<typename TNodeType >

typedef Object itk::SparseFieldLayer< TNodeType >::Superclass

Definition at line 158 of file itkSparseFieldLayer.h.

template<typename TNodeType >

typedef NodeType itk::SparseFieldLayer< TNodeType >::ValueType

Alias for the type of value stored in the list. Conforms to Standard Template Library vocabulary.

Definition at line 173 of file itkSparseFieldLayer.h.

Constructor & Destructor Documentation

template<typename TNodeType >

itk::SparseFieldLayer< TNodeType >::SparseFieldLayer ( )

protected

template<typename TNodeType >

itk::SparseFieldLayer< TNodeType >::~SparseFieldLayer ( )

protected

template<typename TNodeType >

itk::SparseFieldLayer< TNodeType >::SparseFieldLayer ( const Self &  )

private

Member Function Documentation

template<typename TNodeType >

Iterator itk::SparseFieldLayer< TNodeType >::Begin ( )

inline

Returns an iterator pointing to the first node in the list.

Definition at line 225 of file itkSparseFieldLayer.h.

References itk::SparseFieldLayer< TNodeType >::m_HeadNode.

template<typename TNodeType >

ConstIterator itk::SparseFieldLayer< TNodeType >::Begin ( ) const

inline

Returns a const iterator pointing to the first node in the list.

Definition at line 230 of file itkSparseFieldLayer.h.

References itk::SparseFieldLayer< TNodeType >::m_HeadNode.

template<typename TNodeType >

virtual::itk::LightObject::Pointer itk::SparseFieldLayer< TNodeType >::CreateAnother ( ) const

virtual

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

template<typename TNodeType >

bool itk::SparseFieldLayer< TNodeType >::Empty ( ) const

inline

Returns TRUE if the list is empty, FALSE otherwise. Executes in constant time.

Definition at line 243 of file itkSparseFieldLayer.h.

References itk::SparseFieldLayer< TNodeType >::m_HeadNode.

template<typename TNodeType >

Iterator itk::SparseFieldLayer< TNodeType >::End ( )

inline

Returns an iterator pointing one node past the end of the list.

Definition at line 234 of file itkSparseFieldLayer.h.

References itk::SparseFieldLayer< TNodeType >::m_HeadNode.

template<typename TNodeType >

ConstIterator itk::SparseFieldLayer< TNodeType >::End ( ) const

inline

Returns a const iterator pointing one node past the end of the list.

Definition at line 238 of file itkSparseFieldLayer.h.

References itk::SparseFieldLayer< TNodeType >::m_HeadNode.

template<typename TNodeType >

NodeType* itk::SparseFieldLayer< TNodeType >::Front ( )

inline

Returns a pointer to the first node in the list. Constant time.

Definition at line 191 of file itkSparseFieldLayer.h.

References itk::SparseFieldLayer< TNodeType >::m_HeadNode.

template<typename TNodeType >

const NodeType* itk::SparseFieldLayer< TNodeType >::Front ( ) const

inline

Returns a const pointer to the first node in the list. Constant time.

Definition at line 195 of file itkSparseFieldLayer.h.

References itk::SparseFieldLayer< TNodeType >::m_HeadNode.

template<typename TNodeType >

virtual const char* itk::SparseFieldLayer< TNodeType >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

template<typename TNodeType >

static Pointer itk::SparseFieldLayer< TNodeType >::New ( )

static

Method for creation through the object factory.

template<typename TNodeType >

void itk::SparseFieldLayer< TNodeType >::operator= ( const Self &  )

private

template<typename TNodeType >

void itk::SparseFieldLayer< TNodeType >::PopFront ( )

inline

Unlinks the first node from the list. Constant time.

Definition at line 199 of file itkSparseFieldLayer.h.

References itk::SparseFieldLayer< TNodeType >::m_HeadNode, and itk::SparseFieldLayer< TNodeType >::m_Size.

template<typename TNodeType >

virtual void itk::SparseFieldLayer< TNodeType >::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::Object.

template<typename TNodeType >

void itk::SparseFieldLayer< TNodeType >::PushFront ( NodeType *  n )

inline

Links a node into the front of the list. Constant time.

Definition at line 207 of file itkSparseFieldLayer.h.

References itk::SparseFieldLayer< TNodeType >::m_HeadNode, and itk::SparseFieldLayer< TNodeType >::m_Size.

template<typename TNodeType >

unsigned int itk::SparseFieldLayer< TNodeType >::Size

(

)

const

Returns the number of elements in the list. Size() executes in constant time.

template<typename TNodeType >

RegionListType itk::SparseFieldLayer< TNodeType >::SplitRegions

(

int

num

)

const

Returns pointers to first and last+1 elements of num partitions of the itkSparseFieldLayer

template<typename TNodeType >

void itk::SparseFieldLayer< TNodeType >::Unlink ( NodeType *  n )

inline

Unlinks a node from the list

Definition at line 217 of file itkSparseFieldLayer.h.

References itk::SparseFieldLayer< TNodeType >::m_Size.

Member Data Documentation

template<typename TNodeType >

NodeType* itk::SparseFieldLayer< TNodeType >::m_HeadNode

private

The anchor node of the list. m_HeadNode->Next is the first node in the list. If m_HeadNode->Next == m_HeadNode, then the list is empty.

Definition at line 269 of file itkSparseFieldLayer.h.

Referenced by itk::SparseFieldLayer< TNodeType >::Begin(), itk::SparseFieldLayer< TNodeType >::Empty(), itk::SparseFieldLayer< TNodeType >::End(), itk::SparseFieldLayer< TNodeType >::Front(), itk::SparseFieldLayer< TNodeType >::PopFront(), and itk::SparseFieldLayer< TNodeType >::PushFront().

template<typename TNodeType >

unsigned int itk::SparseFieldLayer< TNodeType >::m_Size

private

Definition at line 270 of file itkSparseFieldLayer.h.

Referenced by itk::SparseFieldLayer< TNodeType >::PopFront(), itk::SparseFieldLayer< TNodeType >::PushFront(), and itk::SparseFieldLayer< TNodeType >::Unlink().

---

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

• itkSparseFieldLayer.h