abstract class to specify dataset behavior More...

#include <vtkDataSet.h>

Inheritance diagram for vtkDataSet:

Collaboration diagram for vtkDataSet:

Public Types
enum	FieldDataType { DATA_OBJECT_FIELD =0, POINT_DATA_FIELD =1, CELL_DATA_FIELD =2 }

typedef vtkDataObject	Superclass

Public Types inherited from vtkDataObject
typedef vtkObject	Superclass

enum	FieldAssociations { FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS, FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS }

enum	AttributeTypes { POINT, CELL, FIELD, POINT_THEN_CELL, VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES }

enum	FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkDataSet *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	CopyStructure (vtkDataSet *ds)=0

virtual void	CopyAttributes (vtkDataSet *ds)

virtual vtkIdType	GetNumberOfPoints ()=0

virtual vtkIdType	GetNumberOfCells ()=0

virtual double *	GetPoint (vtkIdType ptId)=0

virtual void	GetPoint (vtkIdType id, double x[3])

virtual vtkCellIterator *	NewCellIterator ()

virtual vtkCell *	GetCell (vtkIdType cellId)=0

virtual void	GetCell (vtkIdType cellId, vtkGenericCell *cell)=0

virtual void	GetCellBounds (vtkIdType cellId, double bounds[6])

virtual int	GetCellType (vtkIdType cellId)=0

virtual void	GetCellTypes (vtkCellTypes *types)

virtual void	GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)=0

virtual void	GetPointCells (vtkIdType ptId, vtkIdList *cellIds)=0

unsigned long int	GetMTime ()

vtkCellData *	GetCellData ()

vtkPointData *	GetPointData ()

virtual void	Squeeze ()

virtual void	ComputeBounds ()

double *	GetBounds ()

void	GetBounds (double bounds[6])

double *	GetCenter ()

void	GetCenter (double center[3])

double	GetLength ()

void	Initialize ()

virtual void	GetScalarRange (double range[2])

double *	GetScalarRange ()

virtual int	GetMaxCellSize ()=0

unsigned long	GetActualMemorySize ()

int	CheckAttributes ()

virtual vtkFieldData *	GetAttributesAsFieldData (int type)

virtual vtkIdType	GetNumberOfElements (int type)

bool	HasAnyGhostCells ()

bool	HasAnyGhostPoints ()

vtkUnsignedCharArray *	GetPointGhostArray ()

void	UpdatePointGhostArrayCache ()

vtkUnsignedCharArray *	AllocatePointGhostArray ()

vtkUnsignedCharArray *	GetCellGhostArray ()

void	UpdateCellGhostArrayCache ()

vtkUnsignedCharArray *	AllocateCellGhostArray ()


virtual void	GetCellNeighbors (vtkIdType cellId, vtkIdList ptIds, vtkIdList cellIds)


vtkIdType	FindPoint (double x, double y, double z)

virtual vtkIdType	FindPoint (double x[3])=0


virtual vtkIdType	FindCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights)=0


virtual vtkIdType	FindCell (double x[3], vtkCell cell, vtkGenericCell gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)=0


virtual vtkCell *	FindAndGetCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights)


int	GetDataObjectType ()


void	ShallowCopy (vtkDataObject *src)

void	DeepCopy (vtkDataObject *src)


virtual void	GenerateGhostArray (int zeroExt[6])

virtual void	GenerateGhostArray (int zeroExt[6], bool cellOnly)


virtual bool	HasAnyBlankCells ()


virtual bool	HasAnyBlankPoints ()

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

void	ReleaseData ()

unsigned long	GetUpdateTime ()

virtual void	CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))

void	DataHasBeenGenerated ()

virtual void	PrepareForNewData ()

virtual int	GetExtentType ()

virtual void	Crop (const int *updateExtent)

virtual vtkDataSetAttributes *	GetAttributes (int type)

virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

virtual int	GetDataReleased ()

virtual void	SetFieldData (vtkFieldData *)

virtual vtkFieldData *	GetFieldData ()

virtual void	CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))

void	GlobalReleaseDataFlagOn ()

void	GlobalReleaseDataFlagOff ()

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

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 vtkDataSet *	SafeDownCast (vtkObjectBase *o)


static vtkDataSet *	GetData (vtkInformation *info)

static vtkDataSet *	GetData (vtkInformationVector *v, int i=0)

Static Public Member Functions inherited from vtkDataObject
static vtkDataObject *	New ()

static int	IsTypeOf (const char *type)

static vtkDataObject *	SafeDownCast (vtkObjectBase *o)

static const char *	GetAssociationTypeAsString (int associationType)

static int	GetAssociationTypeFromString (const char *associationType)

static vtkInformationStringKey *	DATA_TYPE_NAME ()

static vtkInformationDataObjectKey *	DATA_OBJECT ()

static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()

static vtkInformationIntegerPointerKey *	DATA_EXTENT ()

static vtkInformationIntegerVectorKey *	ALL_PIECES_EXTENT ()

static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()

static vtkInformationDoubleKey *	DATA_TIME_STEP ()

static vtkInformationInformationVectorKey *	POINT_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	CELL_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	VERTEX_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	EDGE_DATA_VECTOR ()

static vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()

static vtkInformationIntegerKey *	FIELD_ASSOCIATION ()

static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()

static vtkInformationIntegerKey *	FIELD_ACTIVE_ATTRIBUTE ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()

static vtkInformationIntegerKey *	FIELD_OPERATION ()

static vtkInformationDoubleVectorKey *	FIELD_RANGE ()

static vtkInformationIntegerVectorKey *	PIECE_EXTENT ()

static vtkInformationStringKey *	FIELD_NAME ()

static vtkInformationDoubleVectorKey *	ORIGIN ()

static vtkInformationDoubleVectorKey *	SPACING ()

static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()

static vtkInformationDataObjectKey *	SIL ()

static vtkInformation *	GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)

static vtkInformation *	GetNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)

static void	RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)

static vtkInformation *	SetActiveAttribute (vtkInformation info, int fieldAssociation, const char attributeName, int attributeType)

static void	SetActiveAttributeInfo (vtkInformation info, int fieldAssociation, int attributeType, const char name, int arrayType, int numComponents, int numTuples)

static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)

static vtkDataObject *	GetData (vtkInformation *info)

static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)

static void	SetGlobalReleaseDataFlag (int val)

static int	GetGlobalReleaseDataFlag ()

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

	vtkDataSet ()

	~vtkDataSet ()

virtual void	ComputeScalarRange ()

bool	IsAnyBitSet (vtkUnsignedCharArray *a, int bitFlag)

Protected Member Functions inherited from vtkDataObject
	vtkDataObject ()

	~vtkDataObject ()

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
vtkCellData *	CellData

vtkPointData *	PointData

vtkCallbackCommand *	DataObserver

vtkTimeStamp	ComputeTime

double	Bounds [6]

double	Center [3]

double	ScalarRange [2]

vtkTimeStamp	ScalarRangeComputeTime


vtkUnsignedCharArray *	PointGhostArray

vtkUnsignedCharArray *	CellGhostArray

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

int	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkImageAlgorithmToDataSetFriendship

Detailed Description

abstract class to specify dataset behavior

vtkDataSet is an abstract class that specifies an interface for dataset objects. vtkDataSet also provides methods to provide informations about the data, such as center, bounding box, and representative length.

In vtk a dataset consists of a structure (geometry and topology) and attribute data. The structure is defined implicitly or explicitly as a collection of cells. The geometry of the structure is contained in point coordinates plus the cell interpolation functions. The topology of the dataset structure is defined by cell types and how the cells share their defining points.

Attribute data in vtk is either point data (data at points) or cell data (data at cells). Typically filters operate on point data, but some may operate on cell data, both cell and point data, either one, or none.

See also: vtkPointSet vtkStructuredPoints vtkStructuredGrid vtkUnstructuredGrid vtkRectilinearGrid vtkPolyData vtkPointData vtkCellData vtkDataObject vtkFieldData

Examples:: vtkDataSet (Examples)

Tests:: vtkDataSet (Tests)

Definition at line 61 of file vtkDataSet.h.

Member Typedef Documentation

typedef vtkDataObject vtkDataSet::Superclass

Definition at line 64 of file vtkDataSet.h.

Member Enumeration Documentation

enum vtkDataSet::FieldDataType

Enumerator
DATA_OBJECT_FIELD
POINT_DATA_FIELD
CELL_DATA_FIELD

Definition at line 289 of file vtkDataSet.h.

Constructor & Destructor Documentation

vtkDataSet::vtkDataSet ( )

protected

vtkDataSet::~vtkDataSet ( )

protected

Member Function Documentation

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

static

virtual int vtkDataSet::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 vtkDataObject.

Reimplemented in vtkHyperOctree, vtkPolyData, vtkUnstructuredGrid, vtkLabelHierarchy, vtkTypeTemplate< vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkUnstructuredGridBase >, vtkHyperTreeGrid, vtkStructuredGrid, vtkRectilinearGrid, vtkImageData, vtkPointSet, vtkUniformGrid, vtkStructuredPoints, and vtkPath.

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

static

virtual vtkObjectBase* vtkDataSet::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataObject.

Reimplemented in vtkHyperOctree, vtkPolyData, vtkUnstructuredGrid, vtkLabelHierarchy, vtkHyperTreeGrid, vtkStructuredGrid, vtkTypeTemplate< vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkUnstructuredGridBase >, vtkRectilinearGrid, vtkImageData, vtkPointSet, vtkUniformGrid, vtkStructuredPoints, and vtkPath.

vtkDataSet* vtkDataSet::NewInstance ( ) const

void vtkDataSet::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 vtkDataObject.

Reimplemented in vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkHyperOctree, vtkPolyData, vtkUnstructuredGrid, vtkLabelHierarchy, vtkHyperTreeGrid, vtkStructuredGrid, vtkRectilinearGrid, vtkImageData, vtkPointSet, vtkUniformGrid, and vtkPath.

virtual void vtkDataSet::CopyStructure ( vtkDataSet * ds )

pure virtual

Copy the geometric and topological structure of an object. Note that the invoking object and the object pointed to by the parameter ds must be of the same type. THIS METHOD IS NOT THREAD SAFE.

Implemented in vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkHyperOctree, vtkUnstructuredGrid, vtkPolyData, vtkHyperTreeGrid, vtkStructuredGrid, vtkRectilinearGrid, vtkImageData, vtkPointSet, and vtkUniformGrid.

virtual void vtkDataSet::CopyAttributes ( vtkDataSet * ds )

virtual

Copy the attributes associated with the specified dataset to this instance of vtkDataSet. THIS METHOD IS NOT THREAD SAFE.

virtual vtkIdType vtkDataSet::GetNumberOfPoints ( )

pure virtual

Determine the number of points composing the dataset. THIS METHOD IS THREAD SAFE

Implemented in vtkHyperOctree, vtkHyperTreeGrid, vtkStructuredGrid, vtkRectilinearGrid, vtkImageData, and vtkPointSet.

virtual vtkIdType vtkDataSet::GetNumberOfCells ( )

pure virtual

Determine the number of cells composing the dataset. THIS METHOD IS THREAD SAFE

Implemented in vtkLabelHierarchy, vtkHyperOctree, vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkUnstructuredGrid, vtkHyperTreeGrid, vtkPolyData, vtkStructuredGrid, vtkPath, vtkRectilinearGrid, and vtkImageData.

virtual double* vtkDataSet::GetPoint ( vtkIdType ptId )

pure virtual

Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints. THIS METHOD IS NOT THREAD SAFE.

Implemented in vtkHyperOctree, vtkHyperTreeGrid, vtkStructuredGrid, vtkRectilinearGrid, vtkImageData, and vtkPointSet.

void vtkDataSet::GetPoint	(	vtkIdType	id,
		double	x[3]
	)

inlinevirtual

Copy point coordinates into user provided array x[3] for specified point id. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented in vtkHyperOctree, vtkHyperTreeGrid, vtkStructuredGrid, vtkRectilinearGrid, vtkImageData, and vtkPointSet.

Definition at line 425 of file vtkDataSet.h.

virtual vtkCellIterator* vtkDataSet::NewCellIterator ( )

virtual

Return an iterator that traverses the cells in this data set.

Reimplemented in vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkUnstructuredGrid, and vtkPointSet.

virtual vtkCell* vtkDataSet::GetCell ( vtkIdType cellId )

pure virtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells. THIS METHOD IS NOT THREAD SAFE.

Implemented in vtkHyperOctree, vtkHyperTreeGrid, vtkLabelHierarchy, vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkUnstructuredGrid, vtkPolyData, vtkStructuredGrid, vtkPath, vtkRectilinearGrid, vtkImageData, and vtkUniformGrid.

virtual void vtkDataSet::GetCell	(	vtkIdType	cellId,
		vtkGenericCell *	cell
	)

pure virtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells. This is a thread-safe alternative to the previous GetCell() method. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implemented in vtkHyperOctree, vtkHyperTreeGrid, vtkLabelHierarchy, vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkUnstructuredGrid, vtkPolyData, vtkStructuredGrid, vtkPath, vtkRectilinearGrid, vtkImageData, and vtkUniformGrid.

virtual void vtkDataSet::GetCellBounds	(	vtkIdType	cellId,
		double	bounds[6]
	)

virtual

Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells. A subclass may be able to determine the bounds of cell without using an expensive GetCell() method. A default implementation is provided that actually uses a GetCell() call. This is to ensure the method is available to all datasets. Subclasses should override this method to provide an efficient implementation. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented in vtkUnstructuredGrid, vtkPolyData, vtkStructuredGrid, vtkRectilinearGrid, and vtkImageData.

virtual int vtkDataSet::GetCellType ( vtkIdType cellId )

pure virtual

Get type of cell with cellId such that: 0 <= cellId < NumberOfCells. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implemented in vtkHyperOctree, vtkHyperTreeGrid, vtkLabelHierarchy, vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkUnstructuredGrid, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkPath, vtkImageData, and vtkUniformGrid.

virtual void vtkDataSet::GetCellTypes ( vtkCellTypes * types )

virtual

Get a list of types of cells in a dataset. The list consists of an array of types (not necessarily in any order), with a single entry per type. For example a dataset 5 triangles, 3 lines, and 100 hexahedra would result a list of three entries, corresponding to the types VTK_TRIANGLE, VTK_LINE, and VTK_HEXAHEDRON. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

virtual void vtkDataSet::GetCellPoints	(	vtkIdType	cellId,
		vtkIdList *	ptIds
	)

pure virtual

Topological inquiry to get points defining cell. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implemented in vtkHyperOctree, vtkHyperTreeGrid, vtkLabelHierarchy, vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkUnstructuredGrid, vtkPolyData, vtkRectilinearGrid, vtkPath, vtkStructuredGrid, vtkImageData, and vtkUniformGrid.

virtual void vtkDataSet::GetPointCells	(	vtkIdType	ptId,
		vtkIdList *	cellIds
	)

pure virtual

Topological inquiry to get cells using point. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implemented in vtkHyperOctree, vtkHyperTreeGrid, vtkLabelHierarchy, vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkUnstructuredGrid, vtkPolyData, vtkRectilinearGrid, vtkPath, vtkStructuredGrid, vtkImageData, and vtkUniformGrid.

virtual void vtkDataSet::GetCellNeighbors	(	vtkIdType	cellId,
		vtkIdList *	ptIds,
		vtkIdList *	cellIds
	)

virtual

Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId). Note that the list consists of only cells that use ALL the points provided. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented in vtkHyperOctree, vtkHyperTreeGrid, vtkUnstructuredGrid, vtkPolyData, vtkRectilinearGrid, and vtkStructuredGrid.

vtkIdType vtkDataSet::FindPoint	(	double	x,
		double	y,
		double	z
	)

inline

Locate the closest point to the global coordinate x. Return the point id. If point id < 0; then no point found. (This may arise when point is outside of dataset.) THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Definition at line 154 of file vtkDataSet.h.

virtual vtkIdType vtkDataSet::FindPoint ( double x[3] )

pure virtual

Locate the closest point to the global coordinate x. Return the point id. If point id < 0; then no point found. (This may arise when point is outside of dataset.) THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implemented in vtkHyperOctree, vtkHyperTreeGrid, vtkRectilinearGrid, vtkImageData, and vtkPointSet.

virtual vtkIdType vtkDataSet::FindCell	(	double	x[3],
		vtkCell *	cell,
		vtkIdType	cellId,
		double	tol2,
		int &	subId,
		double	pcoords[3],
		double *	weights
	)

pure virtual

Locate cell based on global coordinate x and tolerance squared. If cell and cellId is non-NULL, then search starts from this cell and looks at immediate neighbors. Returns cellId >= 0 if inside, < 0 otherwise. The parametric coordinates are provided in pcoords[3]. The interpolation weights are returned in weights[]. (The number of weights is equal to the number of points in the found cell). Tolerance is used to control how close the point is to be considered "in" the cell. THIS METHOD IS NOT THREAD SAFE.

Implemented in vtkHyperOctree, vtkHyperTreeGrid, vtkRectilinearGrid, vtkImageData, vtkPointSet, and vtkUniformGrid.

virtual vtkIdType vtkDataSet::FindCell	(	double	x[3],
		vtkCell *	cell,
		vtkGenericCell *	gencell,
		vtkIdType	cellId,
		double	tol2,
		int &	subId,
		double	pcoords[3],
		double *	weights
	)

pure virtual

This is a version of the above method that can be used with multithreaded applications. A vtkGenericCell must be passed in to be used in internal calls that might be made to GetCell() THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implemented in vtkHyperOctree, vtkHyperTreeGrid, vtkRectilinearGrid, vtkImageData, vtkPointSet, and vtkUniformGrid.

virtual vtkCell* vtkDataSet::FindAndGetCell	(	double	x[3],
		vtkCell *	cell,
		vtkIdType	cellId,
		double	tol2,
		int &	subId,
		double	pcoords[3],
		double *	weights
	)

virtual

Locate the cell that contains a point and return the cell. Also returns the subcell id, parametric coordinates and weights for subsequent interpolation. This method combines the derived class methods int FindCell and vtkCell *GetCell. Derived classes may provide a more efficient implementation. See for example vtkStructuredPoints. THIS METHOD IS NOT THREAD SAFE.

Reimplemented in vtkRectilinearGrid, vtkImageData, and vtkUniformGrid.

unsigned long int vtkDataSet::GetMTime ( )

virtual

Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE

Reimplemented from vtkDataObject.

Reimplemented in vtkMappedUnstructuredGrid< Implementation, CellIterator >, and vtkPointSet.

vtkCellData* vtkDataSet::GetCellData ( )

inline

Return a pointer to this dataset's cell data. THIS METHOD IS THREAD SAFE

Definition at line 207 of file vtkDataSet.h.

vtkPointData* vtkDataSet::GetPointData ( )

inline

Return a pointer to this dataset's point data. THIS METHOD IS THREAD SAFE

Definition at line 211 of file vtkDataSet.h.

virtual void vtkDataSet::Squeeze ( )

virtual

Reclaim any extra memory used to store data. THIS METHOD IS NOT THREAD SAFE.

Reimplemented in vtkUnstructuredGrid, vtkPolyData, and vtkPointSet.

virtual void vtkDataSet::ComputeBounds ( )

virtual

Compute the data bounding box from data points. THIS METHOD IS NOT THREAD SAFE.

Reimplemented in vtkHyperOctree, vtkHyperTreeGrid, vtkPolyData, vtkRectilinearGrid, vtkImageData, and vtkPointSet.

double* vtkDataSet::GetBounds ( )

Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). THIS METHOD IS NOT THREAD SAFE.

void vtkDataSet::GetBounds ( double bounds[6] )

Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

double* vtkDataSet::GetCenter ( )

Get the center of the bounding box. THIS METHOD IS NOT THREAD SAFE.

void vtkDataSet::GetCenter ( double center[3] )

Get the center of the bounding box. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

double vtkDataSet::GetLength ( )

Return the length of the diagonal of the bounding box. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

void vtkDataSet::Initialize ( )

virtual

Restore data object to initial state. THIS METHOD IS NOT THREAD SAFE.

Reimplemented from vtkDataObject.

Reimplemented in vtkPolyData, vtkHyperOctree, vtkHyperTreeGrid, vtkUnstructuredGrid, vtkImageData, vtkStructuredGrid, vtkUniformGrid, vtkRectilinearGrid, and vtkPointSet.

virtual void vtkDataSet::GetScalarRange ( double range[2] )

virtual

Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. If the data has both point data and cell data, it returns the (min/max) range of combined point and cell data. If there are no point or cell scalars the method will return (0,1). Note: It might be necessary to call Update to create or refresh the scalars before calling this method. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

double* vtkDataSet::GetScalarRange ( )

Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. If the data has both point data and cell data, it returns the (min/max) range of combined point and cell data. If there are no point or cell scalars the method will return (0,1). Note: It might be necessary to call Update to create or refresh the scalars before calling this method. THIS METHOD IS NOT THREAD SAFE.

virtual int vtkDataSet::GetMaxCellSize ( )

pure virtual

Convenience method returns largest cell size in dataset. This is generally used to allocate memory for supporting data structures. THIS METHOD IS THREAD SAFE

Implemented in vtkHyperOctree, vtkHyperTreeGrid, vtkLabelHierarchy, vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkUnstructuredGrid, vtkPolyData, vtkRectilinearGrid, vtkPath, vtkStructuredGrid, vtkImageData, and vtkUniformGrid.

unsigned long vtkDataSet::GetActualMemorySize ( )

virtual

Return the actual size of the data in kibibytes (1024 bytes). This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the return value). THIS METHOD IS THREAD SAFE.

Reimplemented from vtkDataObject.

Reimplemented in vtkHyperOctree, vtkPolyData, vtkHyperTreeGrid, vtkImageData, vtkUnstructuredGrid, vtkRectilinearGrid, vtkStructuredGrid, and vtkPointSet.

int vtkDataSet::GetDataObjectType ( )

inlinevirtual

Return the type of data object.

Reimplemented from vtkDataObject.

Reimplemented in vtkHyperOctree, vtkPolyData, vtkUnstructuredGrid, vtkHyperTreeGrid, vtkStructuredGrid, vtkRectilinearGrid, vtkImageData, vtkUniformGrid, vtkStructuredPoints, vtkUnstructuredGridBase, and vtkPath.

Definition at line 278 of file vtkDataSet.h.

void vtkDataSet::ShallowCopy ( vtkDataObject * src )

virtual

Shallow and Deep copy.

Reimplemented from vtkDataObject.

Reimplemented in vtkPolyData, vtkHyperOctree, vtkImageData, vtkHyperTreeGrid, vtkUnstructuredGrid, vtkRectilinearGrid, vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkStructuredGrid, and vtkPointSet.

void vtkDataSet::DeepCopy ( vtkDataObject * src )

virtual

Shallow and Deep copy.

Reimplemented from vtkDataObject.

Reimplemented in vtkPolyData, vtkHyperOctree, vtkImageData, vtkHyperTreeGrid, vtkUnstructuredGrid, vtkRectilinearGrid, vtkStructuredGrid, vtkPointSet, and vtkUnstructuredGridBase.

int vtkDataSet::CheckAttributes ( )

This method checks to see if the cell and point attributes match the geometry. Many filters will crash if the number of tupples in an array is less than the number of points/cells. This method returns 1 if there is a mismatch, and 0 if everything is ok. It prints an error if an array is too short, and a warning if an array is too long.

virtual void vtkDataSet::GenerateGhostArray ( int zeroExt[6] )

inlinevirtual

Normally called by pipeline executives or algoritms only. This method computes the ghost arrays for a given dataset. The zeroExt argument specifies the extent of the region which ghost type = 0.

Definition at line 309 of file vtkDataSet.h.

virtual void vtkDataSet::GenerateGhostArray	(	int	zeroExt[6],
		bool	cellOnly
	)

virtual

Normally called by pipeline executives or algoritms only. This method computes the ghost arrays for a given dataset. The zeroExt argument specifies the extent of the region which ghost type = 0.

static vtkDataSet* vtkDataSet::GetData ( vtkInformation * info )

static

Retrieve an instance of this class from an information object.

static vtkDataSet* vtkDataSet::GetData	(	vtkInformationVector *	v,
		int	i = `0`
	)

static

Retrieve an instance of this class from an information object.

virtual vtkFieldData* vtkDataSet::GetAttributesAsFieldData ( int type )

virtual

Returns the attributes of the data object as a vtkFieldData. This returns non-null values in all the same cases as GetAttributes, in addition to the case of FIELD, which will return the field data for any vtkDataObject subclass.

Reimplemented from vtkDataObject.

virtual vtkIdType vtkDataSet::GetNumberOfElements ( int type )

virtual

Get the number of elements for a specific attribute type (POINT, CELL, etc.).

Reimplemented from vtkDataObject.

bool vtkDataSet::HasAnyGhostCells ( )

Returns 1 if there are any ghost cells 0 otherwise.

bool vtkDataSet::HasAnyGhostPoints ( )

Returns 1 if there are any ghost points 0 otherwise.

virtual bool vtkDataSet::HasAnyBlankCells ( )

inlinevirtual

Returns 1 if there are any blanking cells 0 otherwise. Blanking is supported only for vtkStructuredGrid and vtkUniformGrid

Reimplemented in vtkStructuredGrid, and vtkUniformGrid.

Definition at line 341 of file vtkDataSet.h.

virtual bool vtkDataSet::HasAnyBlankPoints ( )

inlinevirtual

Returns 1 if there are any blanking points 0 otherwise. Blanking is supported only for vtkStructuredGrid and vtkUniformGrid

Reimplemented in vtkStructuredGrid, and vtkUniformGrid.

Definition at line 349 of file vtkDataSet.h.

vtkUnsignedCharArray* vtkDataSet::GetPointGhostArray ( )

Gets the array that defines the ghost type of each point. We cache the pointer to the array to save a lookup involving string comparisons

void vtkDataSet::UpdatePointGhostArrayCache ( )

Updates the pointer to the point ghost array.

vtkUnsignedCharArray* vtkDataSet::AllocatePointGhostArray ( )

Allocate ghost array for points.

vtkUnsignedCharArray* vtkDataSet::GetCellGhostArray ( )

Get the array that defines the ghost type of each cell. We cache the pointer to the array to save a lookup involving string comparisons

void vtkDataSet::UpdateCellGhostArrayCache ( )

Updates the pointer to the cell ghost array.

vtkUnsignedCharArray* vtkDataSet::AllocateCellGhostArray ( )

Allocate ghost array for cells.

virtual void vtkDataSet::ComputeScalarRange ( )

protectedvirtual

Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (ScalarRangeComputeTime).

Reimplemented in vtkStructuredGrid, and vtkUniformGrid.

bool vtkDataSet::IsAnyBitSet	(	vtkUnsignedCharArray *	a,
		int	bitFlag
	)

protected

Helper function that tests if any of the values in 'a' have bitFlag set. The test performed is (value & bitFlag).

Friends And Related Function Documentation

friend class vtkImageAlgorithmToDataSetFriendship

friend

Definition at line 418 of file vtkDataSet.h.

Member Data Documentation

vtkCellData* vtkDataSet::CellData

protected

Definition at line 387 of file vtkDataSet.h.

vtkPointData* vtkDataSet::PointData

protected

Definition at line 388 of file vtkDataSet.h.

vtkCallbackCommand* vtkDataSet::DataObserver

protected

Definition at line 389 of file vtkDataSet.h.

vtkTimeStamp vtkDataSet::ComputeTime

protected

Definition at line 390 of file vtkDataSet.h.

double vtkDataSet::Bounds[6]

protected

Definition at line 391 of file vtkDataSet.h.

double vtkDataSet::Center[3]

protected

Definition at line 392 of file vtkDataSet.h.

double vtkDataSet::ScalarRange[2]

protected

Definition at line 395 of file vtkDataSet.h.

vtkTimeStamp vtkDataSet::ScalarRangeComputeTime

protected

Definition at line 398 of file vtkDataSet.h.

vtkUnsignedCharArray* vtkDataSet::PointGhostArray

protected

These arrays pointers are caches used to avoid a string comparision (when getting ghost arrays using GetArray(name))

Definition at line 403 of file vtkDataSet.h.

vtkUnsignedCharArray* vtkDataSet::CellGhostArray

protected

These arrays pointers are caches used to avoid a string comparision (when getting ghost arrays using GetArray(name))

Definition at line 404 of file vtkDataSet.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkDataSet.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation