itk::NarrowBand< NodeType > Class Template Reference

#include <itkNarrowBand.h>

Inheritance diagram for itk::NarrowBand< NodeType >:

[legend]Collaboration diagram for itk::NarrowBand< NodeType >:

[legend]List of all members.

template<class NodeType>
class itk::NarrowBand< NodeType >

Public Types
typedef NodeContainerType::const_iterator	ConstIterator
typedef SmartPointer< const Self >	ConstPointer
typedef NodeContainerType::iterator	Iterator
typedef std::vector< NodeType >	NodeContainerType
typedef SmartPointer< Self >	Pointer
typedef itk::NarrowBand::RegionStruct	RegionType
typedef NarrowBand	Self
typedef NodeContainerType::size_type	SizeType
typedef LightObject	Superclass
Public Member Functions
ConstIterator	Begin () const
Iterator	Begin ()
Clear the narrow band container *void	Clear ()
virtual Pointer	CreateAnother () const
virtual void	Delete ()
bool	Empty () const
ConstIterator	End () const
Iterator	End ()
float	GetInnerRadius ()
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
float	GetTotalRadius ()
const NodeType &	operator[] (SizeType n) const
NodeType &	operator[] (SizeType n)
void	PopBack ()
void	Print (std::ostream &os, Indent indent=0) const
void	PushBack (const NodeType &n)
virtual void	Register () const
void	Reserve (SizeType n)
void	Resize (SizeType n)
void	SetInnerRadius (float val)
virtual void	SetReferenceCount (int)
void	SetTotalRadius (float val)
SizeType	Size () const
std::vector< struct RegionStruct >	SplitBand (unsigned int)
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()
Protected Member Functions
	NarrowBand ()
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
float	m_InnerRadius
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
float	m_TotalRadius
Methods invoked by virtual 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 PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const
Classes
struct	RegionStruct

---

Member Typedef Documentation

template<class NodeType> typedef NodeContainerType::const_iterator itk::NarrowBand< NodeType >::ConstIterator

Definition at line 62 of file itkNarrowBand.h.

template<class NodeType> typedef SmartPointer<const Self> itk::NarrowBand< NodeType >::ConstPointer

Reimplemented from itk::LightObject. Definition at line 52 of file itkNarrowBand.h.

template<class NodeType> typedef NodeContainerType::iterator itk::NarrowBand< NodeType >::Iterator

Definition at line 63 of file itkNarrowBand.h.

template<class NodeType> typedef std::vector<NodeType> itk::NarrowBand< NodeType >::NodeContainerType

Definition at line 58 of file itkNarrowBand.h.

template<class NodeType> typedef SmartPointer<Self> itk::NarrowBand< NodeType >::Pointer

Reimplemented from itk::LightObject. Definition at line 51 of file itkNarrowBand.h.

template<class NodeType> typedef struct itk::NarrowBand::RegionStruct itk::NarrowBand< NodeType >::RegionType

Begin is the first valid iterator position within the region. End is ONE PAST the last valid iterator position in the region.

template<class NodeType> typedef NarrowBand itk::NarrowBand< NodeType >::Self

Standard class typedefs Reimplemented from itk::LightObject. Definition at line 49 of file itkNarrowBand.h.

template<class NodeType> typedef NodeContainerType::size_type itk::NarrowBand< NodeType >::SizeType

Definition at line 61 of file itkNarrowBand.h.

template<class NodeType> typedef LightObject itk::NarrowBand< NodeType >::Superclass

Definition at line 50 of file itkNarrowBand.h.

---

Constructor & Destructor Documentation

template<class NodeType> itk::NarrowBand< NodeType >::NarrowBand (   )  [inline, protected]

Definition at line 156 of file itkNarrowBand.h.

---

Member Function Documentation

template<class NodeType> ConstIterator itk::NarrowBand< NodeType >::Begin (   )  const [inline]

Definition at line 87 of file itkNarrowBand.h.

template<class NodeType> Iterator itk::NarrowBand< NodeType >::Begin (   )  [inline]

Definition at line 83 of file itkNarrowBand.h.

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

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

template<class NodeType> Clear the narrow band container* void itk::NarrowBand< NodeType >::Clear (   )  [inline]

Definition at line 110 of file itkNarrowBand.h.

virtual Pointer itk::LightObject::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 in itk::Object.

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.

template<class NodeType> bool itk::NarrowBand< NodeType >::Empty (   )  const [inline]

Definition at line 104 of file itkNarrowBand.h.

template<class NodeType> ConstIterator itk::NarrowBand< NodeType >::End (   )  const [inline]

Definition at line 95 of file itkNarrowBand.h.

template<class NodeType> Iterator itk::NarrowBand< NodeType >::End (   )  [inline]

Definition at line 91 of file itkNarrowBand.h.

template<class NodeType> float itk::NarrowBand< NodeType >::GetInnerRadius (   )  [inline]

Definition at line 152 of file itkNarrowBand.h.

template<class NodeType> virtual const char* itk::NarrowBand< NodeType >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::LightObject.

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

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

template<class NodeType> float itk::NarrowBand< NodeType >::GetTotalRadius (   )  [inline]

Definition at line 146 of file itkNarrowBand.h.

template<class NodeType> static Pointer itk::NarrowBand< NodeType >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::LightObject.

template<class NodeType> const NodeType& itk::NarrowBand< NodeType >::operator[] (  SizeType  n  )  const [inline]

Definition at line 136 of file itkNarrowBand.h.

template<class NodeType> NodeType& itk::NarrowBand< NodeType >::operator[] (  SizeType  n  )  [inline]

Definition at line 132 of file itkNarrowBand.h.

template<class NodeType> void itk::NarrowBand< NodeType >::PopBack (   )  [inline]

Definition at line 122 of file itkNarrowBand.h.

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

Cause the object to print itself out.

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

template<class NodeType> void itk::NarrowBand< NodeType >::PushBack (  const NodeType &  n  )  [inline]

Definition at line 118 of file itkNarrowBand.h.

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

Increase the reference count (mark as used by another object). Reimplemented in itk::Object.

template<class NodeType> void itk::NarrowBand< NodeType >::Reserve (  SizeType  n  )  [inline]

Definition at line 114 of file itkNarrowBand.h.

template<class NodeType> void itk::NarrowBand< NodeType >::Resize (  SizeType  n  )  [inline]

Definition at line 126 of file itkNarrowBand.h.

template<class NodeType> void itk::NarrowBand< NodeType >::SetInnerRadius (  float  val  )  [inline]

Set/Get the narrow band inner radius. The inner radius is the safe are where the level set can be computed. Definition at line 150 of file itkNarrowBand.h.

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

Sets the reference count on this object. This is a dangerous method, use it with care. Reimplemented in itk::Object.

template<class NodeType> void itk::NarrowBand< NodeType >::SetTotalRadius (  float  val  )  [inline]

Set/Get the narrow band total radius. The narrow band width will be twice this value (positive and negative distance to the zero level set). The user of the narrow band container should set up this value properly. Definition at line 144 of file itkNarrowBand.h.

template<class NodeType> SizeType itk::NarrowBand< NodeType >::Size (   )  const [inline]

Definition at line 100 of file itkNarrowBand.h.

template<class NodeType> std::vector<struct RegionStruct> itk::NarrowBand< NodeType >::SplitBand (  unsigned  int  )

Returns an array of RegionStructs which represent contiguous arrays of nodes within the narrow band.

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

Decrease the reference count (release by another object). Reimplemented in itk::Object.

---

Member Data Documentation

template<class NodeType> float itk::NarrowBand< NodeType >::m_InnerRadius [protected]

Definition at line 158 of file itkNarrowBand.h.

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

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

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

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

template<class NodeType> float itk::NarrowBand< NodeType >::m_TotalRadius [protected]

Definition at line 156 of file itkNarrowBand.h.

Methods invoked by virtual 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 PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkNarrowBand.h

---