VTK
9.1.0
|
organize data according to scalar values (used to accelerate contouring operations) More...
#include <vtkScalarTree.h>
Public Member Functions | |
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. | |
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) |
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. | |
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. | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
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. | |
virtual 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. | |
Protected Member Functions | |
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 *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkDataSet * | DataSet |
vtkDataArray * | Scalars |
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 |
typedef vtkObject | Superclass |
Standard type related macros and PrintSelf() method. | |
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. | |
virtual vtkTypeBool | IsA (const char *type) |
Standard type related macros and PrintSelf() method. | |
vtkScalarTree * | 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 | |
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 (int 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 int | 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. | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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.
Definition at line 54 of file vtkScalarTree.h.
typedef vtkObject vtkScalarTree::Superclass |
Standard type related macros and PrintSelf() method.
Definition at line 61 of file vtkScalarTree.h.
|
protected |
|
overrideprotected |
|
static |
Standard type related macros and PrintSelf() method.
|
virtual |
Standard type related macros and PrintSelf() method.
Reimplemented from vtkObjectBase.
Reimplemented in vtkSimpleScalarTree, and vtkSpanSpace.
|
static |
Standard type related macros and PrintSelf() method.
|
protectedvirtual |
Standard type related macros and PrintSelf() method.
Reimplemented in vtkSimpleScalarTree, and vtkSpanSpace.
vtkScalarTree * vtkScalarTree::NewInstance | ( | ) | const |
Standard type related macros and PrintSelf() method.
|
overridevirtual |
Standard type related macros and PrintSelf() method.
Reimplemented from vtkObject.
Reimplemented in vtkSimpleScalarTree, and vtkSpanSpace.
|
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.
|
virtual |
Build the tree from the points/cells and scalars defining this dataset.
|
virtual |
Build the tree from the points/cells and scalars defining this dataset.
|
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.
|
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.
|
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 vtkSimpleScalarTree, and vtkSpanSpace.
|
pure virtual |
Initialize locator.
Frees memory and resets object as appropriate.
Implemented in vtkSimpleScalarTree, and vtkSpanSpace.
|
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 vtkSimpleScalarTree, and vtkSpanSpace.
|
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 vtkSimpleScalarTree, and vtkSpanSpace.
|
inline |
Return the current scalar value over which tree traversal is proceeding.
This is the scalar value provided in InitTraversal().
Definition at line 124 of file vtkScalarTree.h.
|
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 vtkSimpleScalarTree, and vtkSpanSpace.
|
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 vtkSimpleScalarTree, and vtkSpanSpace.
|
protected |
Definition at line 148 of file vtkScalarTree.h.
|
protected |
Definition at line 149 of file vtkScalarTree.h.
|
protected |
Definition at line 150 of file vtkScalarTree.h.
|
protected |
Definition at line 152 of file vtkScalarTree.h.