Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::Octree< TPixel, ColorTableSize, MappingFunctionType > Class Template Reference

represent a 3D Image with an Octree data structure. More...

#include <itkOctree.h>

Inheritance diagram for itk::Octree< TPixel, ColorTableSize, MappingFunctionType >:

Inheritance graph
[legend]
Collaboration diagram for itk::Octree< TPixel, ColorTableSize, MappingFunctionType >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef Octree Self
typedef OctreeBase Superclass
typedef SmartPointer< SelfPointer
typedef Image< TPixel, 3 > ImageType
typedef ImageType::Pointer ImageTypePointer

Public Member Functions

virtual const char * GetNameOfClass () const
ImageTypePointer GetImage ()
virtual void BuildFromBuffer (const void *buffer, const int xsize, const int ysize, const int zsize)
void BuildFromImage (Image< TPixel, 3 > *fromImage)
 Octree (void)
 ~Octree (void)
void SetColor (unsigned int color)
void SetTree (OctreeNodeBranch *branch)
void SetTrueDims (const unsigned int Dim0, const unsigned int Dim1, const unsigned int Dim2)
unsigned int GetValue (const unsigned int Dim0, const unsigned int Dim1, const unsigned int Dim2)
virtual void SetWidth (unsigned int width)
virtual void SetDepth (unsigned int depth)
virtual unsigned int GetWidth ()
virtual unsigned int GetDepth ()
virtual OctreeNodeGetTree ()
virtual const char * GetColorTable () const
virtual int GetColorTableSize () const

Static Public Member Functions

Pointer New ()

Detailed Description

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
class itk::Octree< TPixel, ColorTableSize, MappingFunctionType >

represent a 3D Image with an Octree data structure.

Parameterized on Pixel type of the image, # of colors in color table, and a Mapping function, derived from itk::FunctionBase

Definition at line 119 of file itkOctree.h.


Member Typedef Documentation

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
typedef Image<TPixel,3> itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::ImageType
 

Definition at line 127 of file itkOctree.h.

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
typedef ImageType::Pointer itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::ImageTypePointer
 

Definition at line 128 of file itkOctree.h.

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
typedef SmartPointer<Self> itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::Pointer
 

Reimplemented from itk::OctreeBase.

Definition at line 126 of file itkOctree.h.

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
typedef Octree itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::Self
 

Standard class typedefs.

Reimplemented from itk::OctreeBase.

Definition at line 124 of file itkOctree.h.

Referenced by itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::SetTree().

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
typedef OctreeBase itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::Superclass
 

Reimplemented from itk::Object.

Definition at line 125 of file itkOctree.h.


Constructor & Destructor Documentation

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::Octree void   ) 
 

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::~Octree void   ) 
 


Member Function Documentation

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
virtual void itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::BuildFromBuffer const void *  buffer,
const int  xsize,
const int  ysize,
const int  zsize
[virtual]
 

Build an Octree from an Image's pixel buffer.

Method needed for ImageIO class, which has no handle on image, just the pixel buffer.

Implements itk::OctreeBase.

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
void itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::BuildFromImage Image< TPixel, 3 > *  fromImage  ) 
 

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
virtual const char* itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::GetColorTable  )  const [virtual]
 

Get the ColorTable Pointer

Returns color table pointer for this tree.

Each Octree has an array of char whose size = the # of color table entries. Each Node in the Octree points either to 8 sub-nodes, or into the ColorTable; The color table isn't actually used to hold data; it simply provides a range of unique addresses that are distinct from the address of any valid subtree.

Implements itk::OctreeBase.

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
virtual int itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::GetColorTableSize  )  const [virtual]
 

Get the size of the Color Table

Implements itk::OctreeBase.

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
virtual unsigned int itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::GetDepth  )  [virtual]
 

Get tree depth.

Depth represents x, for the smallest 2^x >= largest image dimension

Implements itk::OctreeBase.

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
ImageTypePointer itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::GetImage  ) 
 

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
virtual const char* itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::GetNameOfClass  )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::Object.

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
virtual OctreeNode* itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::GetTree  )  [virtual]
 

Get the actual tree base

Returns the tree, or 0 if the Octree isn't built yet

Implements itk::OctreeBase.

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
unsigned int itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::GetValue const unsigned int  Dim0,
const unsigned int  Dim1,
const unsigned int  Dim2
 

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
virtual unsigned int itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::GetWidth  )  [virtual]
 

Get tree width.

Width == smallest 2^x >= largest image dimension i.e. 2^Depth == Width

Implements itk::OctreeBase.

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
Pointer itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::New  )  [static]
 

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
void itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::SetColor unsigned int  color  )  [inline]
 

Definition at line 142 of file itkOctree.h.

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
virtual void itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::SetDepth unsigned int  depth  )  [virtual]
 

Set the depth, e.g. when reading tree from a file.

Implements itk::OctreeBase.

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
void itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::SetTree OctreeNodeBranch branch  )  [inline]
 

Definition at line 143 of file itkOctree.h.

References itk::OctreePlaneType, and itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::Self.

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
void itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::SetTrueDims const unsigned int  Dim0,
const unsigned int  Dim1,
const unsigned int  Dim2
 

template<class TPixel, unsigned int ColorTableSize, class MappingFunctionType>
virtual void itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::SetWidth unsigned int  width  )  [virtual]
 

Set width, e.g. when reading from a file.

Implements itk::OctreeBase.


The documentation for this class was generated from the following file:
Generated at Thu May 25 01:59:33 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000