ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::ImportImageContainer< TElementIdentifier, TElement > Class Template Reference

#include <itkImportImageContainer.h>

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

Detailed Description

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

Defines an itk::Image front-end to a standard C-array.

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
TElementIdentifierAn INTEGRAL type for use in indexing the imported buffer.
TElementThe element type stored in the container.

Definition at line 45 of file itkImportImageContainer.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef TElement Element
 
typedef TElementIdentifier ElementIdentifier
 
typedef SmartPointer< SelfPointer
 
typedef ImportImageContainer Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

ElementIdentifier Capacity (void) const
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
TElement * GetBufferPointer ()
 
TElement * GetImportPointer ()
 
virtual const char * GetNameOfClass () const
 
void Initialize ()
 
TElement & operator[] (const ElementIdentifier id)
 
const TElement & operator[] (const ElementIdentifier id) const
 
void Reserve (ElementIdentifier num, const bool UseDefaultConstructor=false)
 
void SetImportPointer (TElement *ptr, TElementIdentifier num, bool LetContainerManageMemory=false)
 
ElementIdentifier Size (void) const
 
void Squeeze ()
 
virtual void SetContainerManageMemory (bool _arg)
 
virtual bool GetContainerManageMemory () const
 
virtual void ContainerManageMemoryOn ()
 
virtual void ContainerManageMemoryOff ()
 
- 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () 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

virtual TElement * AllocateElements (ElementIdentifier size, bool UseDefaultConstructor=false) const
 
virtual void DeallocateManagedMemory ()
 
 ImportImageContainer ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetCapacity (TElementIdentifier _arg)
 
void SetImportPointer (TElement *ptr)
 
virtual void SetSize (TElementIdentifier _arg)
 
virtual ~ImportImageContainer ()
 
- 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 Member Functions

 ImportImageContainer (const Self &) ITK_DELETE_FUNCTION
 
void operator= (const Self &) ITK_DELETE_FUNCTION
 

Private Attributes

TElementIdentifier m_Capacity
 
bool m_ContainerManageMemory
 
TElement * m_ImportPointer
 
TElementIdentifier m_Size
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

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

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.

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

Definition at line 51 of file itkImportImageContainer.h.

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

Standard class typedefs.

Definition at line 49 of file itkImportImageContainer.h.

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

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 ( )
protectedvirtual
template<typename TElementIdentifier , typename TElement >
itk::ImportImageContainer< TElementIdentifier, TElement >::ImportImageContainer ( const Self )
private

Member Function Documentation

template<typename TElementIdentifier , typename TElement >
virtual TElement* itk::ImportImageContainer< TElementIdentifier, TElement >::AllocateElements ( ElementIdentifier  size,
bool  UseDefaultConstructor = false 
) const
protectedvirtual

Allocates elements of the array. If UseDefaultConstructor is true, then the default constructor is used to initialize each element. POD date types initialize to zero.

template<typename TElementIdentifier , typename TElement >
ElementIdentifier itk::ImportImageContainer< TElementIdentifier, TElement >::Capacity ( void  ) const
inline

Get the capacity of the container.

Definition at line 90 of file itkImportImageContainer.h.

References itk::ImportImageContainer< TElementIdentifier, TElement >::m_Capacity.

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 >
virtual::itk::LightObject::Pointer itk::ImportImageContainer< TElementIdentifier, TElement >::CreateAnother ( ) 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 >
virtual void itk::ImportImageContainer< TElementIdentifier, TElement >::DeallocateManagedMemory ( )
protectedvirtual
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.

References itk::ImportImageContainer< TElementIdentifier, TElement >::m_ImportPointer.

template<typename TElementIdentifier , typename TElement >
virtual bool itk::ImportImageContainer< TElementIdentifier, TElement >::GetContainerManageMemory ( ) const
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.

References itk::ImportImageContainer< TElementIdentifier, TElement >::m_ImportPointer.

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 ( )

Tell the container to release any of its allocated memory.

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

Method for creation through the object factory.

template<typename TElementIdentifier , typename TElement >
void itk::ImportImageContainer< TElementIdentifier, TElement >::operator= ( const Self )
private
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 >::m_ImportPointer.

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 >::m_ImportPointer.

template<typename TElementIdentifier , typename TElement >
virtual void itk::ImportImageContainer< TElementIdentifier, TElement >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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,
const bool  UseDefaultConstructor = false 
)

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.

In general, Reserve should not change the usable elements of the container. However, in this particular case, Reserve as a Resize semantics that is kept for backward compatibility reasons.

If UseDefaultConstructor is true, then * the default constructor is used to initialize each element. POD date types initialize to zero.

See Also
SetImportPointer()
template<typename TElementIdentifier , typename TElement >
virtual void itk::ImportImageContainer< TElementIdentifier, TElement >::SetCapacity ( TElementIdentifier  _arg)
protectedvirtual
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 >
void itk::ImportImageContainer< TElementIdentifier, TElement >::SetImportPointer ( TElement *  ptr)
inlineprotected
template<typename TElementIdentifier , typename TElement >
virtual void itk::ImportImageContainer< TElementIdentifier, TElement >::SetSize ( TElementIdentifier  _arg)
protectedvirtual
template<typename TElementIdentifier , typename TElement >
ElementIdentifier itk::ImportImageContainer< TElementIdentifier, TElement >::Size ( void  ) const
inline

Get the number of elements currently stored in the container.

Definition at line 94 of file itkImportImageContainer.h.

References itk::ImportImageContainer< TElementIdentifier, TElement >::m_Size.

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

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.

Member Data Documentation

template<typename TElementIdentifier , typename TElement >
TElementIdentifier itk::ImportImageContainer< TElementIdentifier, TElement >::m_Capacity
private
template<typename TElementIdentifier , typename TElement >
bool itk::ImportImageContainer< TElementIdentifier, TElement >::m_ContainerManageMemory
private

Definition at line 186 of file itkImportImageContainer.h.

template<typename TElementIdentifier , typename TElement >
TElement* itk::ImportImageContainer< TElementIdentifier, TElement >::m_ImportPointer
private
template<typename TElementIdentifier , typename TElement >
TElementIdentifier itk::ImportImageContainer< TElementIdentifier, TElement >::m_Size
private

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