VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkScalarTree Class Referenceabstract

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

#include <vtkScalarTree.h>

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

Public Types

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...
 
vtkScalarTreeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void ShallowCopy (vtkScalarTree *stree)
 This method is used to copy data members when cloning an instance of the class. More...
 
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 ()
 
virtual void BuildTree ()=0
 Construct the scalar tree from the dataset provided. More...
 
virtual void Initialize ()=0
 Initialize locator. More...
 
virtual void InitTraversal (double scalarValue)=0
 Begin to traverse the cells based on a scalar value (serial traversal). More...
 
virtual vtkCellGetNextCell (vtkIdType &cellId, vtkIdList *&ptIds, vtkDataArray *cellScalars)=0
 Return the next cell that may contain scalar value specified to InitTraversal() (serial traversal). More...
 
double GetScalarValue ()
 Return the current scalar value over which tree traversal is proceeding. More...
 
virtual vtkIdType GetNumberOfCellBatches (double scalarValue)=0
 Get the number of cell batches available for processing as a function of the specified scalar value. More...
 
virtual const vtkIdTypeGetCellBatch (vtkIdType batchNum, vtkIdType &numCells)=0
 Return the array of cell ids in the specified batch. 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 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
 
 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

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)

vtkScalarTree is an abstract class that defines the API to concrete scalar tree subclasses. A scalar tree is a data structure that organizes data according to its scalar value. This allows rapid access to data for those algorithms that access the data based on scalar value. For example, isocontouring operates on cells based on the scalar (isocontour) value.

To use subclasses of this class, you must specify a dataset to operate on, and then specify a scalar value in the InitTraversal() method. Then calls to GetNextCell() return cells whose scalar data contains the scalar value specified. (This describes serial traversal.)

Methods supporting parallel traversal (such as threading) are also supported. Basically thread-safe batches of cells (which are a portion of the whole dataset) are available for processing using a parallel For() operation. First request the number of batches, and then for each batch, retrieve the array of cell ids in that batch. These batches contain cell ids that are likely to contain the isosurface.

See also
vtkSimpleScalarTree vtkSpanSpace

Definition at line 55 of file vtkScalarTree.h.

Member Typedef Documentation

◆ Superclass

Standard type related macros and PrintSelf() method.

Definition at line 62 of file vtkScalarTree.h.

Constructor & Destructor Documentation

◆ vtkScalarTree()

vtkScalarTree::vtkScalarTree ( )
protected

◆ ~vtkScalarTree()

vtkScalarTree::~vtkScalarTree ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkSimpleScalarTree, and vtkSpanSpace.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkScalarTree::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkSimpleScalarTree, and vtkSpanSpace.

◆ NewInstance()

vtkScalarTree* vtkScalarTree::NewInstance ( ) const

◆ PrintSelf()

void vtkScalarTree::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 vtkObject.

Reimplemented in vtkSimpleScalarTree, and vtkSpanSpace.

◆ ShallowCopy()

virtual void vtkScalarTree::ShallowCopy ( vtkScalarTree stree)
virtual

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

It does not copy heavy data.

Reimplemented in vtkSimpleScalarTree, and vtkSpanSpace.

◆ SetDataSet()

virtual void vtkScalarTree::SetDataSet ( vtkDataSet )
virtual

Build the tree from the points/cells and scalars defining this dataset.

◆ GetDataSet()

virtual vtkDataSet* vtkScalarTree::GetDataSet ( )
virtual

◆ SetScalars()

virtual void vtkScalarTree::SetScalars ( vtkDataArray )
virtual

Build the tree from the points/cells and scalars defining the dataset and scalars provided.

Typically the scalars come from the vtkDataSet specified, but sometimes a separate vtkDataArray is provided to specify the scalars. If the scalar array is explicitly set, then it takes precedence over the scalars held in the vtkDataSet.

◆ GetScalars()

virtual vtkDataArray* vtkScalarTree::GetScalars ( )
virtual

◆ BuildTree()

virtual void vtkScalarTree::BuildTree ( )
pure virtual

Construct the scalar tree from the dataset provided.

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

Implemented in vtkSpanSpace, and vtkSimpleScalarTree.

◆ Initialize()

virtual void vtkScalarTree::Initialize ( )
pure virtual

Initialize locator.

Frees memory and resets object as appropriate.

Implemented in vtkSpanSpace, and vtkSimpleScalarTree.

◆ InitTraversal()

virtual void vtkScalarTree::InitTraversal ( double  scalarValue)
pure virtual

Begin to traverse the cells based on a scalar value (serial traversal).

Returned cells will have scalar values that span the scalar value specified. Note that changing the scalarValue does not cause the scalar tree to be modified, and hence it does not rebuild.

Implemented in vtkSpanSpace, and vtkSimpleScalarTree.

◆ GetNextCell()

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

Return the next cell that may contain scalar value specified to InitTraversal() (serial 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.

Implemented in vtkSpanSpace, and vtkSimpleScalarTree.

◆ GetScalarValue()

double vtkScalarTree::GetScalarValue ( )
inline

Return the current scalar value over which tree traversal is proceeding.

This is the scalar value provided in InitTraversal().

Definition at line 126 of file vtkScalarTree.h.

◆ GetNumberOfCellBatches()

virtual vtkIdType vtkScalarTree::GetNumberOfCellBatches ( double  scalarValue)
pure virtual

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.

Implemented in vtkSpanSpace, and vtkSimpleScalarTree.

◆ GetCellBatch()

virtual const vtkIdType* vtkScalarTree::GetCellBatch ( vtkIdType  batchNum,
vtkIdType numCells 
)
pure 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 GetNumberOfCellBatches() beforehand.

Implemented in vtkSpanSpace, and vtkSimpleScalarTree.

Member Data Documentation

◆ DataSet

vtkDataSet* vtkScalarTree::DataSet
protected

Definition at line 152 of file vtkScalarTree.h.

◆ Scalars

vtkDataArray* vtkScalarTree::Scalars
protected

Definition at line 153 of file vtkScalarTree.h.

◆ ScalarValue

double vtkScalarTree::ScalarValue
protected

Definition at line 154 of file vtkScalarTree.h.

◆ BuildTime

vtkTimeStamp vtkScalarTree::BuildTime
protected

Definition at line 156 of file vtkScalarTree.h.


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