VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSimpleScalarTree Class Reference

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

#include <vtkSimpleScalarTree.h>

Inheritance diagram for vtkSimpleScalarTree:
[legend]
Collaboration diagram for vtkSimpleScalarTree:
[legend]

Public Types

typedef vtkScalarTree Superclass
 Standard type related macros and PrintSelf() method. More...
 
- Public Types inherited from vtkScalarTree
typedef vtkObject Superclass
 Standard type related macros and PrintSelf() method. More...
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkSimpleScalarTreeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void ShallowCopy (vtkScalarTree *stree) override
 This method is used to copy data members when cloning an instance of the class. More...
 
virtual void SetBranchingFactor (int)
 Set the branching factor for the tree. More...
 
virtual int GetBranchingFactor ()
 
virtual int GetLevel ()
 Get the level of the scalar tree. More...
 
virtual void SetMaxLevel (int)
 Set the maximum allowable level for the tree. More...
 
virtual int GetMaxLevel ()
 
void BuildTree () override
 Construct the scalar tree from the dataset provided. More...
 
void Initialize () override
 Initialize locator. More...
 
void InitTraversal (double scalarValue) override
 Begin to traverse the cells based on a scalar value. More...
 
vtkCellGetNextCell (vtkIdType &cellId, vtkIdList *&ptIds, vtkDataArray *cellScalars) override
 Return the next cell that may contain scalar value specified to initialize traversal. More...
 
vtkIdType GetNumberOfCellBatches (double scalarValue) override
 Get the number of cell batches available for processing as a function of the specified scalar value. More...
 
const vtkIdTypeGetCellBatch (vtkIdType batchNum, vtkIdType &numCells) override
 Return the array of cell ids in the specified batch. More...
 
- Public Member Functions inherited from vtkScalarTree
vtkScalarTreeNewInstance () const
 
virtual void SetDataSet (vtkDataSet *)
 Build the tree from the points/cells and scalars defining this dataset. More...
 
virtual vtkDataSetGetDataSet ()
 
virtual void SetScalars (vtkDataArray *)
 Build the tree from the points/cells and scalars defining the dataset and scalars provided. More...
 
virtual vtkDataArrayGetScalars ()
 
double GetScalarValue ()
 Return the current scalar value over which tree traversal is proceeding. 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...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkSimpleScalarTreeNew ()
 Instantiate scalar tree with maximum level of 20 and branching factor of three. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSimpleScalarTreeSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkScalarTree
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkScalarTreeSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 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. More...
 
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
vtkDataSetDataSet
 
vtkDataArrayScalars
 
double ScalarValue
 
vtkTimeStamp BuildTime
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

Definition at line 56 of file vtkSimpleScalarTree.h.

Member Typedef Documentation

◆ Superclass

Standard type related macros and PrintSelf() method.

Definition at line 69 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

◆ IsA()

virtual vtkTypeBool vtkSimpleScalarTree::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 vtkScalarTree.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkSimpleScalarTree::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkScalarTree.

◆ NewInstance()

vtkSimpleScalarTree* vtkSimpleScalarTree::NewInstance ( ) const

◆ PrintSelf()

void vtkSimpleScalarTree::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 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

◆ 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

◆ 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 153 of file vtkSimpleScalarTree.h.

◆ Level

int vtkSimpleScalarTree::Level
protected

Definition at line 154 of file vtkSimpleScalarTree.h.

◆ BranchingFactor

int vtkSimpleScalarTree::BranchingFactor
protected

Definition at line 155 of file vtkSimpleScalarTree.h.

◆ Tree

vtkScalarNode* vtkSimpleScalarTree::Tree
protected

Definition at line 156 of file vtkSimpleScalarTree.h.

◆ TreeSize

int vtkSimpleScalarTree::TreeSize
protected

Definition at line 157 of file vtkSimpleScalarTree.h.

◆ LeafOffset

vtkIdType vtkSimpleScalarTree::LeafOffset
protected

Definition at line 158 of file vtkSimpleScalarTree.h.


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