organize data according to scalar span space More...

#include <vtkSpanSpace.h>

Inheritance diagram for vtkSpanSpace:

Collaboration diagram for vtkSpanSpace:

Public Member Functions
void	Initialize () override
	Initialize locator. More...

void	BuildTree () override
	Construct the scalar tree from the dataset provided. More...

void	InitTraversal (double scalarValue) override
	Begin to traverse the cells based on a scalar value. More...

vtkCell *	GetNextCell (vtkIdType &cellId, vtkIdList &ptIds, vtkDataArray cellScalars) override
	Return the next cell that may contain scalar value specified to InitTraversal(). More...

vtkIdType	GetNumberOfCellBatches () override
	Get the number of cell batches available for processing. More...

const vtkIdType *	GetCellBatch (vtkIdType batchNum, vtkIdType &numCells) override
	Return the array of cell ids in the specified batch. More...


virtual void	SetResolution (vtkIdType)
	Set/Get the resolution N of the span space. More...

virtual vtkIdType	GetResolution ()
	Set/Get the resolution N of the span space. More...

Public Member Functions inherited from vtkScalarTree
vtkScalarTree *	NewInstance () const

double	GetScalarValue ()
	Return the current scalar value over which tree traversal is proceeding. 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 vtkSpanSpace *	New ()
	Instantiate a scalar tree with default number of rows of 100. More...

Static Public Member Functions inherited from vtkScalarTree
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
	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. 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
vtkIdType	Resolution

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

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkScalarTree	Superclass
	Standard type related macros and PrintSelf() method. More...

static vtkTypeBool	IsTypeOf (const char *type)
	Standard type related macros and PrintSelf() method. More...

static vtkSpanSpace *	SafeDownCast (vtkObjectBase *o)
	Standard type related macros and PrintSelf() method. More...

virtual vtkTypeBool	IsA (const char *type)
	Standard type related macros and PrintSelf() method. More...

vtkSpanSpace *	NewInstance () const
	Standard type related macros and PrintSelf() method. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard type related macros and PrintSelf() method. More...

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard type related macros and PrintSelf() method. More...

Additional Inherited Members
Public Types inherited from vtkScalarTree
typedef vtkObject	Superclass

Detailed Description

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 axes (scalar_min,scalar_max). This so-called span space can then be traversed quickly to find the cells that intersect a particular 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 in parallel.

Learn more about span space in these two publications: 1) "A Near Optimal Isosorface Extraction Algorithm Using the Spsn Space." Yarden Livnat et al. and 2) Isosurfacing in SPan Space with Utmost Efficiency." Han-Wei Shen et al.

See also: vtkSimpleScalarTree

Tests:: vtkSpanSpace (Tests)

Definition at line 50 of file vtkSpanSpace.h.

Member Typedef Documentation

typedef vtkScalarTree vtkSpanSpace::Superclass

Standard type related macros and PrintSelf() method.

Definition at line 62 of file vtkSpanSpace.h.

Constructor & Destructor Documentation

vtkSpanSpace::vtkSpanSpace ( )

protected

vtkSpanSpace::~vtkSpanSpace ( )

overrideprotected

Member Function Documentation

static vtkSpanSpace* vtkSpanSpace::New ( )

static

Instantiate a scalar tree with default number of rows of 100.

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

static

Standard type related macros and PrintSelf() method.

virtual vtkTypeBool vtkSpanSpace::IsA ( const char * type )

virtual

Standard type related macros and PrintSelf() method.

Reimplemented from vtkScalarTree.

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

static

Standard type related macros and PrintSelf() method.

virtual vtkObjectBase* vtkSpanSpace::NewInstanceInternal ( ) const

protectedvirtual

Standard type related macros and PrintSelf() method.

Reimplemented from vtkScalarTree.

vtkSpanSpace* vtkSpanSpace::NewInstance ( ) const

Standard type related macros and PrintSelf() method.

void vtkSpanSpace::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Standard type related macros and PrintSelf() method.

Reimplemented from vtkScalarTree.

virtual void vtkSpanSpace::SetResolution ( vtkIdType )

virtual

Set/Get the resolution N of the span space.

The span space can be envisioned as a rectangular lattice of NXN buckets (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.

virtual vtkIdType vtkSpanSpace::GetResolution ( )

virtual

Set/Get the resolution N of the span space.

The span space can be envisioned as a rectangular lattice of NXN buckets (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.

void vtkSpanSpace::Initialize ( )

overridevirtual

Initialize locator.

Frees memory and resets object as appropriate.

Implements vtkScalarTree.

void vtkSpanSpace::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.

void vtkSpanSpace::InitTraversal ( double scalarValue )

overridevirtual

Begin to traverse the cells based on a scalar value.

Returned cells will have scalar values that span the scalar value specified. Note this method must be called prior to parallel or serial traversal since it specifies the scalar value to be extracted.

Implements vtkScalarTree.

vtkCell* vtkSpanSpace::GetNextCell	(	vtkIdType &	cellId,
		vtkIdList *&	ptIds,
		vtkDataArray *	cellScalars
	)

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 erratic behavior. This is inherently a serial operation.

Implements vtkScalarTree.

vtkIdType vtkSpanSpace::GetNumberOfCellBatches ( )

overridevirtual

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.

Implements vtkScalarTree.

const vtkIdType* vtkSpanSpace::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 InitTraversal() beforehand.

Implements vtkScalarTree.

Member Data Documentation

vtkIdType vtkSpanSpace::Resolution

protected

Definition at line 142 of file vtkSpanSpace.h.

vtkInternalSpanSpace* vtkSpanSpace::SpanSpace

protected

Definition at line 143 of file vtkSpanSpace.h.

vtkIdType vtkSpanSpace::BatchSize

protected

Definition at line 144 of file vtkSpanSpace.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/vtkSpanSpace.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation