vtkScalarTree Class Reference

organize data according to scalar values (used to accelerate contouring operations) More...

#include <vtkScalarTree.h>

Inheritance diagram for vtkScalarTree:

Collaboration diagram for vtkScalarTree:

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkScalarTree *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	BuildTree ()=0
virtual void	Initialize ()=0
virtual void	InitTraversal (double scalarValue)=0
virtual vtkIdType	GetNumberOfCellBatches ()=0
virtual void	SetDataSet (vtkDataSet *)
virtual vtkDataSet *	GetDataSet ()
virtual void	SetScalars (vtkDataArray *)
virtual vtkDataArray *	GetScalars ()
virtual vtkCell *	GetNextCell (vtkIdType &cellId, vtkIdList *&ptIds, vtkDataArray *cellScalars)=0
double	GetScalarValue ()
virtual const vtkIdType *	GetCellBatch (vtkIdType batchNum, vtkIdType &numCells)=0
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 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
virtual vtkObjectBase *	NewInstanceInternal () const
	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
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 53 of file vtkScalarTree.h.

Member Typedef Documentation

typedef vtkObject vtkScalarTree::Superclass

Definition at line 56 of file vtkScalarTree.h.

Constructor & Destructor Documentation

vtkScalarTree::vtkScalarTree ( )

protected

vtkScalarTree::~vtkScalarTree ( )

protected

Member Function Documentation

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

static

virtual int vtkScalarTree::IsA ( const char *  name )

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

Reimplemented in vtkSimpleScalarTree, and vtkSpanSpace.

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

static

virtual vtkObjectBase* vtkScalarTree::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkSimpleScalarTree, and vtkSpanSpace.

vtkScalarTree* vtkScalarTree::NewInstance

(

)

const

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

virtual

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 void vtkScalarTree::SetDataSet ( vtkDataSet *  )

virtual

Build the tree from the points/cells and scalars defining this dataset.

virtual vtkDataSet* vtkScalarTree::GetDataSet ( )

virtual

Build the tree from the points/cells and scalars defining this dataset.

virtual void vtkScalarTree::SetScalars ( vtkDataArray *  )

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 vtkDataArray* vtkScalarTree::GetScalars ( )

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 void vtkScalarTree::BuildTree ( )

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.

virtual void vtkScalarTree::Initialize ( )

pure virtual

Initialize locator. Frees memory and resets object as appropriate.

Implemented in vtkSimpleScalarTree, and vtkSpanSpace.

virtual void vtkScalarTree::InitTraversal ( double  scalarValue )

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.

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

pure virtual

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

double vtkScalarTree::GetScalarValue ( )

inline

Return the current scalar value over which tree traversal is proceeding. This is the scalar value provided in InitTraversal().

Definition at line 102 of file vtkScalarTree.h.

virtual vtkIdType vtkScalarTree::GetNumberOfCellBatches ( )

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.

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

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

vtkDataSet* vtkScalarTree::DataSet

protected

Definition at line 131 of file vtkScalarTree.h.

vtkDataArray* vtkScalarTree::Scalars

protected

Definition at line 132 of file vtkScalarTree.h.

double vtkScalarTree::ScalarValue

protected

Definition at line 133 of file vtkScalarTree.h.

vtkTimeStamp vtkScalarTree::BuildTime

protected

Definition at line 135 of file vtkScalarTree.h.

---

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

• dox/Common/ExecutionModel/vtkScalarTree.h