VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkRectilinearGrid Class Reference

a dataset that is topologically regular with variable spacing in the three coordinate directions More...

#include <vtkRectilinearGrid.h>

Inherits vtkDataSet.

Collaboration diagram for vtkRectilinearGrid:
[legend]

Public Types

typedef vtkDataSet Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkRectilinearGridNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int GetDataObjectType ()
 
void CopyStructure (vtkDataSet *ds)
 
void Initialize ()
 
void GetPoints (vtkPoints *pnts)
 
int GetDataDimension ()
 
int ComputeStructuredCoordinates (double x[3], int ijk[3], double pcoords[3])
 
vtkIdType ComputePointId (int ijk[3])
 
vtkIdType ComputeCellId (int ijk[3])
 
void GetPoint (const int i, const int j, const int k, double p[3])
 
unsigned long GetActualMemorySize ()
 
int GetExtentType ()
 
virtual void Crop (const int *updateExtent)
 
vtkIdType GetNumberOfCells ()
 
vtkIdType GetNumberOfPoints ()
 
double * GetPoint (vtkIdType ptId)
 
void GetPoint (vtkIdType id, double x[3])
 
vtkCell * GetCell (vtkIdType cellId)
 
void GetCell (vtkIdType cellId, vtkGenericCell *cell)
 
void GetCellBounds (vtkIdType cellId, double bounds[6])
 
vtkIdType FindPoint (double x, double y, double z)
 
vtkIdType FindPoint (double x[3])
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 
vtkCell * FindAndGetCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 
int GetCellType (vtkIdType cellId)
 
void GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)
 
void GetPointCells (vtkIdType ptId, vtkIdList *cellIds)
 
void ComputeBounds ()
 
int GetMaxCellSize ()
 
void GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds)
 
void SetDimensions (int i, int j, int k)
 
void SetDimensions (int dim[3])
 
virtual int * GetDimensions ()
 
virtual void GetDimensions (int data[3])
 
virtual void SetXCoordinates (vtkDataArray *)
 
virtual vtkDataArray * GetXCoordinates ()
 
virtual void SetYCoordinates (vtkDataArray *)
 
virtual vtkDataArray * GetYCoordinates ()
 
virtual void SetZCoordinates (vtkDataArray *)
 
virtual vtkDataArray * GetZCoordinates ()
 
void SetExtent (int extent[6])
 
void SetExtent (int x1, int x2, int y1, int y2, int z1, int z2)
 
virtual int * GetExtent ()
 
virtual void GetExtent (int &, int &, int &, int &, int &, int &)
 
virtual void GetExtent (int[6])
 
void ShallowCopy (vtkDataObject *src)
 
void DeepCopy (vtkDataObject *src)
 

Static Public Member Functions

static vtkRectilinearGridNew ()
 
static int IsTypeOf (const char *type)
 
static vtkRectilinearGridSafeDownCast (vtkObjectBase *o)
 
static vtkRectilinearGridGetData (vtkInformation *info)
 
static vtkRectilinearGridGetData (vtkInformationVector *v, int i=0)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkRectilinearGrid ()
 
 ~vtkRectilinearGrid ()
 

Protected Attributes

vtkVertexVertex
 
vtkLine * Line
 
vtkPixelPixel
 
vtkVoxel * Voxel
 
int Dimensions [3]
 
int DataDescription
 
int Extent [6]
 
vtkDataArray * XCoordinates
 
vtkDataArray * YCoordinates
 
vtkDataArray * ZCoordinates
 
double PointReturn [3]
 

Detailed Description

a dataset that is topologically regular with variable spacing in the three coordinate directions

vtkRectilinearGrid is a data object that is a concrete implementation of vtkDataSet. vtkRectilinearGrid represents a geometric structure that is topologically regular with variable spacing in the three coordinate directions x-y-z.

To define a vtkRectilinearGrid, you must specify the dimensions of the data and provide three arrays of values specifying the coordinates along the x-y-z axes. The coordinate arrays are specified using three vtkDataArray objects (one for x, one for y, one for z).

Warning
Make sure that the dimensions of the grid match the number of coordinates in the x-y-z directions. If not, unpredictable results (including program failure) may result. Also, you must supply coordinates in all three directions, even if the dataset topology is 2D, 1D, or 0D.
Examples:
vtkRectilinearGrid (Examples)
Tests:
vtkRectilinearGrid (Tests)

Definition at line 55 of file vtkRectilinearGrid.h.

Member Typedef Documentation

typedef vtkDataSet vtkRectilinearGrid::Superclass

Definition at line 60 of file vtkRectilinearGrid.h.

Constructor & Destructor Documentation

vtkRectilinearGrid::vtkRectilinearGrid ( )
protected
vtkRectilinearGrid::~vtkRectilinearGrid ( )
protected

Member Function Documentation

static vtkRectilinearGrid* vtkRectilinearGrid::New ( )
static
static int vtkRectilinearGrid::IsTypeOf ( const char *  type)
static
virtual int vtkRectilinearGrid::IsA ( const char *  type)
virtual
static vtkRectilinearGrid* vtkRectilinearGrid::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkRectilinearGrid::NewInstanceInternal ( ) const
protectedvirtual
vtkRectilinearGrid* vtkRectilinearGrid::NewInstance ( ) const
void vtkRectilinearGrid::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
int vtkRectilinearGrid::GetDataObjectType ( )
inline

Return what type of dataset this is.

Definition at line 64 of file vtkRectilinearGrid.h.

void vtkRectilinearGrid::CopyStructure ( vtkDataSet *  ds)

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

void vtkRectilinearGrid::Initialize ( )

Restore object to initial state. Release memory back to system.

vtkIdType vtkRectilinearGrid::GetNumberOfCells ( )
inline

Standard vtkDataSet API methods. See vtkDataSet for more information.

Definition at line 230 of file vtkRectilinearGrid.h.

vtkIdType vtkRectilinearGrid::GetNumberOfPoints ( )
inline

Standard vtkDataSet API methods. See vtkDataSet for more information.

Definition at line 251 of file vtkRectilinearGrid.h.

double* vtkRectilinearGrid::GetPoint ( vtkIdType  ptId)

Standard vtkDataSet API methods. See vtkDataSet for more information.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

vtkCell* vtkRectilinearGrid::GetCell ( vtkIdType  cellId)

Standard vtkDataSet API methods. See vtkDataSet for more information.

void vtkRectilinearGrid::GetCell ( vtkIdType  cellId,
vtkGenericCell cell 
)

Standard vtkDataSet API methods. See vtkDataSet for more information.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

vtkIdType vtkRectilinearGrid::FindPoint ( double  x,
double  y,
double  z 
)
inline

Standard vtkDataSet API methods. See vtkDataSet for more information.

Definition at line 82 of file vtkRectilinearGrid.h.

vtkIdType vtkRectilinearGrid::FindPoint ( double  x[3])

Standard vtkDataSet API methods. See vtkDataSet for more information.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

int vtkRectilinearGrid::GetCellType ( vtkIdType  cellId)

Standard vtkDataSet API methods. See vtkDataSet for more information.

void vtkRectilinearGrid::GetCellPoints ( vtkIdType  cellId,
vtkIdList *  ptIds 
)
inline

Standard vtkDataSet API methods. See vtkDataSet for more information.

Definition at line 93 of file vtkRectilinearGrid.h.

void vtkRectilinearGrid::GetPointCells ( vtkIdType  ptId,
vtkIdList *  cellIds 
)
inline

Standard vtkDataSet API methods. See vtkDataSet for more information.

Definition at line 96 of file vtkRectilinearGrid.h.

void vtkRectilinearGrid::ComputeBounds ( )

Standard vtkDataSet API methods. See vtkDataSet for more information.

int vtkRectilinearGrid::GetMaxCellSize ( )
inline

Standard vtkDataSet API methods. See vtkDataSet for more information.

Definition at line 99 of file vtkRectilinearGrid.h.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

void vtkRectilinearGrid::GetPoints ( vtkPoints *  pnts)

Given a user-supplied vtkPoints container object, this method fills in all the points of the RectilinearGrid.

void vtkRectilinearGrid::SetDimensions ( int  i,
int  j,
int  k 
)

Set dimensions of rectilinear grid dataset. This also sets the extent.

void vtkRectilinearGrid::SetDimensions ( int  dim[3])

Set dimensions of rectilinear grid dataset. This also sets the extent.

virtual int* vtkRectilinearGrid::GetDimensions ( )
virtual

Get dimensions of this rectilinear grid dataset.

virtual void vtkRectilinearGrid::GetDimensions ( int  data[3])
virtual

Get dimensions of this rectilinear grid dataset.

int vtkRectilinearGrid::GetDataDimension ( )
inline

Return the dimensionality of the data.

Definition at line 257 of file vtkRectilinearGrid.h.

int vtkRectilinearGrid::ComputeStructuredCoordinates ( double  x[3],
int  ijk[3],
double  pcoords[3] 
)

Convenience function computes the structured coordinates for a point x[3]. The cell 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 grid, and a 1 if inside the grid.

vtkIdType vtkRectilinearGrid::ComputePointId ( int  ijk[3])
inline

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

Definition at line 263 of file vtkRectilinearGrid.h.

vtkIdType vtkRectilinearGrid::ComputeCellId ( int  ijk[3])
inline

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

Definition at line 269 of file vtkRectilinearGrid.h.

void vtkRectilinearGrid::GetPoint ( const int  i,
const int  j,
const int  k,
double  p[3] 
)

Given the IJK-coordinates of the point, it returns the corresponding xyz-coordinates. The xyz coordinates are stored in the user-supplied array p.

virtual void vtkRectilinearGrid::SetXCoordinates ( vtkDataArray *  )
virtual

Specify the grid coordinates in the x-direction.

virtual vtkDataArray* vtkRectilinearGrid::GetXCoordinates ( )
virtual

Specify the grid coordinates in the x-direction.

virtual void vtkRectilinearGrid::SetYCoordinates ( vtkDataArray *  )
virtual

Specify the grid coordinates in the y-direction.

virtual vtkDataArray* vtkRectilinearGrid::GetYCoordinates ( )
virtual

Specify the grid coordinates in the y-direction.

virtual void vtkRectilinearGrid::SetZCoordinates ( vtkDataArray *  )
virtual

Specify the grid coordinates in the z-direction.

virtual vtkDataArray* vtkRectilinearGrid::GetZCoordinates ( )
virtual

Specify the grid coordinates in the z-direction.

void vtkRectilinearGrid::SetExtent ( int  extent[6])

Different ways to set the extent of the data array. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).

void vtkRectilinearGrid::SetExtent ( int  x1,
int  x2,
int  y1,
int  y2,
int  z1,
int  z2 
)

Different ways to set the extent of the data array. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).

virtual int* vtkRectilinearGrid::GetExtent ( )
virtual

Different ways to set the extent of the data array. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).

virtual void vtkRectilinearGrid::GetExtent ( int &  ,
int &  ,
int &  ,
int &  ,
int &  ,
int &   
)
virtual

Different ways to set the extent of the data array. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).

virtual void vtkRectilinearGrid::GetExtent ( int  [6])
virtual

Different ways to set the extent of the data array. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).

unsigned long vtkRectilinearGrid::GetActualMemorySize ( )

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.

void vtkRectilinearGrid::ShallowCopy ( vtkDataObject src)

Shallow and Deep copy.

void vtkRectilinearGrid::DeepCopy ( vtkDataObject src)

Shallow and Deep copy.

int vtkRectilinearGrid::GetExtentType ( )
inline

Structured extent. The extent type is a 3D extent

Definition at line 184 of file vtkRectilinearGrid.h.

virtual void vtkRectilinearGrid::Crop ( const int *  updateExtent)
virtual

Reallocates and copies to set the Extent to the UpdateExtent. This is used internally when the exact extent is requested, and the source generated more than the update extent.

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

Retrieve an instance of this class from an information object.

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

Retrieve an instance of this class from an information object.

Member Data Documentation

vtkVertex* vtkRectilinearGrid::Vertex
protected

Definition at line 204 of file vtkRectilinearGrid.h.

vtkLine* vtkRectilinearGrid::Line
protected

Definition at line 205 of file vtkRectilinearGrid.h.

vtkPixel* vtkRectilinearGrid::Pixel
protected

Definition at line 206 of file vtkRectilinearGrid.h.

vtkVoxel* vtkRectilinearGrid::Voxel
protected

Definition at line 207 of file vtkRectilinearGrid.h.

int vtkRectilinearGrid::Dimensions[3]
protected

Definition at line 209 of file vtkRectilinearGrid.h.

int vtkRectilinearGrid::DataDescription
protected

Definition at line 210 of file vtkRectilinearGrid.h.

int vtkRectilinearGrid::Extent[6]
protected

Definition at line 212 of file vtkRectilinearGrid.h.

vtkDataArray* vtkRectilinearGrid::XCoordinates
protected

Definition at line 214 of file vtkRectilinearGrid.h.

vtkDataArray* vtkRectilinearGrid::YCoordinates
protected

Definition at line 215 of file vtkRectilinearGrid.h.

vtkDataArray* vtkRectilinearGrid::ZCoordinates
protected

Definition at line 216 of file vtkRectilinearGrid.h.

double vtkRectilinearGrid::PointReturn[3]
protected

Definition at line 219 of file vtkRectilinearGrid.h.


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