ITK  4.3.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | List of all members
itk::OctreeBase Class Referenceabstract

#include <itkOctree.h>

+ Inheritance diagram for itk::OctreeBase:
+ Collaboration diagram for itk::OctreeBase:

Detailed Description

Provides non-templated access to templated instances of Octree.

Definition at line 54 of file itkOctree.h.

Public Types

typedef SmartPointer< SelfPointer
 
typedef OctreeBase Self
 
- 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

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
 
virtual unsigned int GetDepth ()=0
 
virtual OctreeNodeGetTree ()=0
 
virtual unsigned int GetWidth ()=0
 
virtual void SetDepth (unsigned int depth)=0
 
virtual void SetWidth (unsigned int width)=0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const char * GetNameOfClass () 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
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () 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
 

Additional Inherited Members

- 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)
 
- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Member Typedef Documentation

Definition at line 60 of file itkOctree.h.

Standard class typedefs.

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