Man Page for vtkStructuredPoints
Table of Contents

NAME

vtkStructuredPoints - topologically and geometrically regular array of data

SYNOPSIS


#include "/opt/vtk-c++/common/vtkStructuredPoints.h"

class VTK_EXPORT vtkStructuredPoints : public vtkDataSet

vtkStructuredPoints();
vtkStructuredPoints(const vtkStructuredPoints& v);
~vtkStructuredPoints();
static vtkStructuredPoints *New() {return new vtkStructuredPoints;};
const char *GetClassName() {return "vtkStructuredPoints";};
char *GetDataType() {return "vtkStructuredPoints";};
void PrintSelf(ostream& os, vtkIndent indent);
vtkDataSet *MakeObject() {return new vtkStructuredPoints(*this);};
void CopyStructure(vtkDataSet *ds);
int GetNumberOfCells();
int GetNumberOfPoints();
float *GetPoint(int ptId);
void GetPoint(int id, float x[3]);
vtkCell *GetCell(int cellId);
int FindPoint(float x[3]);
int FindCell(float x[3], vtkCell *cell, int cellId, float tol2, int& subId,
float pcoords[3], float *weights);
vtkCell *FindAndGetCell(float x[3], vtkCell *cell, int cellId,
float tol2, int& subId, float pcoords[3], float *weights);
int GetCellType(int cellId);
void GetCellPoints(int cellId, vtkIdList& ptIds);
void GetPointCells(int ptId, vtkIdList& cellIds);
void ComputeBounds();

int GetMaxCellSize() {return 8;};
voxel is the largest
void SetDimensions(int i, int j, int k);
void SetDimensions(int dim[3]);
int *GetDimensions();
void GetDimensions(int data[3]);
void SetSpacing(float, float, float);
void SetSpacing(float *);
float *GetSpacing();
void GetSpacing(float data[3]);
void SetOrigin(float, float, float);
void SetOrigin(float *);
float *GetOrigin();
void GetOrigin(float data[3]);
int ComputeStructuredCoordinates(float x[3], int ijk[3], float pcoords[3]);
void GetVoxelGradient(int i,int j,int k, vtkScalars *s, vtkFloatVectors& g);
void GetPointGradient(int i, int j, int k, vtkScalars *s, float g[3]);
int GetDataDimension();
int ComputePointId(int ijk[3]);
int ComputeCellId(int ijk[3]);
vtkStructuredPointsToImage *GetStructuredPointsToImage();

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.

SUMMARY

int *GetDimensions()
void GetDimensions(int data[3])
Get dimensions of this structured points dataset.

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

void SetOrigin(float, float, float)
void SetOrigin(float *)
Set the origin of the data. The origin plus spacing determine the position in space of the structured points.

void GetPoint(int id, float x[3])
This method is used translparently by the "SetInput(vtkStructuredPoints *)" method to connect the visualization pipeline to the image pipeline..

int ComputePointId(int ijk[3])
Given a location in structured coordinates (i-j-k), return the point id.

int ComputeCellId(int ijk[3])
Given a location in structured coordinates (i-j-k), return the cell id.

void CopyStructure(vtkDataSet *ds)
Copy the geometric and topological structure of an input structured points object.

void GetVoxelGradient(int i, int j, int k, vtkScalars *s, vtkFloatVectors&
g)
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 GetPointGradient(int i,int j,int k, vtkScalars *s, float g[3])
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 SetDimensions(int i, int j, int k)
Set dimensions of structured points dataset.

void SetDimensions(int dim[3])
Set dimensions of structured points dataset.

int ComputeStructuredCoordinates(float x[3], int ijk[3], float pcoords[3])
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.


Table of Contents