ITK: itk::SparseFieldLayer< TNodeType > Class Template Reference

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

template<class TNodeType>

ConstIterator itk::SparseFieldLayer< TNodeType >::Begin ( ) const [inline]

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

Definition at line 223 of file itkSparseFieldLayer.h.

template<class TNodeType>

Iterator itk::SparseFieldLayer< TNodeType >::Begin ( ) [inline]

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

Definition at line 219 of file itkSparseFieldLayer.h.

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

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

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.

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.

template<class TNodeType>

bool itk::SparseFieldLayer< TNodeType >::Empty ( ) const [inline]

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

Definition at line 236 of file itkSparseFieldLayer.h.

template<class TNodeType>

ConstIterator itk::SparseFieldLayer< TNodeType >::End ( ) const [inline]

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

Definition at line 231 of file itkSparseFieldLayer.h.

template<class TNodeType>

Iterator itk::SparseFieldLayer< TNodeType >::End ( ) [inline]

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

Definition at line 227 of file itkSparseFieldLayer.h.

template<class 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 189 of file itkSparseFieldLayer.h.

template<class TNodeType>

NodeType* itk::SparseFieldLayer< TNodeType >::Front ( ) [inline]

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

Definition at line 185 of file itkSparseFieldLayer.h.

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::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

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

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

Returns:: A constant reference to this objects MetaDataDictionary.

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

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

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 TNodeType>

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

Run-time type information (and related methods).

Reimplemented from itk::Object.

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

Gets the reference count on this object.

Definition at line 98 of file itkLightObject.h.

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

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

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

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

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

Return true if an observer is registered for this event.

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.

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

Call Execute on all the Commands observing this event id.

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, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TNodeType>

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

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TNodeType>

void itk::SparseFieldLayer< TNodeType >::PopFront ( ) [inline]

Unlinks the first node from the list. Constant time.

Definition at line 193 of file itkSparseFieldLayer.h.

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

Cause the object to print itself out.

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

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

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

template<class TNodeType>

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

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

template<class TNodeType>

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

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

Definition at line 201 of file itkSparseFieldLayer.h.

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

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

Reimplemented from itk::LightObject.

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

Remove all observers .

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

Remove the observer with this tag value.

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

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

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

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

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

template<class TNodeType>

unsigned int itk::SparseFieldLayer< TNodeType >::Size ( ) const

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

template<class TNodeType>

RegionListType itk::SparseFieldLayer< TNodeType >::SplitRegions ( int num ) const

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

template<class TNodeType>

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

Unlinks a node from the list

Definition at line 211 of file itkSparseFieldLayer.h.

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

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

volatile 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.

itk::SparseFieldLayer< TNodeType > Class Template Reference

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Classes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation


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 Member Functions
ConstIterator	Begin () const
Iterator	Begin ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
ConstIterator	End () const
Iterator	End ()
const NodeType *	Front () const
NodeType *	Front ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	PopFront ()
void	Print (std::ostream &os, Indent indent=0) const
void	PushFront (NodeType *n)
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
unsigned int	Size () const
RegionListType	SplitRegions (int num) const
void	Unlink (NodeType *n)
virtual void	UnRegister () const

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

bool	Empty () const
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Member Functions
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
	SparseFieldLayer ()
	~SparseFieldLayer ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
volatile int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Classes
struct	RegionType

itk::SparseFieldLayer< TNodeType > Class Template Reference

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Classes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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