itk::OctreeBase Class Reference

Provides non-templated access to templated instances of Octree. More...

#include <itkOctree.h>

Inheritance diagram for itk::OctreeBase:

[legend]Collaboration diagram for itk::OctreeBase:

[legend]List of all members.

Public Types
typedef OctreeBase	Self
typedef SmartPointer< Self >	Pointer
Public Member Functions
virtual OctreeNode *	GetTree ()=0
virtual unsigned int	GetDepth ()=0
virtual unsigned int	GetWidth ()=0
virtual void	SetDepth (unsigned int depth)=0
virtual void	SetWidth (unsigned int width)=0
virtual void	BuildFromBuffer (const void *buffer, const int xsize, const int ysize, const int zsize)=0
virtual const char *	GetColorTable () const =0
virtual int	GetColorTableSize () const =0

---

Detailed Description

Provides non-templated access to templated instances of Octree.

Definition at line 54 of file itkOctree.h.

---

Member Typedef Documentation

typedef SmartPointer<Self> itk::OctreeBase::Pointer

Reimplemented from itk::Object. Reimplemented in itk::Octree< TPixel, ColorTableSize, MappingFunctionType >. Definition at line 60 of file itkOctree.h.

typedef OctreeBase itk::OctreeBase::Self

Standard class typedefs. Reimplemented from itk::Object. Reimplemented in itk::Octree< TPixel, ColorTableSize, MappingFunctionType >. Definition at line 59 of file itkOctree.h.

---

Member Function Documentation

virtual void itk::OctreeBase::BuildFromBuffer (  const void *  buffer, const int  xsize, const int  ysize, const int  zsize )  [pure 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. Implemented in itk::Octree< TPixel, ColorTableSize, MappingFunctionType >.

virtual const char* itk::OctreeBase::GetColorTable (   )  const [pure 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. Implemented in itk::Octree< TPixel, ColorTableSize, MappingFunctionType >.

virtual int itk::OctreeBase::GetColorTableSize (   )  const [pure virtual]

Get the size of the Color Table Implemented in itk::Octree< TPixel, ColorTableSize, MappingFunctionType >.

virtual unsigned int itk::OctreeBase::GetDepth (   )  [pure virtual]

Get tree depth. Depth represents x, for the smallest 2^x >= largest image dimension Implemented in itk::Octree< TPixel, ColorTableSize, MappingFunctionType >.

virtual OctreeNode* itk::OctreeBase::GetTree (   )  [pure virtual]

Get the actual tree base Returns the tree, or 0 if the Octree isn't built yet Implemented in itk::Octree< TPixel, ColorTableSize, MappingFunctionType >.

virtual unsigned int itk::OctreeBase::GetWidth (   )  [pure virtual]

Get tree width. Width == smallest 2^x >= largest image dimension i.e. 2^Depth == Width Implemented in itk::Octree< TPixel, ColorTableSize, MappingFunctionType >.

virtual void itk::OctreeBase::SetDepth (  unsigned int  depth  )  [pure virtual]

Set the depth, e.g. when reading tree from a file. Implemented in itk::Octree< TPixel, ColorTableSize, MappingFunctionType >.

virtual void itk::OctreeBase::SetWidth (  unsigned int  width  )  [pure virtual]

Set width, e.g. when reading from a file. Implemented in itk::Octree< TPixel, ColorTableSize, MappingFunctionType >.

---

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

• itkOctree.h

---