organize data according to scalar span space More...

#include <vtkSpanSpace.h>

Inheritance diagram for vtkSpanSpace:

Collaboration diagram for vtkSpanSpace:

Public Member Functions
virtual void	Initialize ()

virtual void	BuildTree ()

virtual void	InitTraversal (double scalarValue)

virtual vtkIdType	GetNumberOfCellBatches ()


virtual void	SetResolution (vtkIdType)

virtual vtkIdType	GetResolution ()


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


virtual const vtkIdType *	GetCellBatch (vtkIdType batchNum, vtkIdType &numCells)

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

virtual void	SetDataSet (vtkDataSet *)

virtual vtkDataSet *	GetDataSet ()

virtual void	SetScalars (vtkDataArray *)

virtual vtkDataArray *	GetScalars ()

double	GetScalarValue ()

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkSpanSpace *	New ()

Static Public Member Functions inherited from vtkScalarTree
static int	IsTypeOf (const char *type)

static vtkScalarTree *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
	vtkSpanSpace ()

	~vtkSpanSpace ()

Protected Member Functions inherited from vtkScalarTree
	vtkScalarTree ()

	~vtkScalarTree ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

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
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

static int	IsTypeOf (const char *type)

static vtkSpanSpace *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkSpanSpace *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Additional Inherited Members
Public Types inherited from vtkScalarTree
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	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 49 of file vtkSpanSpace.h.

Member Typedef Documentation

typedef vtkScalarTree vtkSpanSpace::Superclass

Standard type related macros and PrintSelf() method.

Definition at line 57 of file vtkSpanSpace.h.

Constructor & Destructor Documentation

vtkSpanSpace::vtkSpanSpace ( )

protected

vtkSpanSpace::~vtkSpanSpace ( )

protected

Member Function Documentation

static vtkSpanSpace* vtkSpanSpace::New ( )

static

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

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

static

Standard type related macros and PrintSelf() method.

virtual int 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
	)

virtual

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.

virtual void vtkSpanSpace::Initialize ( )

virtual

Initialize locator. Frees memory and resets object as appropriate.

Implements vtkScalarTree.

virtual void vtkSpanSpace::BuildTree ( )

virtual

Construct the scalar tree from the dataset provided. Checks build times and modified time from input and reconstructs the tree if necessary.

Implements vtkScalarTree.

virtual void vtkSpanSpace::InitTraversal ( double scalarValue )

virtual

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.

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

virtual

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

virtual vtkIdType vtkSpanSpace::GetNumberOfCellBatches ( )

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.

Implements vtkScalarTree.

virtual const vtkIdType* vtkSpanSpace::GetCellBatch	(	vtkIdType	batchNum,
		vtkIdType &	numCells
	)

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.

Implements vtkScalarTree.

Member Data Documentation

vtkIdType vtkSpanSpace::Resolution

protected

Definition at line 128 of file vtkSpanSpace.h.

vtkInternalSpanSpace* vtkSpanSpace::SpanSpace

protected

Definition at line 129 of file vtkSpanSpace.h.

vtkIdType vtkSpanSpace::BatchSize

protected

Definition at line 130 of file vtkSpanSpace.h.

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

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