organize data according to scalar values (used to accelerate contouring operations) More...

#include <vtkSimpleScalarTree.h>

Inheritance diagram for vtkSimpleScalarTree:

Collaboration diagram for vtkSimpleScalarTree:

Public Member Functions
virtual void	BuildTree ()

virtual void	Initialize ()

virtual void	InitTraversal (double scalarValue)

virtual vtkIdType	GetNumberOfCellBatches ()


virtual void	SetBranchingFactor (int)

virtual int	GetBranchingFactor ()


virtual int	GetLevel ()


virtual void	SetMaxLevel (int)

virtual int	GetMaxLevel ()


virtual vtkCell *	GetNextCell (vtkIdType &cellId, vtkIdList &ptIds, vtkDataArray cellScalars)


virtual const vtkIdType *	GetCellBatch (vtkIdType batchNum, vtkIdType &numCells)

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

virtual void	SetDataSet (vtkDataSet *)

virtual vtkDataSet *	GetDataSet ()

virtual void	SetScalars (vtkDataArray *)

virtual vtkDataArray *	GetScalars ()

double	GetScalarValue ()

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkSimpleScalarTree *	New ()

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

static vtkScalarTree *	SafeDownCast (vtkObjectBase *o)

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

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
	vtkSimpleScalarTree ()

	~vtkSimpleScalarTree ()

Protected Member Functions inherited from vtkScalarTree
	vtkScalarTree ()

	~vtkScalarTree ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

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	MaxLevel

int	Level

int	BranchingFactor

vtkScalarNode *	Tree

int	TreeSize

vtkIdType	LeafOffset

Protected Attributes inherited from vtkScalarTree
vtkDataSet *	DataSet

vtkDataArray *	Scalars

double	ScalarValue

vtkTimeStamp	BuildTime

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkScalarTree	Superclass

static int	IsTypeOf (const char *type)

static vtkSimpleScalarTree *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkSimpleScalarTree *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Additional Inherited Members
Public Types inherited from vtkScalarTree
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Detailed Description

organize data according to scalar values (used to accelerate contouring operations)

vtkSimpleScalarTree creates a pointerless binary tree that helps search for cells that lie within a particular scalar range. This object is used to accelerate some contouring (and other scalar-based techniques).

The tree consists of an array of (min,max) scalar range pairs per node in the tree. The (min,max) range is determined from looking at the range of the children of the tree node. If the node is a leaf, then the range is determined by scanning the range of scalar data in n cells in the dataset. The n cells are determined by arbitrary selecting cell ids from id(i) to id(i+n), and where n is specified using the BranchingFactor ivar. Note that leaf node i=0 contains the scalar range computed from cell ids (0,n-1); leaf node i=1 contains the range from cell ids (n,2n-1); and so on. The implication is that there are no direct lists of cell ids per leaf node, instead the cell ids are implicitly known. Despite the arbitrary grouping of cells, in practice this scalar tree actually performs quite well due to spatial/data coherence.

This class has an API that supports both serial and parallel operation. The parallel API enables the using class to grab arrays (or batches) of cells that potentially intersect the isocontour. These batches can then be processed in separate threads.

See also: vtkSpanSpace

Tests:: vtkSimpleScalarTree (Tests)

Definition at line 59 of file vtkSimpleScalarTree.h.

Member Typedef Documentation

typedef vtkScalarTree vtkSimpleScalarTree::Superclass

Standard type related macros and PrintSelf() method.

Definition at line 68 of file vtkSimpleScalarTree.h.

Constructor & Destructor Documentation

vtkSimpleScalarTree::vtkSimpleScalarTree ( )

protected

vtkSimpleScalarTree::~vtkSimpleScalarTree ( )

protected

Member Function Documentation

static vtkSimpleScalarTree* vtkSimpleScalarTree::New ( )

static

Instantiate scalar tree with maximum level of 20 and branching factor of three.

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

static

Standard type related macros and PrintSelf() method.

virtual int vtkSimpleScalarTree::IsA ( const char * type )

virtual

Standard type related macros and PrintSelf() method.

Reimplemented from vtkScalarTree.

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

static

Standard type related macros and PrintSelf() method.

virtual vtkObjectBase* vtkSimpleScalarTree::NewInstanceInternal ( ) const

protectedvirtual

Standard type related macros and PrintSelf() method.

Reimplemented from vtkScalarTree.

vtkSimpleScalarTree* vtkSimpleScalarTree::NewInstance ( ) const

Standard type related macros and PrintSelf() method.

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

virtual

Standard type related macros and PrintSelf() method.

Reimplemented from vtkScalarTree.

virtual void vtkSimpleScalarTree::SetBranchingFactor ( int )

virtual

Set the branching factor for the tree. This is the number of children per tree node. Smaller values (minimum is 2) mean deeper trees and more memory overhead. Larger values mean shallower trees, less memory usage, but worse performance.

virtual int vtkSimpleScalarTree::GetBranchingFactor ( )

virtual

Set the branching factor for the tree. This is the number of children per tree node. Smaller values (minimum is 2) mean deeper trees and more memory overhead. Larger values mean shallower trees, less memory usage, but worse performance.

virtual int vtkSimpleScalarTree::GetLevel ( )

virtual

Get the level of the scalar tree. This value may change each time the scalar tree is built and the branching factor changes.

virtual void vtkSimpleScalarTree::SetMaxLevel ( int )

virtual

Set the maximum allowable level for the tree.

virtual int vtkSimpleScalarTree::GetMaxLevel ( )

virtual

Set the maximum allowable level for the tree.

virtual void vtkSimpleScalarTree::BuildTree ( )

virtual

Construct the scalar tree from the dataset provided. Checks build times and modified time from input and reconstructs the tree if necessary.

Implements vtkScalarTree.

virtual void vtkSimpleScalarTree::Initialize ( )

virtual

Initialize locator. Frees memory and resets object as appropriate.

Implements vtkScalarTree.

virtual void vtkSimpleScalarTree::InitTraversal ( double scalarValue )

virtual

Begin to traverse the cells based on a scalar value. Returned cells will likely have scalar values that span the scalar value specified.

Implements vtkScalarTree.

virtual vtkCell* vtkSimpleScalarTree::GetNextCell	(	vtkIdType &	cellId,
		vtkIdList *&	ptIds,
		vtkDataArray *	cellScalars
	)

virtual

Return the next cell that may contain scalar value specified to initialize traversal. The value NULL is returned if the list is exhausted. Make sure that InitTraversal() has been invoked first or you'll get erratic behavior.

Implements vtkScalarTree.

virtual vtkIdType vtkSimpleScalarTree::GetNumberOfCellBatches ( )

virtual

Get the number of cell batches available for processing. Note that this methods should be called after InitTraversal(). This is because the number of batches available is typically a function of the isocontour value. Note that the cells found in [0...(NumberOfCellBatches-1)] will contain all the cells potentially containing the isocontour.

Implements vtkScalarTree.

virtual const vtkIdType* vtkSimpleScalarTree::GetCellBatch	(	vtkIdType	batchNum,
		vtkIdType &	numCells
	)

virtual

Return the array of cell ids in the specified batch. The method also returns the number of cell ids in the array. Make sure to call InitTraversal() beforehand.

Implements vtkScalarTree.

Member Data Documentation

int vtkSimpleScalarTree::MaxLevel

protected

Definition at line 139 of file vtkSimpleScalarTree.h.

int vtkSimpleScalarTree::Level

protected

Definition at line 140 of file vtkSimpleScalarTree.h.

int vtkSimpleScalarTree::BranchingFactor

protected

Definition at line 141 of file vtkSimpleScalarTree.h.

vtkScalarNode* vtkSimpleScalarTree::Tree

protected

Definition at line 142 of file vtkSimpleScalarTree.h.

int vtkSimpleScalarTree::TreeSize

protected

Definition at line 143 of file vtkSimpleScalarTree.h.

vtkIdType vtkSimpleScalarTree::LeafOffset

protected

Definition at line 144 of file vtkSimpleScalarTree.h.

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

dox/Common/ExecutionModel/vtkSimpleScalarTree.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation