Documentation for vtkDataSet

vtkDataSet - abstract class to specify dataset behavior

Description:

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, eithoer one, or none.

See Also:

vtkPointSet vtkStructuredPoints vtkStructuredGrid vtkUnstructuredGrid vtkRectilinearGrid vtkPolyData vtkPointData vtkCellData vtkDataObject vtkField

Methods:

	void vtkDataSet ()
	void vtkDataSet ()
	void vtkDataSet (const vtkDataSet &)
	const char *GetClassName ()
	void PrintSelf (unknown & ,vtkIndent )
	void CopyStructure (vtkDataSet *)
	int GetDataSetType ()
	int GetNumberOfPoints ()
	int GetNumberOfCells ()
	float *GetPoint (int )
	void GetPoint (int ,float )
	vtkCell *GetCell (int )
	int GetCellType (int )
	void GetCellTypes (vtkCellTypes *)
	void GetCellPoints (int ,vtkIdList *)
	void GetPointCells (int ,vtkIdList *)
	void GetCellNeighbors (int ,vtkIdList * ,vtkIdList *)
	int FindPoint (float )
	int FindCell (float ,vtkCell * ,int ,float ,int & ,float ,float *)
	vtkCell FindAndGetCell (float ,vtkCell ,int ,float ,int & ,float ,float *)
	unsigned long GetMTime ()
	vtkCellData *GetCellData ()
	vtkPointData *GetPointData ()
	void Squeeze ()
	void ComputeBounds ()
	float *GetBounds ()
	void GetBounds (float )
	float *GetCenter ()
	void GetCenter (float )
	float GetLength ()
	void Initialize ()
	void GetScalarRange (float )
	float *GetScalarRange ()
	int GetMaxCellSize ()
	void GetCellPoints (int ,vtkIdList &)
	void GetPointCells (int ,vtkIdList &)
	void GetCellNeighbors (int ,vtkIdList & ,vtkIdList &)

Detailed Method Descriptions:

Constructor with default bounds (0,1, 0,1, 0,1).

void vtkDataSet ()

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.

void CopyStructure (vtkDataSet *)

Return class name of data type. This is one of VTK_STRUCTURED_GRID, VTK_STRUCTURED_POINTS, VTK_UNSTRUCTURED_GRID, VTK_POLY_DATA, or VTK_RECTILINEAR_GRID (see vtkSetGet.h for definitions).

int GetDataSetType ()

Determine the number of points composing the dataset.

int GetNumberOfPoints ()

Determine the number of cells composing the dataset.

int GetNumberOfCells ()

Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints.

float *GetPoint (int )

Copy point coordinates into user provided array x[3] for specified point id.

void GetPoint (int ,float )

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

vtkCell *GetCell (int )

Get type of cell with cellId such that: 0 <= cellId < NumberOfCells.

int GetCellType (int )

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.

void GetCellTypes (vtkCellTypes *)

Topological inquiry to get points defining cell.

void GetCellPoints (int ,vtkIdList *)

Topological inquiry to get cells using point.

void GetPointCells (int ,vtkIdList *)

Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId).

void GetCellNeighbors (int ,vtkIdList * ,vtkIdList *)

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

int FindPoint (float )

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.

int FindCell (float ,vtkCell * ,int ,float ,int & ,float ,float *)

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.

vtkCell *FindAndGetCell (float ,vtkCell * ,int ,float ,int & ,float ,float *)

Datasets are composite objects and need to check each part for MTime

unsigned long GetMTime ()

return pointer to this dataset's point data

	vtkCellData *GetCellData ()
	vtkPointData *GetPointData ()

Reclaim any extra memory used to store data.

void Squeeze ()

Compute the data bounding box from data points.

void ComputeBounds ()

Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).

	float *GetBounds ()
	void GetBounds (float )

Get the center of the bounding box.

	float *GetCenter ()
	void GetCenter (float )

Return the length of the diagonal of the bounding box.

float GetLength ()

Restore data object to initial state,

void Initialize ()

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.

	void GetScalarRange (float )
	float *GetScalarRange ()

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

int GetMaxCellSize ()

For legacy compatibility. Do not use.

	void GetCellPoints (int ,vtkIdList &)
	void GetPointCells (int ,vtkIdList &)