Documentation for vtkStructuredPoints

vtkStructuredPoints - topologically and geometrically regular array of data

Super Class: vtkDataSet

Description:

vtkStructuredPoints is a data object that is a concrete implementation of vtkDataSet. vtkStructuredPoints represents a geometric structure that is a topological and geometrical regular array of points. Examples include volumes (voxel data) and pixmaps.

 

Methods:

void vtkStructuredPoints ()
void vtkStructuredPoints (const vtkStructuredPoints &)
void vtkStructuredPoints ()
static vtkStructuredPoints *New ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
vtkDataObject *MakeObject ()
void CopyStructure (vtkDataSet *)
int GetDataSetType ()
int GetNumberOfCells ()
int GetNumberOfPoints ()
float *GetPoint (int )
void GetPoint (int ,float )
vtkCell *GetCell (int )
int FindPoint (float )
int FindCell (float ,vtkCell * ,int ,float ,int & ,float ,float *)
vtkCell *FindAndGetCell (float ,vtkCell * ,int ,float ,int & ,float ,float *)
int GetCellType (int )
void GetCellPoints (int ,vtkIdList *)
void GetPointCells (int ,vtkIdList *)
void ComputeBounds ()
int GetMaxCellSize ()
void SetDimensions (int ,int ,int )
void SetDimensions (int )
int *GetDimensions ()
void SetSpacing (float ,float ,float )
void SetSpacing (float *)
float *GetSpacing ()
void SetOrigin (float ,float ,float )
void SetOrigin (float *)
float *GetOrigin ()
int ComputeStructuredCoordinates (float ,int ,float )
void GetVoxelGradient (int ,int ,int ,vtkScalars * ,vtkVectors *)
void GetPointGradient (int ,int ,int ,vtkScalars * ,float )
int GetDataDimension ()
int ComputePointId (int )
int ComputeCellId (int )
vtkStructuredPointsToImage *GetStructuredPointsToImage ()
void UnRegister (vtkObject *)
void GetCellPoints (int ,vtkIdList &)
void GetPointCells (int ,vtkIdList &)
void GetVoxelGradient (int ,int ,int ,vtkScalars * ,vtkVectors &)

 

Detailed Method Descriptions:

Create a similar type object

vtkDataObject *MakeObject ()

Copy the geometric and topological structure of an input rectilinear grid object.

void CopyStructure (vtkDataSet *)

Return what type of dataset this is.

int GetDataSetType ()

Standard vtkDataSet API methods. See vtkDataSet for more information.

int GetNumberOfCells ()
int GetNumberOfPoints ()
float *GetPoint (int )
void GetPoint (int ,float )
vtkCell *GetCell (int )
int FindPoint (float )
int FindCell (float ,vtkCell * ,int ,float ,int & ,float ,float *)
vtkCell *FindAndGetCell (float ,vtkCell * ,int ,float ,int & ,float ,float *)
int GetCellType (int )
void GetCellPoints (int ,vtkIdList *)
void GetPointCells (int ,vtkIdList *)
void ComputeBounds ()
int GetMaxCellSize ()

Set dimensions of structured points dataset.

void SetDimensions (int ,int ,int )
void SetDimensions (int )

Get dimensions of this structured points dataset.

int *GetDimensions ()

Set the spacing (width,height,length) of the cubical cells that compose the structured point set.

void SetSpacing (float ,float ,float )
void SetSpacing (float *)
float *GetSpacing ()

Set the origin of the data. The origin plus spacing determine the position in space of the structured points.

void SetOrigin (float ,float ,float )
void SetOrigin (float *)
float *GetOrigin ()

Convenience function computes the structured coordinates for a point x[3]. The voxel is specified by the array ijk[3], and the parametric coordinates in the cell are specified with pcoords[3]. The function returns a 0 if the point x is outside of the volume, and a 1 if inside the volume.

int ComputeStructuredCoordinates (float ,int ,float )

Given structured coordinates (i,j,k) for a voxel cell, compute the eight gradient values for the voxel corners. The order in which the gradient vectors are arranged corresponds to the ordering of the voxel points. Gradient vector is computed by central differences (except on edges of volume where forward difference is used). The scalars s are the scalars from which the gradient is to be computed. This method will treat only 3D structured point datasets (i.e., volumes).

void GetVoxelGradient (int ,int ,int ,vtkScalars * ,vtkVectors *)

Given structured coordinates (i,j,k) for a point in a structured point dataset, compute the gradient vector from the scalar data at that point. The scalars s are the scalars from which the gradient is to be computed. This method will treat structured point datasets of any dimension.

void GetPointGradient (int ,int ,int ,vtkScalars * ,float )

Return the dimensionality of the data.

int GetDataDimension ()

Given a location in structured coordinates (i-j-k), return the point id.

int ComputePointId (int )

Given a location in structured coordinates (i-j-k), return the cell id.

int ComputeCellId (int )

This method is used translparently by the "SetInput(vtkStructuredPoints *)" method to connect the visualization pipeline to the image pipeline..

vtkStructuredPointsToImage *GetStructuredPointsToImage ()

Decrease the reference count (release by another object). Also, we need to check for the reference loop StructurePoints<->StructuredPointsToImage to avoid memory leaks.

void UnRegister (vtkObject *)

For legacy compatibility. Do not use.

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