ITK  5.2.0
Insight 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:

Public Types

using OctreeEnum = OctreeEnums::Octree
 
using Pointer = SmartPointer< Self >
 
using Self = OctreeBase
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual void BuildFromBuffer (const void *buffer, const unsigned int xsize, const unsigned int ysize, const unsigned int zsize)=0
 
virtual const OctreeNodeBranchGetColorTable () 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
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

Provides non-templated access to templated instances of Octree.

Definition at line 40 of file itkOctree.h.

Member Typedef Documentation

◆ OctreeEnum

Definition at line 48 of file itkOctree.h.

◆ Pointer

Definition at line 46 of file itkOctree.h.

◆ Self

Standard class type aliases.

Definition at line 45 of file itkOctree.h.

Member Function Documentation

◆ BuildFromBuffer()

virtual void itk::OctreeBase::BuildFromBuffer ( const void *  buffer,
const unsigned int  xsize,
const unsigned int  ysize,
const unsigned 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 >.

◆ GetColorTable()

virtual const OctreeNodeBranch* itk::OctreeBase::GetColorTable ( ) const
pure virtual

Get the ColorTable Pointer

Returns color table pointer for this tree.

Each Octree has an array of OctreeNodeBranch 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 >.

◆ GetColorTableSize()

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

Get the size of the Color Table

Implemented in itk::Octree< TPixel, ColorTableSize, MappingFunctionType >.

◆ GetDepth()

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

◆ GetTree()

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

◆ GetWidth()

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

◆ SetDepth()

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

◆ SetWidth()

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: