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
void	ShallowCopy (vtkScalarTree *stree) override
	This method is used to copy data members when cloning an instance of the class.

void	BuildTree () override
	Construct the scalar tree from the dataset provided.

void	Initialize () override
	Initialize locator.

void	InitTraversal (double scalarValue) override
	Begin to traverse the cells based on a scalar value.

vtkCell *	GetNextCell (vtkIdType &cellId, vtkIdList &ptIds, vtkDataArray cellScalars) override
	Return the next cell that may contain scalar value specified to initialize traversal.

vtkIdType	GetNumberOfCellBatches (double scalarValue) override
	Get the number of cell batches available for processing as a function of the specified scalar value.

const vtkIdType *	GetCellBatch (vtkIdType batchNum, vtkIdType &numCells) override
	Return the array of cell ids in the specified batch.


virtual void	SetBranchingFactor (int)
	Set the branching factor for the tree.

virtual int	GetBranchingFactor ()
	Set the branching factor for the tree.


virtual int	GetLevel ()
	Get the level of the scalar tree.


virtual void	SetMaxLevel (int)
	Set the maximum allowable level for the tree.

virtual int	GetMaxLevel ()
	Set the maximum allowable level for the tree.

Public Member Functions inherited from vtkScalarTree
virtual void	ShallowCopy (vtkScalarTree *stree)
	This method is used to copy data members when cloning an instance of the class.

virtual void	BuildTree ()=0
	Construct the scalar tree from the dataset provided.

virtual void	Initialize ()=0
	Initialize locator.

virtual void	InitTraversal (double scalarValue)=0
	Begin to traverse the cells based on a scalar value (serial traversal).

virtual vtkCell *	GetNextCell (vtkIdType &cellId, vtkIdList &ptIds, vtkDataArray cellScalars)=0
	Return the next cell that may contain scalar value specified to InitTraversal() (serial traversal).

double	GetScalarValue ()
	Return the current scalar value over which tree traversal is proceeding.

virtual vtkIdType	GetNumberOfCellBatches (double scalarValue)=0
	Get the number of cell batches available for processing as a function of the specified scalar value.

virtual const vtkIdType *	GetCellBatch (vtkIdType batchNum, vtkIdType &numCells)=0
	Return the array of cell ids in the specified batch.

virtual void	SetDataSet (vtkDataSet *)
	Build the tree from the points/cells and scalars defining this dataset.

virtual vtkDataSet *	GetDataSet ()
	Build the tree from the points/cells and scalars defining this dataset.

virtual void	SetScalars (vtkDataArray *)
	Build the tree from the points/cells and scalars defining the dataset and scalars provided.

virtual vtkDataArray *	GetScalars ()
	Build the tree from the points/cells and scalars defining the dataset and scalars provided.

vtkScalarTree *	NewInstance () const
	Standard type related macros and PrintSelf() method.

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

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

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

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

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

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

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

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

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

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

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

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

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

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

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

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

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.

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.

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.

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

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

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

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

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

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

void	InitializeObjectBase ()

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

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

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

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

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

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

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

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkSimpleScalarTree *	New ()
	Instantiate scalar tree with maximum level of 20 and branching factor of three.

Static Public Member Functions inherited from vtkScalarTree
static vtkTypeBool	IsTypeOf (const char *type)
	Standard type related macros and PrintSelf() method.

static vtkScalarTree *	SafeDownCast (vtkObjectBase *o)
	Standard type related macros and PrintSelf() method.

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.

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

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

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

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

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

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

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

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
	vtkSimpleScalarTree ()

	~vtkSimpleScalarTree () override

Protected Member Functions inherited from vtkScalarTree
	vtkScalarTree ()

	~vtkScalarTree () 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=nullptr)
	These methods allow a command to exclusively grab all events.

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

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	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

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkScalarTree	Superclass
	Standard type related macros and PrintSelf() method.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard type related macros and PrintSelf() method.

static vtkSimpleScalarTree *	SafeDownCast (vtkObjectBase *o)
	Standard type related macros and PrintSelf() method.

virtual vtkTypeBool	IsA (const char *type)
	Standard type related macros and PrintSelf() method.

vtkSimpleScalarTree *	NewInstance () const
	Standard type related macros and PrintSelf() method.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard type related macros and PrintSelf() method.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard type related macros and PrintSelf() method.

Additional Inherited Members
Public Types inherited from vtkScalarTree
typedef vtkObject	Superclass
	Standard type related macros and PrintSelf() method.

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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: vtkScalarTree vtkSpanSpace

Tests:: vtkSimpleScalarTree (Tests)

Definition at line 48 of file vtkSimpleScalarTree.h.

Member Typedef Documentation

◆ Superclass

typedef vtkScalarTree vtkSimpleScalarTree::Superclass

Standard type related macros and PrintSelf() method.

Definition at line 61 of file vtkSimpleScalarTree.h.

Constructor & Destructor Documentation

◆ vtkSimpleScalarTree()

vtkSimpleScalarTree::vtkSimpleScalarTree ( )

protected

◆ ~vtkSimpleScalarTree()

vtkSimpleScalarTree::~vtkSimpleScalarTree ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSimpleScalarTree * vtkSimpleScalarTree::New ( )

static

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

◆ IsTypeOf()

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

static

Standard type related macros and PrintSelf() method.

◆ IsA()

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

virtual

Standard type related macros and PrintSelf() method.

Reimplemented from vtkScalarTree.

◆ SafeDownCast()

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

static

Standard type related macros and PrintSelf() method.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkSimpleScalarTree::NewInstanceInternal ( ) const

protectedvirtual

Standard type related macros and PrintSelf() method.

Reimplemented from vtkScalarTree.

◆ NewInstance()

vtkSimpleScalarTree * vtkSimpleScalarTree::NewInstance ( ) const

Standard type related macros and PrintSelf() method.

◆ PrintSelf()

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

overridevirtual

Standard type related macros and PrintSelf() method.

Reimplemented from vtkScalarTree.

◆ ShallowCopy()

void vtkSimpleScalarTree::ShallowCopy ( vtkScalarTree * stree )

overridevirtual

This method is used to copy data members when cloning an instance of the class.

It does not copy heavy data.

Reimplemented from vtkScalarTree.

◆ SetBranchingFactor()

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.

◆ GetBranchingFactor()

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.

◆ GetLevel()

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.

◆ SetMaxLevel()

virtual void vtkSimpleScalarTree::SetMaxLevel ( int )

virtual

Set the maximum allowable level for the tree.

◆ GetMaxLevel()

virtual int vtkSimpleScalarTree::GetMaxLevel ( )

virtual

Set the maximum allowable level for the tree.

◆ BuildTree()

void vtkSimpleScalarTree::BuildTree ( )

overridevirtual

Construct the scalar tree from the dataset provided.

Checks build times and modified time from input and reconstructs the tree if necessary.

Implements vtkScalarTree.

◆ Initialize()

void vtkSimpleScalarTree::Initialize ( )

overridevirtual

Initialize locator.

Frees memory and resets object as appropriate.

Implements vtkScalarTree.

◆ InitTraversal()

void vtkSimpleScalarTree::InitTraversal ( double scalarValue )

overridevirtual

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.

◆ GetNextCell()

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

overridevirtual

Return the next cell that may contain scalar value specified to initialize traversal.

The value nullptr is returned if the list is exhausted. Make sure that InitTraversal() has been invoked first or you'll get erratic behavior.

Implements vtkScalarTree.

◆ GetNumberOfCellBatches()

vtkIdType vtkSimpleScalarTree::GetNumberOfCellBatches ( double scalarValue )

overridevirtual

Get the number of cell batches available for processing as a function of the specified scalar value.

Each batch contains a list of candidate cells that may contain the specified isocontour value.

Implements vtkScalarTree.

◆ GetCellBatch()

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

overridevirtual

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 GetNumberOfCellBatches() beforehand.

Implements vtkScalarTree.

Member Data Documentation

◆ MaxLevel

int vtkSimpleScalarTree::MaxLevel

protected

Definition at line 145 of file vtkSimpleScalarTree.h.

◆ Level

int vtkSimpleScalarTree::Level

protected

Definition at line 146 of file vtkSimpleScalarTree.h.

◆ BranchingFactor

int vtkSimpleScalarTree::BranchingFactor

protected

Definition at line 147 of file vtkSimpleScalarTree.h.

◆ Tree

vtkScalarNode* vtkSimpleScalarTree::Tree

protected

Definition at line 148 of file vtkSimpleScalarTree.h.

◆ TreeSize

int vtkSimpleScalarTree::TreeSize

protected

Definition at line 149 of file vtkSimpleScalarTree.h.

◆ LeafOffset

vtkIdType vtkSimpleScalarTree::LeafOffset

protected

Definition at line 150 of file vtkSimpleScalarTree.h.

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

Common/ExecutionModel/vtkSimpleScalarTree.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSimpleScalarTree()

◆ ~vtkSimpleScalarTree()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ ShallowCopy()

◆ SetBranchingFactor()

◆ GetBranchingFactor()

◆ GetLevel()

◆ SetMaxLevel()

◆ GetMaxLevel()

◆ BuildTree()

◆ Initialize()

◆ InitTraversal()

◆ GetNextCell()

◆ GetNumberOfCellBatches()

◆ GetCellBatch()

Member Data Documentation

◆ MaxLevel

◆ Level

◆ BranchingFactor

◆ Tree

◆ TreeSize

◆ LeafOffset