itk::ValarrayImageContainer< TElementIdentifier, TElement > Class Template Reference

#include <itkValarrayImageContainer.h>

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

Collaboration diagram for itk::ValarrayImageContainer< TElementIdentifier, TElement >:

Detailed Description

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

Defines a front-end to the std\::<valarray> container that conforms to the ImageContainerInterface.

This is a full-fleged Object, so there is modification time, debug, and reference count information.

Template Parameters

TElementIdentifier	An INTEGRAL type for use in indexing the valarray. It must have a < operator defined for ordering.
TElement	The element type stored in the container.

Definition at line 51 of file itkValarrayImageContainer.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TElement	Element
typedef TElementIdentifier	ElementIdentifier
typedef SmartPointer< Self >	Pointer
typedef ValarrayImageContainer	Self
typedef Object	Superclass
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
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
void	Fill (const TElement &value)
virtual const char *	GetNameOfClass () const
void	Initialize (void)
TElement &	operator[] (const ElementIdentifier id)
const TElement &	operator[] (const ElementIdentifier id) const
void	Reserve (ElementIdentifier num)
unsigned long	Size (void) const
void	Squeeze (void)
TElement *	GetBufferPointer ()
virtual void	PrintSelf (std::ostream &os, Indent indent) 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 (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) 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
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () 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
	ValarrayImageContainer ()
	ValarrayImageContainer (unsigned long n)
	ValarrayImageContainer (unsigned long n, const Element &x)
	ValarrayImageContainer (const Self &r)
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 Types
typedef std::valarray< Element >	ValarrayType

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType
Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Private Attributes inherited from std::valarray< T >
T	elements

Member Typedef Documentation

template<typename TElementIdentifier , typename TElement >

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

Definition at line 60 of file itkValarrayImageContainer.h.

template<typename TElementIdentifier , typename TElement >

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

Definition at line 64 of file itkValarrayImageContainer.h.

template<typename TElementIdentifier , typename TElement >

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

Save the template parameters.

Definition at line 63 of file itkValarrayImageContainer.h.

template<typename TElementIdentifier , typename TElement >

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

Definition at line 59 of file itkValarrayImageContainer.h.

template<typename TElementIdentifier , typename TElement >

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

Standard class typedefs.

Definition at line 57 of file itkValarrayImageContainer.h.

template<typename TElementIdentifier , typename TElement >

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

Definition at line 58 of file itkValarrayImageContainer.h.

template<typename TElementIdentifier , typename TElement >

typedef std::valarray< Element > itk::ValarrayImageContainer< TElementIdentifier, TElement >::ValarrayType

private

Quick access to the STL valarray type that was inherited.

Definition at line 68 of file itkValarrayImageContainer.h.

Constructor & Destructor Documentation

template<typename TElementIdentifier , typename TElement >

itk::ValarrayImageContainer< TElementIdentifier, TElement >::ValarrayImageContainer ( )

inlineprotected

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

Definition at line 75 of file itkValarrayImageContainer.h.

template<typename TElementIdentifier , typename TElement >

itk::ValarrayImageContainer< TElementIdentifier, TElement >::ValarrayImageContainer ( unsigned long  n )

inlineprotected

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

Definition at line 77 of file itkValarrayImageContainer.h.

template<typename TElementIdentifier , typename TElement >

itk::ValarrayImageContainer< TElementIdentifier, TElement >::ValarrayImageContainer ( unsigned long  n, const Element &  x  )

inlineprotected

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

Definition at line 79 of file itkValarrayImageContainer.h.

template<typename TElementIdentifier , typename TElement >

itk::ValarrayImageContainer< TElementIdentifier, TElement >::ValarrayImageContainer ( const Self &  r )

inlineprotected

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

Definition at line 81 of file itkValarrayImageContainer.h.

Member Function Documentation

template<typename TElementIdentifier , typename TElement >

virtual::itk::LightObject::Pointer itk::ValarrayImageContainer< TElementIdentifier, TElement >::CreateAnother ( void  ) 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 TElementIdentifier , typename TElement >

void itk::ValarrayImageContainer< TElementIdentifier, TElement >::Fill ( const TElement &  value )

inline

Tell the container to release any of its allocated memory.

Definition at line 137 of file itkValarrayImageContainer.h.

template<typename TElementIdentifier , typename TElement >

TElement* itk::ValarrayImageContainer< TElementIdentifier, TElement >::GetBufferPointer ( )

inline

Return a pointer to the beginning of the buffer. This is used by the image iterator class.

Definition at line 102 of file itkValarrayImageContainer.h.

References NULL, and itk::ValarrayImageContainer< TElementIdentifier, TElement >::Size().

Referenced by itk::ValarrayImageContainer< TElementIdentifier, TElement >::PrintSelf().

template<typename TElementIdentifier , typename TElement >

virtual const char* itk::ValarrayImageContainer< TElementIdentifier, TElement >::GetNameOfClass ( ) const

virtual

Standard part of every itk Object.

Reimplemented from itk::Object.

template<typename TElementIdentifier , typename TElement >

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

inline

Tell the container to release any of its allocated memory.

Definition at line 133 of file itkValarrayImageContainer.h.

template<typename TElementIdentifier , typename TElement >

static Pointer itk::ValarrayImageContainer< TElementIdentifier, TElement >::New ( )

static

Method for creation through the object factory.

template<typename TElementIdentifier , typename TElement >

TElement& itk::ValarrayImageContainer< TElementIdentifier, TElement >::operator[] ( const ElementIdentifier  id )

inline

Index operator. This version can be an lvalue.

Definition at line 93 of file itkValarrayImageContainer.h.

template<typename TElementIdentifier , typename TElement >

const TElement& itk::ValarrayImageContainer< TElementIdentifier, TElement >::operator[] ( const ElementIdentifier  id ) const

inline

Index operator. This version can only be an rvalue

Definition at line 97 of file itkValarrayImageContainer.h.

template<typename TElementIdentifier , typename TElement >

virtual void itk::ValarrayImageContainer< TElementIdentifier, TElement >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

inlinevirtual

PrintSelf routine. Normally this is a protected internal method. It is made public here so that Image can call this method. Users should not call this method but should call Print() instead.

Reimplemented from itk::Object.

Definition at line 144 of file itkValarrayImageContainer.h.

References itk::ValarrayImageContainer< TElementIdentifier, TElement >::GetBufferPointer(), itk::Object::PrintSelf(), and itk::ValarrayImageContainer< TElementIdentifier, TElement >::Size().

template<typename TElementIdentifier , typename TElement >

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

inline

Tell the container to allocate enough memory to allow at least as many elements as the size given to be stored. This is NOT guaranteed to actually allocate any memory, but is useful if the implementation of the container allocates contiguous storage.

Definition at line 123 of file itkValarrayImageContainer.h.

template<typename TElementIdentifier , typename TElement >

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

inline

Get the number of elements currently stored in the container.

Definition at line 116 of file itkValarrayImageContainer.h.

Referenced by itk::ValarrayImageContainer< TElementIdentifier, TElement >::GetBufferPointer(), and itk::ValarrayImageContainer< TElementIdentifier, TElement >::PrintSelf().

template<typename TElementIdentifier , typename TElement >

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

inline

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.

Definition at line 129 of file itkValarrayImageContainer.h.

---

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

• itkValarrayImageContainer.h