VTK
9.4.20241230
|
organize data according to scalar span space More...
#include <vtkSpanSpace.h>
Public Member Functions | |
void | ShallowCopy (vtkScalarTree *stree) override |
This method is used to copy data members when cloning an instance of the class. | |
void | Initialize () override |
Initialize the span space. | |
void | BuildTree () override |
Construct the scalar tree from the dataset provided. | |
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 InitTraversal(). | |
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 | SetScalarRange (double, double) |
Specify the scalar range in terms of minimum and maximum values (smin,smax). | |
void | SetScalarRange (double[2]) |
Specify the scalar range in terms of minimum and maximum values (smin,smax). | |
virtual double * | GetScalarRange () |
Specify the scalar range in terms of minimum and maximum values (smin,smax). | |
virtual void | GetScalarRange (double data[2]) |
Specify the scalar range in terms of minimum and maximum values (smin,smax). | |
virtual void | SetComputeScalarRange (vtkTypeBool) |
This boolean controls whether the determination of the scalar range is computed from the input scalar data. | |
virtual vtkTypeBool | GetComputeScalarRange () |
This boolean controls whether the determination of the scalar range is computed from the input scalar data. | |
virtual void | ComputeScalarRangeOn () |
This boolean controls whether the determination of the scalar range is computed from the input scalar data. | |
virtual void | ComputeScalarRangeOff () |
This boolean controls whether the determination of the scalar range is computed from the input scalar data. | |
virtual void | SetResolution (vtkIdType) |
Set/Get the resolution N of the span space. | |
virtual vtkIdType | GetResolution () |
Set/Get the resolution N of the span space. | |
virtual void | SetComputeResolution (vtkTypeBool) |
Boolean controls whether the resolution of span space is computed automatically from the average number of cells falling in each bucket. | |
virtual vtkTypeBool | GetComputeResolution () |
Boolean controls whether the resolution of span space is computed automatically from the average number of cells falling in each bucket. | |
virtual void | ComputeResolutionOn () |
Boolean controls whether the resolution of span space is computed automatically from the average number of cells falling in each bucket. | |
virtual void | ComputeResolutionOff () |
Boolean controls whether the resolution of span space is computed automatically from the average number of cells falling in each bucket. | |
virtual void | SetNumberOfCellsPerBucket (int) |
Specify the average number of cells in each bucket. | |
virtual int | GetNumberOfCellsPerBucket () |
Specify the average number of cells in each bucket. | |
virtual void | SetBatchSize (vtkIdType) |
Set/Get the size of the cell batches when processing in parallel. | |
virtual vtkIdType | GetBatchSize () |
Set/Get the size of the cell batches when processing in parallel. | |
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 vtkSpanSpace * | New () |
Instantiate a scalar tree with default resolution of 100 and automatic scalar range computation. | |
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 | |
vtkSpanSpace () | |
~vtkSpanSpace () 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 | |
double | ScalarRange [2] |
vtkTypeBool | ComputeScalarRange |
vtkIdType | Resolution |
vtkTypeBool | ComputeResolution |
int | NumberOfCellsPerBucket |
vtkInternalSpanSpace * | SpanSpace |
vtkIdType | BatchSize |
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 vtkSpanSpace * | SafeDownCast (vtkObjectBase *o) |
Standard type related macros and PrintSelf() method. | |
virtual vtkTypeBool | IsA (const char *type) |
Standard type related macros and PrintSelf() method. | |
vtkSpanSpace * | 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 () |
organize data according to scalar span space
This is a helper class used to accelerate contouring operations. Given an dataset, it organizes the dataset cells into a 2D binned space, with coordinate axes (scalar_min,scalar_max). This so-called span space can then be traversed quickly to find the cells that intersect a specified contour value.
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 lie along a particular row in the span space. These arrays can then be processed separately or in parallel.
Learn more about span space in these two publications: 1) "A Near Optimal Isosorface Extraction Algorithm Using the Span Space." Yarden Livnat et al. and 2) Isosurfacing in Span Space with Utmost Efficiency." Han-Wei Shen et al. @sa vtkScalarTree vtkSimpleScalarTree @par Tests: @ref c2_vtk_t_vtkSpanSpace "vtkSpanSpace (Tests)"
Definition at line 40 of file vtkSpanSpace.h.
Standard type related macros and PrintSelf() method.
Definition at line 53 of file vtkSpanSpace.h.
|
protected |
|
overrideprotected |
|
static |
Instantiate a scalar tree with default resolution of 100 and automatic scalar range computation.
|
static |
Standard type related macros and PrintSelf() method.
|
virtual |
Standard type related macros and PrintSelf() method.
Reimplemented from vtkScalarTree.
|
static |
Standard type related macros and PrintSelf() method.
|
protectedvirtual |
Standard type related macros and PrintSelf() method.
Reimplemented from vtkScalarTree.
vtkSpanSpace * vtkSpanSpace::NewInstance | ( | ) | const |
Standard type related macros and PrintSelf() method.
|
overridevirtual |
Standard type related macros and PrintSelf() method.
Reimplemented from vtkScalarTree.
|
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.
|
virtual |
Specify the scalar range in terms of minimum and maximum values (smin,smax).
These values are used to build the span space. Note that setting the range can have significant impact on the performance of the span space as it controls the effective resolution near important isocontour values. By default the range is computed automatically; turn off ComputeScalarRange is you wish to manually specify it.
void vtkSpanSpace::SetScalarRange | ( | double | [2] | ) |
Specify the scalar range in terms of minimum and maximum values (smin,smax).
These values are used to build the span space. Note that setting the range can have significant impact on the performance of the span space as it controls the effective resolution near important isocontour values. By default the range is computed automatically; turn off ComputeScalarRange is you wish to manually specify it.
|
virtual |
Specify the scalar range in terms of minimum and maximum values (smin,smax).
These values are used to build the span space. Note that setting the range can have significant impact on the performance of the span space as it controls the effective resolution near important isocontour values. By default the range is computed automatically; turn off ComputeScalarRange is you wish to manually specify it.
|
virtual |
Specify the scalar range in terms of minimum and maximum values (smin,smax).
These values are used to build the span space. Note that setting the range can have significant impact on the performance of the span space as it controls the effective resolution near important isocontour values. By default the range is computed automatically; turn off ComputeScalarRange is you wish to manually specify it.
|
virtual |
This boolean controls whether the determination of the scalar range is computed from the input scalar data.
By default this is enabled.
|
virtual |
This boolean controls whether the determination of the scalar range is computed from the input scalar data.
By default this is enabled.
|
virtual |
This boolean controls whether the determination of the scalar range is computed from the input scalar data.
By default this is enabled.
|
virtual |
This boolean controls whether the determination of the scalar range is computed from the input scalar data.
By default this is enabled.
|
virtual |
Set/Get the resolution N of the span space.
The span space can be envisioned as a rectangular lattice of NXN buckets/bins (i.e., N rows and N columns), where each bucket stores a list of cell ids. The i-j coordinate of each cell (hence its location in the lattice) is determined from the cell's 2-tuple (smin,smax) scalar range. By default Resolution = 100, with a clamp of 10,000.
|
virtual |
Set/Get the resolution N of the span space.
The span space can be envisioned as a rectangular lattice of NXN buckets/bins (i.e., N rows and N columns), where each bucket stores a list of cell ids. The i-j coordinate of each cell (hence its location in the lattice) is determined from the cell's 2-tuple (smin,smax) scalar range. By default Resolution = 100, with a clamp of 10,000.
|
virtual |
Boolean controls whether the resolution of span space is computed automatically from the average number of cells falling in each bucket.
|
virtual |
Boolean controls whether the resolution of span space is computed automatically from the average number of cells falling in each bucket.
|
virtual |
Boolean controls whether the resolution of span space is computed automatically from the average number of cells falling in each bucket.
|
virtual |
Boolean controls whether the resolution of span space is computed automatically from the average number of cells falling in each bucket.
|
virtual |
Specify the average number of cells in each bucket.
This is used to indirectly control the resolution if ComputeResolution is enabled.
|
virtual |
Specify the average number of cells in each bucket.
This is used to indirectly control the resolution if ComputeResolution is enabled.
|
overridevirtual |
|
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.
|
overridevirtual |
Begin to traverse the cells based on a scalar value.
Returned cells will have scalar values that span the scalar value specified (within the resolution of the span space). Note this method must be called prior to parallel or serial traversal since it specifies the scalar value to be extracted.
Implements vtkScalarTree.
|
overridevirtual |
Return the next cell that may contain scalar value specified to InitTraversal().
The value nullptr is returned if the list is exhausted. Make sure that InitTraversal() has been invoked first or you'll get undefined behavior. This is inherently a serial operation.
Implements vtkScalarTree.
|
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.
|
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.
|
virtual |
Set/Get the size of the cell batches when processing in parallel.
By default the batch size = 100 cells in each batch.
|
virtual |
Set/Get the size of the cell batches when processing in parallel.
By default the batch size = 100 cells in each batch.
|
protected |
Definition at line 185 of file vtkSpanSpace.h.
|
protected |
Definition at line 186 of file vtkSpanSpace.h.
|
protected |
Definition at line 187 of file vtkSpanSpace.h.
|
protected |
Definition at line 188 of file vtkSpanSpace.h.
|
protected |
Definition at line 189 of file vtkSpanSpace.h.
|
protected |
Definition at line 190 of file vtkSpanSpace.h.
|
protected |
Definition at line 191 of file vtkSpanSpace.h.