Main Page Groups Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Concepts

itk::VectorContainer< TElementIdentifier, TElement > Class Template Reference
[Data Representation Objects]

#include <itkVectorContainer.h>

Inheritance diagram for itk::VectorContainer< TElementIdentifier, TElement >:

[legend]Collaboration diagram for itk::VectorContainer< TElementIdentifier, TElement >:

[legend]List of all members.

Detailed Description

template<typename TElementIdentifier, typename TElement>
class itk::VectorContainer< TElementIdentifier, TElement >

Define a front-end to the STL "vector" container that conforms to the IndexedContainerInterface. This is a full-fleged Object, so there is modification time, debug, and reference count information.

Template parameters for VectorContainer:

TElementIdentifier = An INTEGRAL type for use in indexing the vector.

TElement = The element type stored in the container.

Definition at line 48 of file itkVectorContainer.h.

Public Types

typedef SmartPointer< const
Self > ConstPointer

typedef TElement Element

typedef TElementIdentifier ElementIdentifier

typedef SmartPointer< Self > Pointer

typedef VectorContainer Self

typedef VectorType STLContainerType

typedef Object Superclass

Public Member Functions

Iterator Begin (void)

ConstIterator Begin (void) const

const STLContainerType & CastToSTLConstContainer () const

STLContainerType & CastToSTLContainer ()

virtual LightObject::Pointer CreateAnother () const

Element & CreateElementAt (ElementIdentifier)

void CreateIndex (ElementIdentifier)

virtual void DebugOff () const

virtual void DebugOn () const

virtual void Delete ()

void DeleteIndex (ElementIdentifier)

const Element & ElementAt (ElementIdentifier) const

Element & ElementAt (ElementIdentifier)

Iterator End (void)

ConstIterator End (void) const

Command * GetCommand (unsigned long tag)

bool GetDebug () const

Element GetElement (ElementIdentifier) const

bool GetElementIfIndexExists (ElementIdentifier, Element *) 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

bool IndexExists (ElementIdentifier) const

void Initialize (void)

void InsertElement (ElementIdentifier, Element)

void InvokeEvent (const EventObject &) const

void InvokeEvent (const EventObject &)

virtual void Modified () const

void Print (std::ostream &os, Indent indent=0) const

virtual void Register () const

void RemoveAllObservers ()

void RemoveObserver (unsigned long tag)

void Reserve (ElementIdentifier)

void SetDebug (bool debugFlag) const

void SetElement (ElementIdentifier, Element)

void SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void SetReferenceCount (int)

unsigned long Size (void) const

void Squeeze (void)

virtual void UnRegister () const

Static Public Member Functions

static void BreakOnError ()

static bool GetGlobalWarningDisplay ()

static void GlobalWarningDisplayOff ()

static void GlobalWarningDisplayOn ()

static Pointer New ()

This is a global flag that
controls whether any warning
*or error messages are displayed
*static void SetGlobalWarningDisplay (bool flag)

Public Attributes

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 unsigned lon AddObserver )(const EventObject &event, Command *) const

This is a global flag that
controls whether any debug

Protected Member Functions

Provide pass through constructors
corresponding to all the STL
*vector constructors These
are for internal use only
since this is also *an Object
which must be constructed
through the New ()" routine. */ VectorContainer()

bool PrintObservers (std::ostream &os, Indent indent) const

virtual void PrintSelf (std::ostream &os, Indent indent) const

virtual void PrintTrailer (std::ostream &os, Indent indent) const

template<typename InputIterator>

VectorContainer (InputIterator first, InputIterator last)

VectorContainer (const Self &r)

VectorContainer (size_type n, const Element &x)

VectorContainer (size_type n)

Protected Attributes

int m_ReferenceCount

SimpleFastMutexLock m_ReferenceCountLock

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

Friends

class ConstIterator

class Iterator

Classes

class ConstIterator

class Iterator

Member Typedef Documentation

template<typename TElementIdentifier, typename TElement>

typedef SmartPointer<const Self> itk::VectorContainer< TElementIdentifier, TElement >::ConstPointer

Reimplemented from itk::Object.
Definition at line 57 of file itkVectorContainer.h.

template<typename TElementIdentifier, typename TElement>

typedef TElement itk::VectorContainer< TElementIdentifier, TElement >::Element

Definition at line 61 of file itkVectorContainer.h.

template<typename TElementIdentifier, typename TElement>

typedef TElementIdentifier itk::VectorContainer< TElementIdentifier, TElement >::ElementIdentifier

Save the template parameters.
Definition at line 60 of file itkVectorContainer.h.

template<typename TElementIdentifier, typename TElement>

typedef SmartPointer<Self> itk::VectorContainer< TElementIdentifier, TElement >::Pointer

Reimplemented from itk::Object.
Definition at line 56 of file itkVectorContainer.h.

template<typename TElementIdentifier, typename TElement>

typedef VectorContainer itk::VectorContainer< TElementIdentifier, TElement >::Self

Standard class typedefs.
Reimplemented from itk::Object.
Definition at line 54 of file itkVectorContainer.h.

template<typename TElementIdentifier, typename TElement>

typedef VectorType itk::VectorContainer< TElementIdentifier, TElement >::STLContainerType

This type is provided to Adapt this container as an STL container
Definition at line 90 of file itkVectorContainer.h.

template<typename TElementIdentifier, typename TElement>

typedef Object itk::VectorContainer< TElementIdentifier, TElement >::Superclass

Reimplemented from itk::Object.
Definition at line 55 of file itkVectorContainer.h.

Constructor & Destructor Documentation

template<typename TElementIdentifier, typename TElement>

itk::VectorContainer< TElementIdentifier, TElement >::VectorContainer ( size_type n ) [inline, protected]

Definition at line 76 of file itkVectorContainer.h.

template<typename TElementIdentifier, typename TElement>

itk::VectorContainer< TElementIdentifier, TElement >::VectorContainer ( size_type n,

const Element & x

) [inline, protected]

Definition at line 78 of file itkVectorContainer.h.

template<typename TElementIdentifier, typename TElement>

itk::VectorContainer< TElementIdentifier, TElement >::VectorContainer ( const Self & r ) [inline, protected]

Definition at line 80 of file itkVectorContainer.h.

template<typename TElementIdentifier, typename TElement>

template<typename InputIterator>

itk::VectorContainer< TElementIdentifier, TElement >::VectorContainer ( InputIterator first,

InputIterator last

) [inline, protected]

Definition at line 83 of file itkVectorContainer.h.

Member Function Documentation

template<typename TElementIdentifier, typename TElement>

Iterator itk::VectorContainer< TElementIdentifier, TElement >::Begin ( void )

Get a begin iterator for the vector.

template<typename TElementIdentifier, typename TElement>

ConstIterator itk::VectorContainer< TElementIdentifier, TElement >::Begin ( void ) const

Get a begin const iterator for the vector.

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

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

template<typename TElementIdentifier, typename TElement>

const STLContainerType& itk::VectorContainer< TElementIdentifier, TElement >::CastToSTLConstContainer ( ) const [inline]

Cast the container to a const STL container type
Definition at line 107 of file itkVectorContainer.h.

template<typename TElementIdentifier, typename TElement>

STLContainerType& itk::VectorContainer< TElementIdentifier, TElement >::CastToSTLContainer ( ) [inline]

Cast the container to a STL container type
Definition at line 103 of file itkVectorContainer.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.

template<typename TElementIdentifier, typename TElement>

Element& itk::VectorContainer< TElementIdentifier, TElement >::CreateElementAt ( ElementIdentifier )

Get a reference to the element at the given index. If the element location does not exist, it will be created with a default element value.
It is assumed that the value of the element is modified through the reference.

template<typename TElementIdentifier, typename TElement>

void itk::VectorContainer< TElementIdentifier, TElement >::CreateIndex ( ElementIdentifier )

Make sure that the index range of the vector is large enough to allow the given index, expanding it if necessary. The index will contain the default element regardless of whether expansion occured.

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<typename TElementIdentifier, typename TElement>

void itk::VectorContainer< TElementIdentifier, TElement >::DeleteIndex ( ElementIdentifier )

Delete the element defined by the index identifier. In practice, it doesn't make sense to delete a vector index. Instead, this method just overwrite the index with the default element.

template<typename TElementIdentifier, typename TElement>

const Element& itk::VectorContainer< TElementIdentifier, TElement >::ElementAt ( ElementIdentifier ) const

Get a reference to the element at the given index. It is assumed that the index exists, and it will not automatically be created.

template<typename TElementIdentifier, typename TElement>

Element& itk::VectorContainer< TElementIdentifier, TElement >::ElementAt ( ElementIdentifier )

Get a reference to the element at the given index. It is assumed that the index exists, and it will not automatically be created.
It is assumed that the value of the element is modified through the reference.

template<typename TElementIdentifier, typename TElement>

Iterator itk::VectorContainer< TElementIdentifier, TElement >::End ( void )

Get an end iterator for the vector.

template<typename TElementIdentifier, typename TElement>

ConstIterator itk::VectorContainer< TElementIdentifier, TElement >::End ( void ) const

Get an end const iterator for the vector.

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.

template<typename TElementIdentifier, typename TElement>

Element itk::VectorContainer< TElementIdentifier, TElement >::GetElement ( ElementIdentifier ) const

Read the element from the given index. It is assumed that the index exists.

template<typename TElementIdentifier, typename TElement>

bool itk::VectorContainer< TElementIdentifier, TElement >::GetElementIfIndexExists ( ElementIdentifier ,

Element *

) const

Check if the given index is in range of the vector. If it is not, return false. Otherwise, set the element through the pointer (if it isn't NULL), and return true.

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.
Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

template<typename TElementIdentifier, typename TElement>

virtual const char* itk::VectorContainer< TElementIdentifier, TElement >::GetNameOfClass ( ) const [virtual]

Standard part of every itk Object.
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.

template<typename TElementIdentifier, typename TElement>

bool itk::VectorContainer< TElementIdentifier, TElement >::IndexExists ( ElementIdentifier ) const

Check if the index range of the vector is large enough to allow the given index without expansion.

template<typename TElementIdentifier, typename TElement>

void itk::VectorContainer< TElementIdentifier, TElement >::Initialize ( void )

Clear the elements. The final size will be zero.

template<typename TElementIdentifier, typename TElement>

void itk::VectorContainer< TElementIdentifier, TElement >::InsertElement ( ElementIdentifier ,

Element

)

Set the element value at the given index. If the element location does not exist, it will be created with a default element value.

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::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), 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< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<typename TElementIdentifier, typename TElement>

static Pointer itk::VectorContainer< TElementIdentifier, TElement >::New ( ) [static]

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

template<typename TElementIdentifier, typename TElement>

Provide pass through constructors corresponding to all the STL* vector constructors These are for internal use only since this is also* an Object which must be constructed through the itk::VectorContainer< TElementIdentifier, TElement >::New ( ) [inline, protected]

Method for creation through the object factory.
Reimplemented from itk::Object.
Definition at line 73 of file itkVectorContainer.h.

void itk::LightObject::Print ( std::ostream & os,

Indent indent = 0

) const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers ( std::ostream & os,

Indent indent

) const [protected, inherited]

virtual void itk::LightObject::PrintTrailer ( std::ostream & os,

Indent indent

) const [protected, virtual, inherited]

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.

template<typename TElementIdentifier, typename TElement>

void itk::VectorContainer< TElementIdentifier, TElement >::Reserve ( ElementIdentifier )

Tell the container to allocate enough memory to allow at least as many elements as the size given to be stored. In the generic case of ITK containers this is NOT guaranteed to actually allocate any memory, but it is useful if the implementation of the container allocates contiguous storage. In the particular implementation of this VectorContainer the call to this method actually allocates memory for the number of elements defined by ElementIdentifier.

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

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

template<typename TElementIdentifier, typename TElement>

void itk::VectorContainer< TElementIdentifier, TElement >::SetElement ( ElementIdentifier ,

Element

)

Set the element value at the given index. It is assumed that the index exists.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

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<typename TElementIdentifier, typename TElement>

unsigned long itk::VectorContainer< TElementIdentifier, TElement >::Size ( void ) const

Get the number of elements currently stored in the vector.

template<typename TElementIdentifier, typename TElement>

void itk::VectorContainer< TElementIdentifier, TElement >::Squeeze ( void )

Tell the container to try to minimize its memory usage for storage of the current number of elements. This is NOT guaranteed to decrease memory usage. This method is included here mainly for providing a unified API with other containers in the toolkit.

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

Decrease the reference count (release by another object).
Reimplemented from itk::LightObject.

Friends And Related Function Documentation

template<typename TElementIdentifier, typename TElement>

friend class ConstIterator [friend]

Definition at line 112 of file itkVectorContainer.h.

template<typename TElementIdentifier, typename TElement>

friend class Iterator [friend]

Friends to this class.
Definition at line 111 of file itkVectorContainer.h.

Member Data Documentation

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 unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.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.

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:

itkVectorContainer.h

Generated at Sun Jul 9 21:44:26 2006 for ITK by


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TElement	Element
typedef TElementIdentifier	ElementIdentifier
typedef SmartPointer< Self >	Pointer
typedef VectorContainer	Self
typedef VectorType	STLContainerType
typedef Object	Superclass
Public Member Functions
Iterator	Begin (void)
ConstIterator	Begin (void) const
const STLContainerType &	CastToSTLConstContainer () const
STLContainerType &	CastToSTLContainer ()
virtual LightObject::Pointer	CreateAnother () const
Element &	CreateElementAt (ElementIdentifier)
void	CreateIndex (ElementIdentifier)
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
void	DeleteIndex (ElementIdentifier)
const Element &	ElementAt (ElementIdentifier) const
Element &	ElementAt (ElementIdentifier)
Iterator	End (void)
ConstIterator	End (void) const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
Element	GetElement (ElementIdentifier) const
bool	GetElementIfIndexExists (ElementIdentifier, Element *) 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
bool	IndexExists (ElementIdentifier) const
void	Initialize (void)
void	InsertElement (ElementIdentifier, Element)
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	Reserve (ElementIdentifier)
void	SetDebug (bool debugFlag) const
void	SetElement (ElementIdentifier, Element)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
unsigned long	Size (void) const
void	Squeeze (void)
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning or error messages are displayed static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
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 unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
Provide pass through constructors corresponding to all the STL vector constructors These are for internal use only since this is also an Object which must be constructed through the	New ()" routine. */ VectorContainer()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
template<typename InputIterator>
	VectorContainer (InputIterator first, InputIterator last)
	VectorContainer (const Self &r)
	VectorContainer (size_type n, const Element &x)
	VectorContainer (size_type n)
Protected Attributes
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
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
Friends
class	ConstIterator
class	Iterator
Classes
class	ConstIterator
class	Iterator

itk::VectorContainer< TElementIdentifier, TElement > Class Template Reference [Data Representation Objects]

Detailed Description

template<typename TElementIdentifier, typename TElement> class itk::VectorContainer< TElementIdentifier, TElement >

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends