organize data according to scalar values (used to accelerate contouring operations) More...
#include <vtkScalarTree.h>
Public Types | |
| typedef vtkObject | Superclass |
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... | |
| vtkScalarTree * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| 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. More... | |
| virtual vtkCell * | GetNextCell (vtkIdType &cellId, vtkIdList *&ptIds, vtkDataArray *cellScalars)=0 |
| Return the next cell that may contain scalar value specified to initialize traversal. More... | |
| double | GetScalarValue () |
| Return the current scalar value over which tree traversal is proceeding. More... | |
| virtual vtkIdType | GetNumberOfCellBatches ()=0 |
| Get the number of cell batches available for processing. More... | |
| virtual const vtkIdType * | GetCellBatch (vtkIdType batchNum, vtkIdType &numCells)=0 |
| Return the array of cell ids in the specified batch. More... | |
| virtual void | SetDataSet (vtkDataSet *) |
| Build the tree from the points/cells and scalars defining this dataset. More... | |
| virtual vtkDataSet * | GetDataSet () |
| Build the tree from the points/cells and scalars defining this dataset. More... | |
| virtual void | SetScalars (vtkDataArray *) |
| Build the tree from the points/cells and scalars defining the dataset and scalars provided. More... | |
| virtual vtkDataArray * | GetScalars () |
| Build the tree from the points/cells and scalars defining the dataset and scalars provided. 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... | |
| 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. More... | |
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| 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) |
| 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, 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) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| 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 | 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... | |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkScalarTree * | SafeDownCast (vtkObjectBase *o) |
| 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. 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 () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOff () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static int | GetGlobalWarningDisplay () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| 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 vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () 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 () |
| These methods allow a command to exclusively grab all events. More... | |
| 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 | |
| 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 |
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 54 of file vtkScalarTree.h.
Member Typedef Documentation
| typedef vtkObject vtkScalarTree::Superclass |
Definition at line 57 of file vtkScalarTree.h.
Constructor & Destructor Documentation
|
protected |
|
overrideprotected |
Member Function Documentation
|
static |
|
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.
|
static |
|
protectedvirtual |
Reimplemented in vtkSimpleScalarTree, and vtkSpanSpace.
| vtkScalarTree* vtkScalarTree::NewInstance | ( | ) | const |
|
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.
|
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.
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 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.
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 114 of file vtkScalarTree.h.
|
pure 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.
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 InitTraversal() beforehand.
Implemented in vtkSimpleScalarTree, and vtkSpanSpace.
Member Data Documentation
|
protected |
Definition at line 144 of file vtkScalarTree.h.
|
protected |
Definition at line 145 of file vtkScalarTree.h.
|
protected |
Definition at line 146 of file vtkScalarTree.h.
|
protected |
Definition at line 148 of file vtkScalarTree.h.
The documentation for this class was generated from the following file:
- /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Common/ExecutionModel/vtkScalarTree.h
