Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkDataSet Class Reference

abstract class to specify dataset behavior. More...

#include <vtkDataSet.h>

Inheritance diagram for vtkDataSet:

Inheritance graph
[legend]
Collaboration diagram for vtkDataSet:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void CopyStructure (vtkDataSet *ds)=0
virtual int GetNumberOfPoints ()=0
virtual int GetNumberOfCells ()=0
virtual float * GetPoint (int ptId)=0
virtual void GetPoint (int id, float x[3])
virtual vtkCell * GetCell (int cellId)=0
virtual void GetCell (int cellId, vtkGenericCell *cell)=0
virtual void GetCellBounds (int cellId, float bounds[6])
virtual int GetCellType (int cellId)=0
virtual void GetCellTypes (vtkCellTypes *types)
virtual void GetCellPoints (int cellId, vtkIdList *ptIds)=0
virtual void GetPointCells (int ptId, vtkIdList *cellIds)=0
virtual void GetCellNeighbors (int cellId, vtkIdList *ptIds, vtkIdList *cellIds)
int FindPoint (float x, float y, float z)
virtual int FindPoint (float x[3])=0
virtual int FindCell (float x[3], vtkCell *cell, int cellId, float tol2, int &subId, float pcoords[3], float *weights)=0
virtual int FindCell (float x[3], vtkCell *cell, vtkGenericCell *gencell, int cellId, float tol2, int &subId, float pcoords[3], float *weights)=0
virtual vtkCell * FindAndGetCell (float x[3], vtkCell *cell, int cellId, float tol2, int &subId, float pcoords[3], float *weights)
unsigned long int GetMTime ()
vtkCellData * GetCellData ()
vtkPointData * GetPointData ()
virtual void Squeeze ()
virtual void ComputeBounds ()
float * GetBounds ()
void GetBounds (float bounds[6])
float * GetCenter ()
void GetCenter (float center[3])
float GetLength ()
void Initialize ()
void GetScalarRange (float range[2])
float * GetScalarRange ()
virtual int GetMaxCellSize ()=0
unsigned long GetActualMemorySize ()
int GetDataObjectType ()
void ShallowCopy (vtkDataObject *src)
void DeepCopy (vtkDataObject *src)
void GetCellPoints (int cellId, vtkIdList &ptIds)
void GetPointCells (int ptId, vtkIdList &cellIds)
void GetCellNeighbors (int cellId, vtkIdList &ptIds, vtkIdList &cellIds)
virtual int GetDataSetType ()

Static Public Methods

int IsTypeOf (const char *type)
vtkDataSet * SafeDownCast (vtkObject *o)

Protected Methods

 vtkDataSet ()
 ~vtkDataSet ()
 vtkDataSet (const vtkDataSet &)
void operator= (const vtkDataSet &)

Protected Attributes

vtkCellData * CellData
vtkPointData * PointData
vtkTimeStamp ComputeTime
float Bounds [6]
float ScalarRange [2]
float Center [3]

Detailed Description

abstract class to specify dataset behavior.

Date:
2000/12/10 20:08:08
Revision:
1.100

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 vtkField
Examples:
vtkDataSet (examples)

Definition at line 78 of file vtkDataSet.h.

Constructor & Destructor Documentation

vtkDataSet::vtkDataSet (    )  [protected]
 

vtkDataSet::~vtkDataSet (    )  [protected]
 

vtkDataSet::vtkDataSet (  const vtkDataSet &    )  [inline, protected]
 

Definition at line 290 of file vtkDataSet.h.

Member Function Documentation

virtual const char* vtkDataSet::GetClassName (    )  [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataObject.

Reimplemented in vtkImageData, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkStructuredPoints, vtkUnstructuredGrid, and vtkImageCanvasSource2D.

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

Return 1 if this class type 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 vtkImageData, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkStructuredPoints, vtkUnstructuredGrid, and vtkImageCanvasSource2D.

virtual int vtkDataSet::IsA (  const char *    type )  [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 vtkImageData, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkStructuredPoints, vtkUnstructuredGrid, and vtkImageCanvasSource2D.

vtkDataSet* vtkDataSet::SafeDownCast (  vtkObject *    o )  [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataObject.

Reimplemented in vtkImageData, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkStructuredPoints, vtkUnstructuredGrid, and vtkImageCanvasSource2D.

Referenced by vtkDataSetCollection::GetItem(), and vtkDataSetCollection::GetNextItem().

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 vtkImageData, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkUnstructuredGrid, and vtkImageCanvasSource2D.

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.

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

virtual int vtkDataSet::GetNumberOfPoints (    )  [pure virtual]
 

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

Reimplemented in vtkImageData, vtkPointSet, vtkRectilinearGrid, and vtkStructuredGrid.

virtual int vtkDataSet::GetNumberOfCells (    )  [pure virtual]
 

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

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

virtual float* vtkDataSet::GetPoint (  int    ptId )  [pure virtual]
 

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

Reimplemented in vtkImageData, vtkPointSet, vtkRectilinearGrid, and vtkStructuredGrid.

Referenced by GetPoint().

void vtkDataSet::GetPoint (  int    ptId,
float    p[3]
)  [inline, virtual]
 

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 vtkImageData, vtkPointSet, vtkRectilinearGrid, and vtkStructuredGrid.

Definition at line 304 of file vtkDataSet.h.

virtual vtkCell* vtkDataSet::GetCell (  int    cellId )  [pure virtual]
 

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

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

virtual void vtkDataSet::GetCell (  int    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

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

virtual void vtkDataSet::GetCellBounds (  int    cellId,
float    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 vtkImageData, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, and vtkUnstructuredGrid.

virtual int vtkDataSet::GetCellType (  int    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

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

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

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

Referenced by vtkUnstructuredGrid::GetCellPoints(), vtkStructuredGrid::GetCellPoints(), vtkRectilinearGrid::GetCellPoints(), vtkPolyData::GetCellPoints(), and vtkImageData::GetCellPoints().

virtual void vtkDataSet::GetPointCells (  int    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

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

Referenced by vtkUnstructuredGrid::GetPointCells(), vtkStructuredGrid::GetPointCells(), vtkRectilinearGrid::GetPointCells(), vtkPolyData::GetPointCells(), and vtkImageData::GetPointCells().

virtual void vtkDataSet::GetCellNeighbors (  int    cellId,
vtkIdList *    ptIds,
vtkIdList *    cellIds
)  [virtual]
 

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

Reimplemented in vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, and vtkUnstructuredGrid.

Referenced by vtkUnstructuredGrid::Links(), vtkPolyData::Links(), and vtkRectilinearGrid::PointReturn().

int vtkDataSet::FindPoint (  float    x,
float    y,
float    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

Reimplemented in vtkImageData, vtkPointSet, and vtkRectilinearGrid.

Definition at line 160 of file vtkDataSet.h.

Referenced by vtkRectilinearGrid::FindPoint(), vtkPointSet::FindPoint(), and vtkImageData::FindPoint().

virtual int vtkDataSet::FindPoint (  float    x[3] )  [pure virtual]
 

Reimplemented in vtkImageData, vtkPointSet, and vtkRectilinearGrid.

virtual int vtkDataSet::FindCell (  float    x[3],
vtkCell *    cell,
int    cellId,
float    tol2,
int &    subId,
float    pcoords[3],
float *    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.

Reimplemented in vtkImageData, vtkPointSet, and vtkRectilinearGrid.

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

This is a version of the above method that can be used with multithreaded applications. A vtkGenericCell must be passes 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

Reimplemented in vtkImageData, vtkPointSet, and vtkRectilinearGrid.

virtual vtkCell* vtkDataSet::FindAndGetCell (  float    x[3],
vtkCell *    cell,
int    cellId,
float    tol2,
int &    subId,
float    pcoords[3],
float *    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 vtkImageData, and vtkRectilinearGrid.

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

vtkCellData* vtkDataSet::GetCellData (    )  [inline]
 

return pointer to this dataset's point data THIS METHOD IS THREAD SAFE

Definition at line 204 of file vtkDataSet.h.

vtkPointData* vtkDataSet::GetPointData (    )  [inline]
 

return pointer to this dataset's point data THIS METHOD IS THREAD SAFE

Definition at line 208 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 vtkPointSet, vtkPolyData, and vtkUnstructuredGrid.

virtual void vtkDataSet::ComputeBounds (    )  [virtual]
 

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

Reimplemented in vtkImageData, vtkPointSet, vtkPolyData, and vtkRectilinearGrid.

float* 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 (  float    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

float* vtkDataSet::GetCenter (    ) 
 

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

void vtkDataSet::GetCenter (  float    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

float 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 vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, and vtkUnstructuredGrid.

void vtkDataSet::GetScalarRange (  float    range[2] ) 
 

Convenience method to get the range of the scalar data (if there is any scalar data). 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: Update needs to be called to create the scalars. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

float* vtkDataSet::GetScalarRange (    ) 
 

Convenience method to get the range of the scalar data (if there is any scalar data). 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

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

unsigned long vtkDataSet::GetActualMemorySize (    )  [virtual]
 

Return the actual size of the data in kilobytes. 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 vtkImageData, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, and vtkUnstructuredGrid.

int vtkDataSet::GetDataObjectType (    )  [inline, virtual]
 

Return the type of data object.

Reimplemented from vtkDataObject.

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

Definition at line 267 of file vtkDataSet.h.

void vtkDataSet::ShallowCopy (  vtkDataObject *    src )  [virtual]
 

Shallow and Deep copy.

Reimplemented from vtkDataObject.

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

void vtkDataSet::DeepCopy (  vtkDataObject *    src )  [virtual]
 

Reimplemented from vtkDataObject.

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

void vtkDataSet::GetCellPoints (  int    cellId,
vtkIdList &    ptIds
)  [inline]
 

For legacy compatibility. Do not use.

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

Definition at line 276 of file vtkDataSet.h.

void vtkDataSet::GetPointCells (  int    ptId,
vtkIdList &    cellIds
)  [inline]
 

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

Definition at line 278 of file vtkDataSet.h.

void vtkDataSet::GetCellNeighbors (  int    cellId,
vtkIdList &    ptIds,
vtkIdList &    cellIds
)  [inline]
 

Definition at line 280 of file vtkDataSet.h.

virtual int vtkDataSet::GetDataSetType (    )  [inline, virtual]
 

Definition at line 282 of file vtkDataSet.h.

void vtkDataSet::operator= (  const vtkDataSet &    )  [inline, protected]
 

Definition at line 291 of file vtkDataSet.h.

Member Data Documentation

vtkCellData* vtkDataSet::CellData [protected]
 

Definition at line 293 of file vtkDataSet.h.

vtkPointData* vtkDataSet::PointData [protected]
 

Definition at line 294 of file vtkDataSet.h.

vtkTimeStamp vtkDataSet::ComputeTime [protected]
 

Definition at line 295 of file vtkDataSet.h.

float vtkDataSet::Bounds[6] [protected]
 

Definition at line 296 of file vtkDataSet.h.

float vtkDataSet::ScalarRange[2] [protected]
 

Definition at line 297 of file vtkDataSet.h.

float vtkDataSet::Center[3] [protected]
 

Definition at line 298 of file vtkDataSet.h.

The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:47:19 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001