A dataset structured as a tree where each node has exactly 2^n children. More...

#include <vtkHyperOctree.h>

Inheritance diagram for vtkHyperOctree:

Collaboration diagram for vtkHyperOctree:

Public Types
typedef vtkDataSet	Superclass

Public Types inherited from vtkDataSet
enum	FieldDataType { DATA_OBJECT_FIELD =0, POINT_DATA_FIELD =1, CELL_DATA_FIELD =2 }

typedef vtkDataObject	Superclass

Public Types inherited from vtkDataObject
enum	FieldAssociations { FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS, FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS }
	Possible values for the FIELD_ASSOCIATION information entry. More...

enum	AttributeTypes { POINT, CELL, FIELD, POINT_THEN_CELL, VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES }
	Possible attribute types. More...

enum	FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
	Possible values for the FIELD_OPERATION information entry. More...

typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkHyperOctree *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

int	GetDataObjectType () override
	Return what type of dataset this is. More...

void	CopyStructure (vtkDataSet *ds) override
	Copy the geometric and topological structure of an input rectilinear grid object. More...

int	GetDimension ()
	Return the dimension of the tree (1D:binary tree(2 children), 2D:quadtree(4 children), 3D:octree (8 children)) More...

void	SetDimension (int dim)
	Set the dimension of the tree with `dim'. More...

vtkIdType	GetNumberOfCells () override
	Return the number of cells in the dual grid. More...

vtkIdType	GetNumberOfLeaves ()
	Get the number of leaves in the tree. More...

vtkIdType	GetNumberOfPoints () override
	Return the number of points in the dual grid. More...

vtkIdType	GetMaxNumberOfPoints (int level)
	Return the number of points corresponding to an hyperoctree starting at level `level' where all the leaves at at the last level. More...

vtkIdType	GetMaxNumberOfPointsOnBoundary (int level)
	Return the number of points corresponding to the boundary of an hyperoctree starting at level `level' where all the leaves at at the last level. More...

vtkIdType	GetMaxNumberOfCellsOnBoundary (int level)
	Return the number of cells corresponding to the boundary of a cell of level `level' where all the leaves at at the last level. More...

vtkIdType	GetNumberOfLevels ()
	Return the number of levels. More...

vtkHyperOctreeCursor *	NewCellCursor ()
	Create a new cursor: an object that can traverse the cell of an hyperoctree. More...

void	SubdivideLeaf (vtkHyperOctreeCursor *leaf)
	Subdivide node pointed by cursor, only if its a leaf. More...

void	CollapseTerminalNode (vtkHyperOctreeCursor *node)
	Collapse a node for which all children are leaves. More...

double *	GetPoint (vtkIdType ptId) override
	Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints. More...

void	GetPoint (vtkIdType id, double x[3]) override
	Copy point coordinates into user provided array x[3] for specified point id. More...

vtkCell *	GetCell (vtkIdType cellId) override
	Get cell with cellId such that: 0 <= cellId < NumberOfCells. More...

void	GetCell (vtkIdType cellId, vtkGenericCell *cell) override
	Get cell with cellId such that: 0 <= cellId < NumberOfCells. More...

int	GetCellType (vtkIdType cellId) override
	Get type of cell with cellId such that: 0 <= cellId < NumberOfCells. More...

void	GetPointCells (vtkIdType ptId, vtkIdList *cellIds) override
	Topological inquiry to get cells using point. More...

void	GetCellNeighbors (vtkIdType cellId, vtkIdList ptIds, vtkIdList cellIds) override
	Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId). More...

vtkIdType	FindPoint (double x[3]) override
	Locate the closest point to the global coordinate x. More...

vtkIdType	FindCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights) override
	Locate cell based on global coordinate x and tolerance squared. More...

vtkIdType	FindCell (double x[3], vtkCell cell, vtkGenericCell gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
	This is a version of the above method that can be used with multithreaded applications. More...

void	Initialize () override
	Restore data object to initial state, THIS METHOD IS NOT THREAD SAFE. More...

int	GetMaxCellSize () override
	Convenience method returns largest cell size in dataset. More...

void	GetPointsOnFace (vtkHyperOctreeCursor sibling, int face, int level, vtkHyperOctreePointsGrabber grabber)
	Get the points of node `sibling' on its face `face'. More...

void	GetPointsOnParentFaces (int faces[3], int level, vtkHyperOctreeCursor cursor, vtkHyperOctreePointsGrabber grabber)
	Get the points of the parent node of `cursor' on its faces `faces' at level `level' or deeper. More...

void	GetPointsOnEdge (vtkHyperOctreeCursor sibling, int level, int axis, int k, int j, vtkHyperOctreePointsGrabber grabber)
	Get the points of node `sibling' on its edge `axis','k','j'. More...

void	GetPointsOnParentEdge (vtkHyperOctreeCursor cursor, int level, int axis, int k, int j, vtkHyperOctreePointsGrabber grabber)
	Get the points of the parent node of `cursor' on its edge `axis','k','j' at level `level' or deeper. More...

void	GetPointsOnEdge2D (vtkHyperOctreeCursor sibling, int edge, int level, vtkHyperOctreePointsGrabber grabber)
	Get the points of node `sibling' on its edge `edge'. More...

void	GetPointsOnParentEdge2D (vtkHyperOctreeCursor cursor, int edge, int level, vtkHyperOctreePointsGrabber grabber)
	Get the points of the parent node of `cursor' on its edge `edge' at level `level' or deeper. More...

vtkDataSetAttributes *	GetLeafData ()
	A generic way to set the leaf data attributes. More...

unsigned long	GetActualMemorySize () override
	Return the actual size of the data in kibibytes (1024 bytes). More...


virtual void	SetSize (double, double, double)
	Set the size on each axis. More...

virtual void	SetSize (double[3])
	Set the size on each axis. More...


virtual double *	GetSize ()
	Return the size on each axis. More...

virtual void	GetSize (double &, double &, double &)
	Return the size on each axis. More...

virtual void	GetSize (double[3])
	Return the size on each axis. More...


virtual void	SetOrigin (double, double, double)
	Set the origin (position of corner (0,0,0) of the root. More...

virtual void	SetOrigin (double[3])
	Set the origin (position of corner (0,0,0) of the root. More...

virtual double *	GetOrigin ()
	Set the origin (position of corner (0,0,0) of the root. More...

virtual void	GetOrigin (double &, double &, double &)
	Set the origin (position of corner (0,0,0) of the root. More...

virtual void	GetOrigin (double[3])
	Set the origin (position of corner (0,0,0) of the root. More...


void	GetCellPoints (vtkIdType cellId, vtkIdList *ptIds) override
	Topological inquiry to get points defining cell. More...

virtual void	GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType *&pts)
	Topological inquiry to get points defining cell. More...


void	ShallowCopy (vtkDataObject *src) override
	Shallow and Deep copy. More...

void	DeepCopy (vtkDataObject *src) override
	Shallow and Deep copy. More...


void	SetDualGridFlag (int flag)
	Switch between returning leaves as cells, or the dual grid. More...

virtual int	GetDualGridFlag ()
	Switch between returning leaves as cells, or the dual grid. More...

Public Member Functions inherited from vtkDataSet
vtkDataSet *	NewInstance () const

virtual void	CopyAttributes (vtkDataSet *ds)
	Copy the attributes associated with the specified dataset to this instance of vtkDataSet. More...

virtual vtkCellIterator *	NewCellIterator ()
	Return an iterator that traverses the cells in this data set. More...

virtual void	GetCellBounds (vtkIdType cellId, double bounds[6])
	Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells. More...

virtual void	GetCellTypes (vtkCellTypes *types)
	Get a list of types of cells in a dataset. More...

virtual vtkCell *	FindAndGetCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights)
	Locate the cell that contains a point and return the cell. More...

vtkMTimeType	GetMTime () override
	Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE. More...

vtkCellData *	GetCellData ()
	Return a pointer to this dataset's cell data. More...

vtkPointData *	GetPointData ()
	Return a pointer to this dataset's point data. More...

virtual void	Squeeze ()
	Reclaim any extra memory used to store data. More...

double *	GetBounds ()
	Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...

void	GetBounds (double bounds[6])
	Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...

double *	GetCenter ()
	Get the center of the bounding box. More...

void	GetCenter (double center[3])
	Get the center of the bounding box. More...

double	GetLength ()
	Return the length of the diagonal of the bounding box. More...

virtual void	GetScalarRange (double range[2])
	Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. More...

double *	GetScalarRange ()
	Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. More...

int	CheckAttributes ()
	This method checks to see if the cell and point attributes match the geometry. More...

vtkFieldData *	GetAttributesAsFieldData (int type) override
	Returns the attributes of the data object as a vtkFieldData. More...

vtkIdType	GetNumberOfElements (int type) override
	Get the number of elements for a specific attribute type (POINT, CELL, etc.). More...

bool	HasAnyGhostCells ()
	Returns 1 if there are any ghost cells 0 otherwise. More...

bool	HasAnyGhostPoints ()
	Returns 1 if there are any ghost points 0 otherwise. More...

virtual bool	HasAnyBlankCells ()
	Returns 1 if there are any blanking cells 0 otherwise. More...

virtual bool	HasAnyBlankPoints ()
	Returns 1 if there are any blanking points 0 otherwise. More...

vtkUnsignedCharArray *	GetPointGhostArray ()
	Gets the array that defines the ghost type of each point. More...

void	UpdatePointGhostArrayCache ()
	Updates the pointer to the point ghost array. More...

vtkUnsignedCharArray *	AllocatePointGhostArray ()
	Allocate ghost array for points. More...

vtkUnsignedCharArray *	GetCellGhostArray ()
	Get the array that defines the ghost type of each cell. More...

void	UpdateCellGhostArrayCache ()
	Updates the pointer to the cell ghost array. More...

vtkUnsignedCharArray *	AllocateCellGhostArray ()
	Allocate ghost array for cells. More...

vtkIdType	FindPoint (double x, double y, double z)
	Locate the closest point to the global coordinate x. More...

virtual void	GenerateGhostArray (int zeroExt[6])
	Normally called by pipeline executives or algoritms only. More...

virtual void	GenerateGhostArray (int zeroExt[6], bool cellOnly)
	Normally called by pipeline executives or algoritms only. More...

Public Member Functions inherited from vtkDataObject
vtkDataObject *	NewInstance () const

void	ReleaseData ()
	Release data back to system to conserve memory resource. More...

vtkMTimeType	GetUpdateTime ()
	Used by Threaded ports to determine if they should initiate an asynchronous update (still in development). More...

virtual void	CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
	Copy from the pipeline information to the data object's own information. More...

virtual void	CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
	Copy information from this data object to the pipeline information. More...

void	DataHasBeenGenerated ()
	This method is called by the source when it executes to generate data. More...

virtual void	PrepareForNewData ()
	make the output data ready for new data to be inserted. More...

virtual int	GetExtentType ()
	The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid. More...

virtual void	Crop (const int *updateExtent)
	This method crops the data object (if necessary) so that the extent matches the update extent. More...

virtual vtkDataSetAttributes *	GetAttributes (int type)
	Returns the attributes of the data object of the specified attribute type. More...

virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)
	Retrieves the attribute type that an array came from. More...

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this data object. More...

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this data object. More...

virtual int	GetDataReleased ()
	Get the flag indicating the data has been released. More...

virtual void	SetFieldData (vtkFieldData *)
	Assign or retrieve a general field data to this data object. More...

virtual vtkFieldData *	GetFieldData ()
	Assign or retrieve a general field data to this data object. More...

void	GlobalReleaseDataFlagOn ()
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...

void	GlobalReleaseDataFlagOff ()
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkInformationIntegerKey *	LEVELS ()

static vtkInformationIntegerKey *	DIMENSION ()

static vtkInformationDoubleVectorKey *	SIZES ()

static vtkHyperOctree *	New ()

static int	IsTypeOf (const char *type)

static vtkHyperOctree *	SafeDownCast (vtkObjectBase *o)


static vtkHyperOctree *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object. More...

static vtkHyperOctree *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object. More...

Static Public Member Functions inherited from vtkDataSet
static int	IsTypeOf (const char *type)

static vtkDataSet *	SafeDownCast (vtkObjectBase *o)

static vtkDataSet *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object. More...

static vtkDataSet *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object. More...

Static Public Member Functions inherited from vtkDataObject
static vtkDataObject *	New ()

static int	IsTypeOf (const char *type)

static vtkDataObject *	SafeDownCast (vtkObjectBase *o)

static vtkInformation *	GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) More...

static vtkInformation *	GetNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name. More...

static void	RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Remove the info associated with an array. More...

static vtkInformation *	SetActiveAttribute (vtkInformation info, int fieldAssociation, const char attributeName, int attributeType)
	Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...

static void	SetActiveAttributeInfo (vtkInformation info, int fieldAssociation, int attributeType, const char name, int arrayType, int numComponents, int numTuples)
	Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...

static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
	Convenience version of previous method for use (primarily) by the Imaging filters. More...

static const char *	GetAssociationTypeAsString (int associationType)
	Given an integer association type, this static method returns a string type for the attribute (i.e. More...

static int	GetAssociationTypeFromString (const char *associationType)
	Given an integer association type, this static method returns a string type for the attribute (i.e. More...

static vtkInformationStringKey *	DATA_TYPE_NAME ()

static vtkInformationDataObjectKey *	DATA_OBJECT ()

static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()

static vtkInformationIntegerPointerKey *	DATA_EXTENT ()

static vtkInformationIntegerVectorKey *	ALL_PIECES_EXTENT ()

static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()

static vtkInformationDoubleKey *	DATA_TIME_STEP ()

static vtkInformationInformationVectorKey *	POINT_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	CELL_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	VERTEX_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	EDGE_DATA_VECTOR ()

static vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()

static vtkInformationIntegerKey *	FIELD_ASSOCIATION ()

static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()

static vtkInformationIntegerKey *	FIELD_ACTIVE_ATTRIBUTE ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()

static vtkInformationIntegerKey *	FIELD_OPERATION ()

static vtkInformationDoubleVectorKey *	FIELD_RANGE ()

static vtkInformationIntegerVectorKey *	PIECE_EXTENT ()

static vtkInformationStringKey *	FIELD_NAME ()

static vtkInformationDoubleVectorKey *	ORIGIN ()

static vtkInformationDoubleVectorKey *	SPACING ()

static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()

static vtkInformationDataObjectKey *	SIL ()

static vtkDataObject *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object. More...

static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object. More...

static void	SetGlobalReleaseDataFlag (int val)
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...

static int	GetGlobalReleaseDataFlag ()
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkHyperOctree ()

	~vtkHyperOctree () override

void	ComputeBounds () override
	Compute the data bounding box from data points. More...

void	UpdateDualArrays ()

vtkPoints *	GetLeafCenters ()

vtkIdTypeArray *	GetCornerLeafIds ()

void	UpdateGridArrays ()

vtkPoints *	GetCornerPoints ()

vtkIdTypeArray *	GetLeafCornerIds ()

void	DeleteInternalArrays ()

void	TraverseDualRecursively (vtkHyperOctreeLightWeightCursor neighborhood, unsigned short xyzIds, int level)

void	TraverseGridRecursively (vtkHyperOctreeLightWeightCursor neighborhood, unsigned char visited, double origin, double size)

void	EvaluateDualCorner (vtkHyperOctreeLightWeightCursor *neighborhood)

vtkIdType	EvaluateGridCorner (int level, vtkHyperOctreeLightWeightCursor neighborhood, unsigned char visited, int *cornerNeighborIds)

void	GenerateGridNeighborhoodTraversalTable ()

void	GenerateDualNeighborhoodTraversalTable ()

void	BuildLinks ()

vtkIdType	RecursiveFindPoint (double x[3], vtkHyperOctreeLightWeightCursor cursor, double origin, double *size)

Protected Member Functions inherited from vtkDataSet
	vtkDataSet ()

	~vtkDataSet () override

virtual void	ComputeScalarRange ()
	Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (ScalarRangeComputeTime). More...

bool	IsAnyBitSet (vtkUnsignedCharArray *a, int bitFlag)
	Helper function that tests if any of the values in 'a' have bitFlag set. More...

Protected Member Functions inherited from vtkDataObject
	vtkDataObject ()

	~vtkDataObject () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	Dimension

double	Size [3]

double	Origin [3]

vtkHyperOctreeInternal *	CellTree

vtkHyperOctreeCursor *	TmpChild

vtkPoints *	LeafCenters

vtkIdTypeArray *	CornerLeafIds

vtkPoints *	CornerPoints

vtkIdTypeArray *	LeafCornerIds

int	NeighborhoodTraversalTable [216]

vtkLine *	Line

vtkPixel *	Pixel

vtkVoxel *	Voxel

vtkCellLinks *	Links

int	DualGridFlag

Protected Attributes inherited from vtkDataSet
vtkCellData *	CellData

vtkPointData *	PointData

vtkCallbackCommand *	DataObserver

vtkTimeStamp	ComputeTime

double	Bounds [6]

double	Center [3]

double	ScalarRange [2]

vtkTimeStamp	ScalarRangeComputeTime

vtkUnsignedCharArray *	PointGhostArray
	These arrays pointers are caches used to avoid a string comparision (when getting ghost arrays using GetArray(name)) More...

vtkUnsignedCharArray *	CellGhostArray
	These arrays pointers are caches used to avoid a string comparision (when getting ghost arrays using GetArray(name)) More...

bool	PointGhostArrayCached
	These arrays pointers are caches used to avoid a string comparision (when getting ghost arrays using GetArray(name)) More...

bool	CellGhostArrayCached
	These arrays pointers are caches used to avoid a string comparision (when getting ghost arrays using GetArray(name)) More...

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

int	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkHyperOctreeLightWeightCursor

Detailed Description

A dataset structured as a tree where each node has exactly 2^n children.

An hyperoctree is a dataset where each node has either exactly 2^n children or no child at all if the node is a leaf. `n' is the dimension of the dataset (1 (binary tree), 2 (quadtree) or 3 (octree) ). The class name comes from the following paper:

* @ARTICLE{yau-srihari-1983,
*  author={Mann-May Yau and Sargur N. Srihari},
*  title={A Hierarchical Data Structure for Multidimensional Digital Images},
*  journal={Communications of the ACM},
*  month={July},
*  year={1983},
*  volume={26},
*  number={7},
*  pages={504--515}
*  }
*

Each node is a cell. Attributes are associated with cells, not with points. The geometry is implicitly given by the size of the root node on each axis and position of the center and the orientation. (TODO: review center position and orientation). The geometry is then not limited to an hybercube but can have a rectangular shape. Attributes are associated with leaves. For LOD (Level-Of-Detail) purpose, attributes can be computed on none-leaf nodes by computing the average values from its children (which can be leaves or not).

By construction, an hyperoctree is efficient in memory usage when the geometry is sparse. The LOD feature allows to cull quickly part of the dataset.

A couple of filters can be applied on this dataset: contour, outline, geometry.

3D case (octree) for each node, each child index (from 0 to 7) is encoded in the following orientation. It is easy to access each child as a cell of a grid. Note also that the binary representation is relevant, each bit code a side: bit 0 encodes -x side (0) or +x side (1) bit 1 encodes -y side (0) or +y side (1) bit 2 encodes -z side (0) or +z side (2)
the -z side first
0: -y -x sides
1: -y +x sides
2: +y -x sides

3: +y +x sides

*              +y
* +-+-+        ^
* |2|3|        |
* +-+-+  O +z  +-> +x
* |0|1|
* +-+-+
*

then the +z side, in counter-clockwise
4: -y -x sides
5: -y +x sides
6: +y -x sides

7: +y +x sides

*              +y
* +-+-+        ^
* |6|7|        |
* +-+-+  O +z  +-> +x
* |4|5|
* +-+-+
*

The cases with fewer dimensions are consistent with the octree case:

Quadtree: in counter-clockwise
0: -y -x edges
1: -y +x edges
2: +y -x edges

3: +y +x edges

*         +y
* +-+-+   ^
* |2|3|   |
* +-+-+  O+-> +x
* |0|1|
* +-+-+
*

Binary tree:
```
* +0+1+  O+-> +x
* 
```

Warning: It is not a spatial search object! If you looking for this kind of octree see vtkCellLocator instead.

See also: vtkHyperOctreeAlgorithm

Definition at line 143 of file vtkHyperOctree.h.

Member Typedef Documentation

typedef vtkDataSet vtkHyperOctree::Superclass

Definition at line 151 of file vtkHyperOctree.h.

Constructor & Destructor Documentation

vtkHyperOctree::vtkHyperOctree ( )

protected

vtkHyperOctree::~vtkHyperOctree ( )

overrideprotected

Member Function Documentation

static vtkInformationIntegerKey* vtkHyperOctree::LEVELS ( )

static

static vtkInformationIntegerKey* vtkHyperOctree::DIMENSION ( )

static

static vtkInformationDoubleVectorKey* vtkHyperOctree::SIZES ( )

static

static vtkHyperOctree* vtkHyperOctree::New ( )

static

static int vtkHyperOctree::IsTypeOf ( const char * type )

static

virtual int vtkHyperOctree::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSet.

static vtkHyperOctree* vtkHyperOctree::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkHyperOctree::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataSet.

vtkHyperOctree* vtkHyperOctree::NewInstance ( ) const

void vtkHyperOctree::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDataSet.

int vtkHyperOctree::GetDataObjectType ( )

overridevirtual

Return what type of dataset this is.

Reimplemented from vtkDataSet.

void vtkHyperOctree::CopyStructure ( vtkDataSet * ds )

overridevirtual

Copy the geometric and topological structure of an input rectilinear grid object.

Implements vtkDataSet.

int vtkHyperOctree::GetDimension ( )

Return the dimension of the tree (1D:binary tree(2 children), 2D:quadtree(4 children), 3D:octree (8 children))

Postcondition: valid_result: result>=1 && result<=3

void vtkHyperOctree::SetDimension ( int dim )

Set the dimension of the tree with `dim'.

See GetDimension() for details.

Precondition: valid_dim: dim>=1 && dim<=3

Postcondition: dimension_is_set: GetDimension()==dim

vtkIdType vtkHyperOctree::GetNumberOfCells ( )

overridevirtual

Return the number of cells in the dual grid.

Postcondition: positive_result: result>=0

Implements vtkDataSet.

vtkIdType vtkHyperOctree::GetNumberOfLeaves ( )

Get the number of leaves in the tree.

vtkIdType vtkHyperOctree::GetNumberOfPoints ( )

overridevirtual

Return the number of points in the dual grid.

Postcondition: positive_result: result>=0

Implements vtkDataSet.

vtkIdType vtkHyperOctree::GetMaxNumberOfPoints ( int level )

Return the number of points corresponding to an hyperoctree starting at level `level' where all the leaves at at the last level.

In this case, the hyperoctree is like a uniform grid. So this number is the number of points of the uniform grid.

Precondition: positive_level: level>=0 && level<this->GetNumberOfLevels()

Postcondition: definition: result==(2^(GetNumberOfLevels()-level-1)+1)^GetDimension()

vtkIdType vtkHyperOctree::GetMaxNumberOfPointsOnBoundary ( int level )

Return the number of points corresponding to the boundary of an hyperoctree starting at level `level' where all the leaves at at the last level.

In this case, the hyperoctree is like a uniform grid. So this number is the number of points of on the boundary of the uniform grid. For an octree, the boundary are the faces. For a quadtree, the boundary are the edges.

Precondition: 2d_or_3d: this->GetDimension()==2 || this->GetDimension()==3; positive_level: level>=0 && level<this->GetNumberOfLevels()

Postcondition: min_result: result>=GetMaxNumberOfPoints(this->GetNumberOfLevels()-1); max_result: result<=GetMaxNumberOfPoints(level)

vtkIdType vtkHyperOctree::GetMaxNumberOfCellsOnBoundary ( int level )

Return the number of cells corresponding to the boundary of a cell of level `level' where all the leaves at at the last level.

Precondition: positive_level: level>=0 && level<this->GetNumberOfLevels()

Postcondition: positive_result: result>=0

vtkIdType vtkHyperOctree::GetNumberOfLevels ( )

Return the number of levels.

Postcondition: result_greater_or_equal_to_one: result>=1

virtual void vtkHyperOctree::SetSize	(	double	,
		double	,
		double
	)

virtual

Set the size on each axis.

virtual void vtkHyperOctree::SetSize ( double [3] )

virtual

Set the size on each axis.

virtual double* vtkHyperOctree::GetSize ( )

virtual

Return the size on each axis.

virtual void vtkHyperOctree::GetSize	(	double &	,
		double &	,
		double &
	)

virtual

Return the size on each axis.

virtual void vtkHyperOctree::GetSize ( double [3] )

virtual

Return the size on each axis.

virtual void vtkHyperOctree::SetOrigin	(	double	,
		double	,
		double
	)

virtual