itk::BloxImage< TBloxPixelType, VImageDimension > Class Template Reference
[Image Representation Objects]

Templated n-dimensional image class used to store linked lists. More...

#include <itkBloxImage.h>

Inheritance diagram for itk::BloxImage< TBloxPixelType, VImageDimension >:

[legend]Collaboration diagram for itk::BloxImage< TBloxPixelType, VImageDimension >:

[legend]List of all members.

Public Types
typedef BloxImage	Self
typedef Image< TBloxPixelType, VImageDimension >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef WeakPointer< const Self >	ConstWeakPointer
typedef TBloxPixelType	PixelType
typedef TBloxPixelType	InternalPixelType
typedef DefaultPixelAccessor< PixelType >	AccessorType
typedef Superclass::PixelContainer	PixelContainer
typedef Superclass::SizeType	SizeType
typedef Superclass::IndexType	IndexType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::RegionType	RegionType
typedef PixelContainer::Pointer	PixelContainerPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (ImageDimension, unsigned int, VImageDimension)
void	EmptyImage ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	BloxImage ()
virtual	~BloxImage ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

template<typename TBloxPixelType, unsigned int VImageDimension = 3>
class itk::BloxImage< TBloxPixelType, VImageDimension >

Templated n-dimensional image class used to store linked lists.

The itk::BloxImage object is a regular, rectilinear lattice of "blocks" in n-dimensional space. The word "blox" was chosen to bring to mind a set of "city blocks" in 2D or "building blocks" in 3D. Being a regular lattice, itkBloxImage logically derives from itkImage. In an itkBloxImage, each pixel represents an isometric space-filling block of geometric space, called an itkBloxPixel. Each itk::BloxPixel generally covers many pixels in the underlying image and is used to store a variable number of image primitives (such as boundary points) or features (such as medial nodes) gathered within that region of geometric space. To do this, each itkBloxPixel contains a linked list.

The itk::BloxImage object facilitates certain forms of analysis by providing geometric hashing. For example, if boundary points are stored in an itk::BloxImage, pairs of boundary points that face each other (called "core atoms") can be found by searching relatively small regions of geometric space that face each boundary point for appropriate mates. Because an itk::BloxImage is rectilinear in geometric space (even though the underlying image may not be) subsequent analysis can be invariant to rotation and translation.

itk::BloxImage is templated over pixel type; in general, the pixel type should be derived from itk::BloxPixel, however this is not enforced and other implementations are possible.

Note that itk::BloxPixel is itself templated over item type (the type of object stored in the linked list).

Definition at line 60 of file itkBloxImage.h.

---

Member Typedef Documentation

template<typename TBloxPixelType, unsigned int VImageDimension = 3> typedef DefaultPixelAccessor< PixelType > itk::BloxImage< TBloxPixelType, VImageDimension >::AccessorType

Accessor type that convert data between internal and external representations. Reimplemented from itk::Image< TBloxPixelType, VImageDimension >. Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, and itk::BloxCoreAtomImage< dim >. Definition at line 88 of file itkBloxImage.h.

template<typename TBloxPixelType, unsigned int VImageDimension = 3> typedef SmartPointer<const Self> itk::BloxImage< TBloxPixelType, VImageDimension >::ConstPointer

Reimplemented from itk::Image< TBloxPixelType, VImageDimension >. Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, and itk::BloxCoreAtomImage< dim >. Definition at line 67 of file itkBloxImage.h.

template<typename TBloxPixelType, unsigned int VImageDimension = 3> typedef WeakPointer<const Self> itk::BloxImage< TBloxPixelType, VImageDimension >::ConstWeakPointer

Reimplemented from itk::Image< TBloxPixelType, VImageDimension >. Reimplemented in itk::BloxCoreAtomImage< dim >. Definition at line 68 of file itkBloxImage.h.

template<typename TBloxPixelType, unsigned int VImageDimension = 3> typedef Superclass::IndexType itk::BloxImage< TBloxPixelType, VImageDimension >::IndexType

Index typedef support. An index is used to access pixel values. Reimplemented from itk::Image< TBloxPixelType, VImageDimension >. Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, and itk::BloxCoreAtomImage< dim >. Definition at line 99 of file itkBloxImage.h.

template<typename TBloxPixelType, unsigned int VImageDimension = 3> typedef TBloxPixelType itk::BloxImage< TBloxPixelType, VImageDimension >::InternalPixelType

Internal Pixel representation. Used to maintain a uniform API with Image Adaptors and allow to keep a particular internal representation of data while showing a different external representation. Reimplemented from itk::Image< TBloxPixelType, VImageDimension >. Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, and itk::BloxCoreAtomImage< dim >. Definition at line 84 of file itkBloxImage.h.

template<typename TBloxPixelType, unsigned int VImageDimension = 3> typedef Superclass::OffsetType itk::BloxImage< TBloxPixelType, VImageDimension >::OffsetType

Offset typedef support. An offset is used to access pixel values. Reimplemented from itk::Image< TBloxPixelType, VImageDimension >. Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, and itk::BloxCoreAtomImage< dim >. Definition at line 100 of file itkBloxImage.h.

template<typename TBloxPixelType, unsigned int VImageDimension = 3> typedef Superclass::PixelContainer itk::BloxImage< TBloxPixelType, VImageDimension >::PixelContainer

Convenient typedefs obtained from Superclass. Reimplemented from itk::Image< TBloxPixelType, VImageDimension >. Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, and itk::BloxCoreAtomImage< dim >. Definition at line 97 of file itkBloxImage.h.

template<typename TBloxPixelType, unsigned int VImageDimension = 3> typedef PixelContainer::Pointer itk::BloxImage< TBloxPixelType, VImageDimension >::PixelContainerPointer

A pointer to the pixel container. Reimplemented from itk::Image< TBloxPixelType, VImageDimension >. Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, and itk::BloxCoreAtomImage< dim >. Definition at line 104 of file itkBloxImage.h.

template<typename TBloxPixelType, unsigned int VImageDimension = 3> typedef TBloxPixelType itk::BloxImage< TBloxPixelType, VImageDimension >::PixelType

Pixel typedef support. Used to declare pixel type in filters or other operations. Reimplemented from itk::Image< TBloxPixelType, VImageDimension >. Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, and itk::BloxCoreAtomImage< dim >. Definition at line 78 of file itkBloxImage.h.

template<typename TBloxPixelType, unsigned int VImageDimension = 3> typedef SmartPointer<Self> itk::BloxImage< TBloxPixelType, VImageDimension >::Pointer

Reimplemented from itk::Image< TBloxPixelType, VImageDimension >. Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, and itk::BloxCoreAtomImage< dim >. Definition at line 66 of file itkBloxImage.h.

template<typename TBloxPixelType, unsigned int VImageDimension = 3> typedef Superclass::RegionType itk::BloxImage< TBloxPixelType, VImageDimension >::RegionType

Region typedef support. A region is used to specify a subset of an image. Reimplemented from itk::Image< TBloxPixelType, VImageDimension >. Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, and itk::BloxCoreAtomImage< dim >. Definition at line 101 of file itkBloxImage.h.

template<typename TBloxPixelType, unsigned int VImageDimension = 3> typedef BloxImage itk::BloxImage< TBloxPixelType, VImageDimension >::Self

Standard class typedefs. Reimplemented from itk::Image< TBloxPixelType, VImageDimension >. Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, and itk::BloxCoreAtomImage< dim >. Definition at line 64 of file itkBloxImage.h.

template<typename TBloxPixelType, unsigned int VImageDimension = 3> typedef Superclass::SizeType itk::BloxImage< TBloxPixelType, VImageDimension >::SizeType

Size typedef support. A size is used to define region bounds. Reimplemented from itk::Image< TBloxPixelType, VImageDimension >. Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, and itk::BloxCoreAtomImage< dim >. Definition at line 98 of file itkBloxImage.h.

template<typename TBloxPixelType, unsigned int VImageDimension = 3> typedef Image<TBloxPixelType, VImageDimension> itk::BloxImage< TBloxPixelType, VImageDimension >::Superclass

Reimplemented from itk::Image< TBloxPixelType, VImageDimension >. Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, and itk::BloxCoreAtomImage< dim >. Definition at line 65 of file itkBloxImage.h.

---

Constructor & Destructor Documentation

template<typename TBloxPixelType, unsigned int VImageDimension = 3> itk::BloxImage< TBloxPixelType, VImageDimension >::BloxImage (   )  [protected]

template<typename TBloxPixelType, unsigned int VImageDimension = 3> virtual itk::BloxImage< TBloxPixelType, VImageDimension >::~BloxImage (   )  [protected, virtual]

---

Member Function Documentation

template<typename TBloxPixelType, unsigned int VImageDimension = 3> void itk::BloxImage< TBloxPixelType, VImageDimension >::EmptyImage (   )

Traverse the entire image and empty all linked lists. This is used in filters prior to generating new data, to avoid appending the new data onto the old

template<typename TBloxPixelType, unsigned int VImageDimension = 3> virtual const char* itk::BloxImage< TBloxPixelType, VImageDimension >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Image< TBloxPixelType, VImageDimension >. Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, and itk::BloxCoreAtomImage< dim >.

template<typename TBloxPixelType, unsigned int VImageDimension = 3> itk::BloxImage< TBloxPixelType, VImageDimension >::itkStaticConstMacro (  ImageDimension  , unsigned  int, VImageDimension  )

Dimension of the image. This enum is used by functions that are templated over image type (as opposed to being templated over pixel type and dimension) when they need compile time access to the dimension of the image. Reimplemented from itk::Image< TBloxPixelType, VImageDimension >.

template<typename TBloxPixelType, unsigned int VImageDimension = 3> Pointer itk::BloxImage< TBloxPixelType, VImageDimension >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Image< TBloxPixelType, VImageDimension >. Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, and itk::BloxCoreAtomImage< dim >.

template<typename TBloxPixelType, unsigned int VImageDimension = 3> void itk::BloxImage< TBloxPixelType, VImageDimension >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Compute the index of the pixel at a specified offset from the beginning of the buffered region. Bounds checking is not performed. Thus, the computed index could be outside the BufferedRegion. To ensure a valid index, the parameter "offset" should be between 0 and the number of pixels in the BufferedRegion (the latter can be found using ImageRegion::GetNumberOfPixels()). Reimplemented from itk::Image< TBloxPixelType, VImageDimension >. Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, and itk::BloxCoreAtomImage< dim >.

---

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

• itkBloxImage.h

---