ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types
itk::ValarrayImageContainer< TElementIdentifier, TElement > Class Template Reference

#include <itkValarrayImageContainer.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef TElement Element
typedef TElementIdentifier ElementIdentifier
typedef SmartPointer< SelfPointer
typedef ValarrayImageContainer Self
typedef Object Superclass

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

Static Public Member Functions

static Pointer New ()

Protected Member Functions

 ValarrayImageContainer ()
 ValarrayImageContainer (unsigned long n)
 ValarrayImageContainer (unsigned long n, const Element &x)
 ValarrayImageContainer (const Self &r)

Private Types

typedef std::valarray< ElementValarrayType

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:
TElementIdentifierAn INTEGRAL type for use in indexing the valarray. It must have a < operator defined for ordering.
TElementThe element type stored in the container.

Definition at line 51 of file itkValarrayImageContainer.h.


Member Typedef Documentation

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

Reimplemented from itk::Object.

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

Reimplemented from itk::Object.

Definition at line 59 of file itkValarrayImageContainer.h.

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

Standard class typedefs.

Reimplemented from itk::Object.

Definition at line 57 of file itkValarrayImageContainer.h.

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

Reimplemented from itk::Object.

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 ( ) [inline, protected]

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) [inline, protected]

Definition at line 77 of file itkValarrayImageContainer.h.

template<typename TElementIdentifier , typename TElement >
itk::ValarrayImageContainer< TElementIdentifier, TElement >::ValarrayImageContainer ( unsigned long  n,
const Element x 
) [inline, protected]

Definition at line 79 of file itkValarrayImageContainer.h.

template<typename TElementIdentifier , typename TElement >
itk::ValarrayImageContainer< TElementIdentifier, TElement >::ValarrayImageContainer ( const Self r) [inline, protected]

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 136 of file itkValarrayImageContainer.h.

References itk::Object::operator=().

template<typename TElementIdentifier , typename TElement >
TElement* itk::ValarrayImageContainer< TElementIdentifier, TElement >::GetBufferPointer ( ) [inline]
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 132 of file itkValarrayImageContainer.h.

template<typename TElementIdentifier , typename TElement >
static Pointer itk::ValarrayImageContainer< TElementIdentifier, TElement >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<typename TElementIdentifier , typename TElement >
TElement& itk::ValarrayImageContainer< TElementIdentifier, TElement >::operator[] ( const ElementIdentifier  id) [inline]
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 96 of file itkValarrayImageContainer.h.

References itk::ValarrayImageContainer< TElementIdentifier, TElement >::operator[]().

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

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 143 of file itkValarrayImageContainer.h.

References itk::ValarrayImageContainer< TElementIdentifier, TElement >::GetBufferPointer(), 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 122 of file itkValarrayImageContainer.h.

template<typename TElementIdentifier , typename TElement >
unsigned long itk::ValarrayImageContainer< TElementIdentifier, TElement >::Size ( void  ) const [inline]
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 128 of file itkValarrayImageContainer.h.


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