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.

---

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.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TElement	Element
typedef TElementIdentifier	ElementIdentifier
typedef SmartPointer< Self >	Pointer
typedef ImportImageContainer	Self
typedef Object	Superclass
Public Member Functions
virtual void	ContainerManageMemoryOff ()
virtual void	ContainerManageMemoryOn ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
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 */virtual void SetContainerManageMemory(bool _arg)
TElement *	GetBufferPointer ()
Command *	GetCommand (unsigned long tag)
virtual bool	GetContainerManageMemory ()
bool	GetDebug () const
TElement *	GetImportPointer ()
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
void	Initialize (void)
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
const TElement &	operator[] (const ElementIdentifier id) const
TElement &	operator[] (const ElementIdentifier id)
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	Reserve (ElementIdentifier num)
void	SetDebug (bool debugFlag) const
void	SetImportPointer (TElement *ptr, TElementIdentifier num, bool LetContainerManageMemory=false)
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
TElement *	AllocateElements (ElementIdentifier size) const
	ImportImageContainer ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~ImportImageContainer ()
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

---

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.

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]

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> virtual void itk::ImportImageContainer< TElementIdentifier, TElement >::ContainerManageMemoryOff (   )  [virtual]

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

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.

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> 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 itk::ImportImageContainer< TElementIdentifier, TElement >::false (  or  OFF  )

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.

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.

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

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

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.

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::ImportImageContainer< 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> void itk::ImportImageContainer< TElementIdentifier, TElement >::Initialize (  void   )

Tell the container to release any of its allocated memory.

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

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.

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]

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.

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

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

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

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

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.

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

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

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

---

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:

• itkImportImageContainer.h

---