itk::ImportImageContainer< TElementIdentifier, TElement > Class Template Reference
[Image Representation Objects, Input and Output Filters]

#include <itkImportImageContainer.h>

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

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

[legend]List of all members.

Public Types
typedef ImportImageContainer	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TElementIdentifier	ElementIdentifier
typedef TElement	Element
Public Member Functions
virtual const char *	GetNameOfClass () const
TElement *	GetImportPointer ()
void	SetImportPointer (TElement *ptr, TElementIdentifier num, bool LetContainerManageMemory=false)
TElement &	operator[] (const ElementIdentifier id)
const TElement &	operator[] (const ElementIdentifier id) const
TElement *	GetBufferPointer ()
unsigned long	Size (void) const
void	Reserve (ElementIdentifier num)
void	Squeeze (void)
void	Initialize (void)
virtual void	SetContainerManageMemory (bool _arg)
virtual bool	GetContainerManageMemory ()
virtual void	ContainerManageMemoryOn ()
virtual void	ContainerManageMemoryOff ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	ImportImageContainer ()
virtual	~ImportImageContainer ()
void	PrintSelf (std::ostream &os, Indent indent) const
TElement *	AllocateElements (ElementIdentifier size) const

---

Detailed Description

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

Defines an itk::Image front-end to a standard C-array. This container conforms to the ImageContainerInterface. This is a full-fleged Object, so there is modification time, debug, and reference count information.

Template parameters for ImportImageContainer:

TElementIdentifier = An INTEGRAL type for use in indexing the imported buffer.

TElement = The element type stored in the container.

Definition at line 45 of file itkImportImageContainer.h.

---

Member Typedef Documentation

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

Reimplemented from itk::Object. Definition at line 52 of file itkImportImageContainer.h.

template<typename TElementIdentifier, typename TElement> typedef TElement itk::ImportImageContainer< TElementIdentifier, TElement >::Element

Definition at line 56 of file itkImportImageContainer.h.

template<typename TElementIdentifier, typename TElement> typedef TElementIdentifier itk::ImportImageContainer< TElementIdentifier, TElement >::ElementIdentifier

Save the template parameters. Definition at line 55 of file itkImportImageContainer.h. Referenced by itk::ImportImageContainer< TElementIdentifier, TElement >::operator[]().

template<typename TElementIdentifier, typename TElement> typedef SmartPointer<Self> itk::ImportImageContainer< TElementIdentifier, TElement >::Pointer

Reimplemented from itk::Object. Definition at line 51 of file itkImportImageContainer.h.

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

Standard class typedefs. Reimplemented from itk::Object. Definition at line 49 of file itkImportImageContainer.h.

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

Reimplemented from itk::Object. Definition at line 50 of file itkImportImageContainer.h.

---

Constructor & Destructor Documentation

template<typename TElementIdentifier, typename TElement> itk::ImportImageContainer< TElementIdentifier, TElement >::ImportImageContainer (   )  [protected]

template<typename TElementIdentifier, typename TElement> virtual itk::ImportImageContainer< TElementIdentifier, TElement >::~ImportImageContainer (   )  [protected, virtual]

---

Member Function Documentation

template<typename TElementIdentifier, typename TElement> TElement* itk::ImportImageContainer< TElementIdentifier, TElement >::AllocateElements (  ElementIdentifier  size  )  const [protected]

template<typename TElementIdentifier, typename TElement> virtual void itk::ImportImageContainer< TElementIdentifier, TElement >::ContainerManageMemoryOff (   )  [virtual]

These methods allow to define whether upon destruction of this class the memory buffer should be released or not. Setting it to true (or ON) makes that this class will take care of memory release. Setting it to false (or OFF) will prevent the destructor from deleting the memory buffer. This is desirable only when the data is intended to be used by external applications. Note that the normal logic of this class set the value of the boolean flag. This may override your setting if you call this methods prematurely. Warning: Improper use of these methods will result in memory leaks

template<typename TElementIdentifier, typename TElement> virtual void itk::ImportImageContainer< TElementIdentifier, TElement >::ContainerManageMemoryOn (   )  [virtual]

These methods allow to define whether upon destruction of this class the memory buffer should be released or not. Setting it to true (or ON) makes that this class will take care of memory release. Setting it to false (or OFF) will prevent the destructor from deleting the memory buffer. This is desirable only when the data is intended to be used by external applications. Note that the normal logic of this class set the value of the boolean flag. This may override your setting if you call this methods prematurely. Warning: Improper use of these methods will result in memory leaks

template<typename TElementIdentifier, typename TElement> TElement* itk::ImportImageContainer< TElementIdentifier, TElement >::GetBufferPointer (   )  [inline]

Return a pointer to the beginning of the buffer. This is used by the image iterator class. Definition at line 86 of file itkImportImageContainer.h.

template<typename TElementIdentifier, typename TElement> virtual bool itk::ImportImageContainer< TElementIdentifier, TElement >::GetContainerManageMemory (   )  [virtual]

These methods allow to define whether upon destruction of this class the memory buffer should be released or not. Setting it to true (or ON) makes that this class will take care of memory release. Setting it to false (or OFF) will prevent the destructor from deleting the memory buffer. This is desirable only when the data is intended to be used by external applications. Note that the normal logic of this class set the value of the boolean flag. This may override your setting if you call this methods prematurely. Warning: Improper use of these methods will result in memory leaks

template<typename TElementIdentifier, typename TElement> TElement* itk::ImportImageContainer< TElementIdentifier, TElement >::GetImportPointer (   )  [inline]

Get the pointer from which the image data is imported. Definition at line 65 of file itkImportImageContainer.h.

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

Standard part of every itk Object. Reimplemented from itk::Object.

template<typename TElementIdentifier, typename TElement> void itk::ImportImageContainer< TElementIdentifier, TElement >::Initialize (  void   )

Tell the container to release any of its allocated memory.

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

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

template<typename TElementIdentifier, typename TElement> const TElement& itk::ImportImageContainer< TElementIdentifier, TElement >::operator[] (  const ElementIdentifier  id  )  const [inline]

Index operator. This version can only be an rvalue Definition at line 81 of file itkImportImageContainer.h. References itk::ImportImageContainer< TElementIdentifier, TElement >::ElementIdentifier.

template<typename TElementIdentifier, typename TElement> TElement& itk::ImportImageContainer< TElementIdentifier, TElement >::operator[] (  const ElementIdentifier  id  )  [inline]

Index operator. This version can be an lvalue. Definition at line 77 of file itkImportImageContainer.h. References itk::ImportImageContainer< TElementIdentifier, TElement >::ElementIdentifier.

template<typename TElementIdentifier, typename TElement> void itk::ImportImageContainer< TElementIdentifier, TElement >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, 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.

template<typename TElementIdentifier, typename TElement> void itk::ImportImageContainer< TElementIdentifier, TElement >::Reserve (  ElementIdentifier  num  )

Tell the container to allocate enough memory to allow at least as many elements as the size given to be stored. If new memory needs to be allocated, the contents of the old buffer are copied to the new area. The old buffer is deleted if the original pointer was passed in using "LetContainerManageMemory"=true. The new buffer's memory management will be handled by the container from that point on. See also: SetImportPointer()

template<typename TElementIdentifier, typename TElement> virtual void itk::ImportImageContainer< TElementIdentifier, TElement >::SetContainerManageMemory (  bool  _arg  )  [virtual]

These methods allow to define whether upon destruction of this class the memory buffer should be released or not. Setting it to true (or ON) makes that this class will take care of memory release. Setting it to false (or OFF) will prevent the destructor from deleting the memory buffer. This is desirable only when the data is intended to be used by external applications. Note that the normal logic of this class set the value of the boolean flag. This may override your setting if you call this methods prematurely. Warning: Improper use of these methods will result in memory leaks

template<typename TElementIdentifier, typename TElement> void itk::ImportImageContainer< TElementIdentifier, TElement >::SetImportPointer (  TElement *  ptr, TElementIdentifier  num, bool  LetContainerManageMemory = false )

Set the pointer from which the image data is imported. "num" is the number of pixels in the block of memory. If "LetContainerManageMemory" is false, then the application retains the responsibility of freeing the memory for this image data. If "LetContainerManageMemory" is true, then this class will free the memory when this object is destroyed.

template<typename TElementIdentifier, typename TElement> unsigned long itk::ImportImageContainer< TElementIdentifier, TElement >::Size (  void   )  const [inline]

Get the number of elements currently stored in the container. Definition at line 90 of file itkImportImageContainer.h.

template<typename TElementIdentifier, typename TElement> void itk::ImportImageContainer< TElementIdentifier, TElement >::Squeeze (  void   )

Tell the container to try to minimize its memory usage for storage of the current number of elements. If new memory is allocated, the contents of old buffer are copied to the new area. The previous buffer is deleted if the original pointer was in using "LetContainerManageMemory"=true. The new buffer's memory management will be handled by the container from that point on.

---

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

• itkImportImageContainer.h

---