Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkUniformGrid Class Reference

#include <vtkUniformGrid.h>

Inheritance diagram for vtkUniformGrid:

Inheritance graph
[legend]
Collaboration diagram for vtkUniformGrid:

Collaboration graph
[legend]
List of all members.

Detailed Description

topologically and geometrically regular array of data

Date
2003/12/11 15:47:37
Revision
1.1

vtkUniformGrid is a data object that is a concrete implementation of vtkDataSet. vtkUniformGrid represents a geometric structure that is a topological and geometrical regular array of points. vtkUniformGrid is essentially a simple vtkImageData that supports blanking.

Examples:
vtkUniformGrid (Examples)
Tests:
vtkUniformGrid (Tests)

Definition at line 51 of file vtkUniformGrid.h.

Public Types

typedef vtkDataSet Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void CopyStructure (vtkDataSet *ds)
int GetDataObjectType ()
vtkIdType GetNumberOfCells ()
vtkIdType GetNumberOfPoints ()
double * GetPoint (vtkIdType ptId)
void GetPoint (vtkIdType id, double x[3])
vtkCellGetCell (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)
vtkCellFindAndGetCell (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 ()
void Initialize ()
int GetMaxCellSize ()
virtual void GetScalarRange (double range[2])
double * GetScalarRange ()
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void SetUpdateExtent (int piece, int numPieces)
void SetUpdateExtent (int x1, int x2, int y1, int y2, int z1, int z2)
void SetUpdateExtent (int ext[6])
void SetDimensions (int i, int j, int k)
void SetDimensions (int dims[3])
int * GetDimensions ()
void GetDimensions (int dims[3])
int ComputeStructuredCoordinates (double x[3], int ijk[3], double pcoords[3])
int GetDataDimension ()
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])
unsigned long GetActualMemorySize ()
virtual void SetSpacing (double, double, double)
virtual void SetSpacing (double[3])
virtual double * GetSpacing ()
virtual void GetSpacing (double &, double &, double &)
virtual void GetSpacing (double[3])
virtual void SetOrigin (double, double, double)
virtual void SetOrigin (double[3])
virtual double * GetOrigin ()
virtual void GetOrigin (double &, double &, double &)
virtual void GetOrigin (double[3])
void ShallowCopy (vtkDataObject *src)
void DeepCopy (vtkDataObject *src)
int GetExtentType ()
void BlankPoint (vtkIdType ptId)
void UnBlankPoint (vtkIdType ptId)
void BlankCell (vtkIdType ptId)
void UnBlankCell (vtkIdType ptId)
vtkUnsignedCharArrayGetPointVisibilityArray ()
void SetPointVisibilityArray (vtkUnsignedCharArray *pointVisibility)
vtkUnsignedCharArrayGetCellVisibilityArray ()
void SetCellVisibilityArray (vtkUnsignedCharArray *pointVisibility)
unsigned char IsPointVisible (vtkIdType ptId)
unsigned char IsCellVisible (vtkIdType cellId)
unsigned char GetPointBlanking ()
unsigned char GetCellBlanking ()

Static Public Member Functions

static vtkUniformGridNew ()
static int IsTypeOf (const char *type)
static vtkUniformGridSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkUniformGrid ()
 ~vtkUniformGrid ()
void SetPointVisibility (vtkStructuredVisibilityConstraint *pointVisibility)
virtual vtkStructuredVisibilityConstraintGetPointVisibility ()
void SetCellVisibility (vtkStructuredVisibilityConstraint *cellVisibility)
virtual vtkStructuredVisibilityConstraintGetCellVisibility ()

Protected Attributes

vtkVertexVertex
vtkLineLine
vtkPixelPixel
vtkVoxelVoxel
vtkEmptyCellEmptyCell
int Dimensions [3]
int DataDescription
double Origin [3]
double Spacing [3]
vtkStructuredVisibilityConstraintPointVisibility
vtkStructuredVisibilityConstraintCellVisibility


Member Typedef Documentation

typedef vtkDataSet vtkUniformGrid::Superclass
 

Reimplemented from vtkDataSet.

Definition at line 56 of file vtkUniformGrid.h.


Constructor & Destructor Documentation

vtkUniformGrid::vtkUniformGrid  )  [protected]
 

vtkUniformGrid::~vtkUniformGrid  )  [protected]
 


Member Function Documentation

static vtkUniformGrid* vtkUniformGrid::New  )  [static]
 

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkDataObject.

virtual const char* vtkUniformGrid::GetClassName  )  [virtual]
 

Reimplemented from vtkDataSet.

static int vtkUniformGrid::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkDataSet.

virtual int vtkUniformGrid::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkDataSet.

static vtkUniformGrid* vtkUniformGrid::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkDataSet.

void vtkUniformGrid::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 vtkDataSet.

void vtkUniformGrid::CopyStructure vtkDataSet ds  )  [virtual]
 

Copy the geometric and topological structure of an input image data object.

Implements vtkDataSet.

int vtkUniformGrid::GetDataObjectType  )  [inline, virtual]
 

Return what type of dataset this is.

Reimplemented from vtkDataSet.

Definition at line 64 of file vtkUniformGrid.h.

References VTK_UNIFORM_GRID.

vtkIdType vtkUniformGrid::GetNumberOfCells  )  [virtual]
 

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

vtkIdType vtkUniformGrid::GetNumberOfPoints  )  [inline, virtual]
 

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

Implements vtkDataSet.

Definition at line 275 of file vtkUniformGrid.h.

References GetDimensions().

double* vtkUniformGrid::GetPoint vtkIdType  ptId  )  [virtual]
 

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

Implements vtkDataSet.

Referenced by GetPoint().

void vtkUniformGrid::GetPoint vtkIdType  id,
double  x[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 from vtkDataSet.

Definition at line 267 of file vtkUniformGrid.h.

References GetPoint().

vtkCell* vtkUniformGrid::GetCell vtkIdType  cellId  )  [virtual]
 

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

Implements vtkDataSet.

void vtkUniformGrid::GetCell vtkIdType  cellId,
vtkGenericCell cell
[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

Implements vtkDataSet.

void vtkUniformGrid::GetCellBounds vtkIdType  cellId,
double  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 from vtkDataSet.

vtkIdType vtkUniformGrid::FindPoint double  x,
double  y,
double  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 from vtkDataSet.

Definition at line 75 of file vtkUniformGrid.h.

References vtkDataSet::FindPoint().

vtkIdType vtkUniformGrid::FindPoint double  x[3]  )  [virtual]
 

Implements vtkDataSet.

vtkIdType vtkUniformGrid::FindCell double  x[3],
vtkCell cell,
vtkIdType  cellId,
double  tol2,
int &  subId,
double  pcoords[3],
double *  weights
[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.

Implements vtkDataSet.

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

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

Implements vtkDataSet.

vtkCell* vtkUniformGrid::FindAndGetCell double  x[3],
vtkCell cell,
vtkIdType  cellId,
double  tol2,
int &  subId,
double  pcoords[3],
double *  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 from vtkDataSet.

int vtkUniformGrid::GetCellType vtkIdType  cellId  )  [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

Implements vtkDataSet.

void vtkUniformGrid::GetCellPoints vtkIdType  cellId,
vtkIdList ptIds
[inline, 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

Implements vtkDataSet.

Definition at line 86 of file vtkUniformGrid.h.

References vtkStructuredData::GetCellPoints().

void vtkUniformGrid::GetPointCells vtkIdType  ptId,
vtkIdList cellIds
[inline, 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

Implements vtkDataSet.

Definition at line 89 of file vtkUniformGrid.h.

References vtkStructuredData::GetPointCells().

void vtkUniformGrid::ComputeBounds  )  [virtual]
 

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

Reimplemented from vtkDataSet.

void vtkUniformGrid::Initialize  )  [virtual]
 

Restore data object to initial state, THIS METHOD IS NOT THREAD SAFE.

Reimplemented from vtkDataSet.

int vtkUniformGrid::GetMaxCellSize  )  [inline, 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

Implements vtkDataSet.

Definition at line 93 of file vtkUniformGrid.h.

virtual void vtkUniformGrid::GetScalarRange double  range[2]  )  [virtual]
 

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

Reimplemented from vtkDataSet.

double* vtkUniformGrid::GetScalarRange  )  [inline]
 

Convenience method to get the range of the scalar data (if there is any scalar data). THIS METHOD IS NOT THREAD SAFE.

Reimplemented from vtkDataSet.

Definition at line 95 of file vtkUniformGrid.h.

void vtkUniformGrid::SetUpdateExtent int  piece,
int  numPieces,
int  ghostLevel
 

For streaming. User/next filter specifies which piece the want updated. The source of this data has to return exactly this piece.

void vtkUniformGrid::SetUpdateExtent int  piece,
int  numPieces
[inline]
 

Reimplemented from vtkDataObject.

Definition at line 102 of file vtkUniformGrid.h.

References vtkDataObject::SetUpdateExtent().

void vtkUniformGrid::SetUpdateExtent int  x1,
int  x2,
int  y1,
int  y2,
int  z1,
int  z2
[inline, virtual]
 

Call superclass method to avoid hiding Since this data type does not use 3D extents, this set method is useless but necessary since vtkDataSetToDataSetFilter does not know what type of data it is working on.

Reimplemented from vtkDataObject.

Definition at line 111 of file vtkUniformGrid.h.

void vtkUniformGrid::SetUpdateExtent int  ext[6]  )  [inline, virtual]
 

Reimplemented from vtkDataObject.

Definition at line 113 of file vtkUniformGrid.h.

void vtkUniformGrid::SetDimensions int  i,
int  j,
int  k
 

Set dimensions of structured points dataset.

void vtkUniformGrid::SetDimensions int  dims[3]  ) 
 

Set dimensions of structured points dataset.

int* vtkUniformGrid::GetDimensions  ) 
 

Get dimensions of this structured points dataset. Dimensions are computed from Extents during this call.

Referenced by GetNumberOfPoints().

void vtkUniformGrid::GetDimensions int  dims[3]  ) 
 

int vtkUniformGrid::ComputeStructuredCoordinates double  x[3],
int  ijk[3],
double  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.

int vtkUniformGrid::GetDataDimension  )  [inline]
 

Return the dimensionality of the data.

Definition at line 281 of file vtkUniformGrid.h.

References vtkStructuredData::GetDataDimension().

void vtkUniformGrid::SetExtent int  extent[6]  ) 
 

Description: 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 vtkUniformGrid::SetExtent int  x1,
int  x2,
int  y1,
int  y2,
int  z1,
int  z2
 

virtual int* vtkUniformGrid::GetExtent  )  [virtual]
 

virtual void vtkUniformGrid::GetExtent int &  ,
int &  ,
int &  ,
int &  ,
int &  ,
int & 
[virtual]
 

virtual void vtkUniformGrid::GetExtent int  [6]  )  [virtual]
 

unsigned long vtkUniformGrid::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 vtkDataSet.

virtual void vtkUniformGrid::SetSpacing double  ,
double  ,
double 
[virtual]
 

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

virtual void vtkUniformGrid::SetSpacing double  [3]  )  [virtual]
 

virtual double* vtkUniformGrid::GetSpacing  )  [virtual]
 

virtual void vtkUniformGrid::GetSpacing double &  ,
double &  ,
double & 
[virtual]
 

virtual void vtkUniformGrid::GetSpacing double  [3]  )  [virtual]
 

virtual void vtkUniformGrid::SetOrigin double  ,
double  ,
double 
[virtual]
 

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

virtual void vtkUniformGrid::SetOrigin double  [3]  )  [virtual]
 

virtual double* vtkUniformGrid::GetOrigin  )  [virtual]
 

virtual void vtkUniformGrid::GetOrigin double &  ,
double &  ,
double & 
[virtual]
 

virtual void vtkUniformGrid::GetOrigin double  [3]  )  [virtual]
 

void vtkUniformGrid::ShallowCopy vtkDataObject src  )  [virtual]
 

Shallow and Deep copy.

Reimplemented from vtkDataSet.

void vtkUniformGrid::DeepCopy vtkDataObject src  )  [virtual]
 

Reimplemented from vtkDataSet.

int vtkUniformGrid::GetExtentType  )  [inline, virtual]
 

The extent type is a 3D extent

Reimplemented from vtkDataObject.

Definition at line 177 of file vtkUniformGrid.h.

References VTK_3D_EXTENT.

void vtkUniformGrid::BlankPoint vtkIdType  ptId  ) 
 

Methods for supporting blanking of cells. Blanking turns on or off points in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set.

void vtkUniformGrid::UnBlankPoint vtkIdType  ptId  ) 
 

void vtkUniformGrid::BlankCell vtkIdType  ptId  ) 
 

Methods for supporting blanking of cells. Blanking turns on or off cells in the structured grid. These methods should be called only after the dimensions of the grid are set.

void vtkUniformGrid::UnBlankCell vtkIdType  ptId  ) 
 

vtkUnsignedCharArray* vtkUniformGrid::GetPointVisibilityArray  ) 
 

Get the array that defines the blanking (visibility) of each point.

void vtkUniformGrid::SetPointVisibilityArray vtkUnsignedCharArray pointVisibility  ) 
 

Set an array that defines the (blanking) visibility of the points in the grid. Make sure that length of the visibility array matches the number of points in the grid.

vtkUnsignedCharArray* vtkUniformGrid::GetCellVisibilityArray  ) 
 

Get the array that defines the blanking (visibility) of each cell.

void vtkUniformGrid::SetCellVisibilityArray vtkUnsignedCharArray pointVisibility  ) 
 

Set an array that defines the (blanking) visibility of the cells in the grid. Make sure that length of the visibility array matches the number of points in the grid.

unsigned char vtkUniformGrid::IsPointVisible vtkIdType  ptId  ) 
 

Return non-zero value if specified point is visible. These methods should be called only after the dimensions of the grid are set.

unsigned char vtkUniformGrid::IsCellVisible vtkIdType  cellId  ) 
 

Return non-zero value if specified point is visible. These methods should be called only after the dimensions of the grid are set.

unsigned char vtkUniformGrid::GetPointBlanking  ) 
 

Returns 1 if there is any visibility constraint on the points, 0 otherwise.

unsigned char vtkUniformGrid::GetCellBlanking  ) 
 

Returns 1 if there is any visibility constraint on the cells, 0 otherwise.

void vtkUniformGrid::SetPointVisibility vtkStructuredVisibilityConstraint pointVisibility  )  [protected]
 

virtual vtkStructuredVisibilityConstraint* vtkUniformGrid::GetPointVisibility  )  [protected, virtual]
 

void vtkUniformGrid::SetCellVisibility vtkStructuredVisibilityConstraint cellVisibility  )  [protected]
 

virtual vtkStructuredVisibilityConstraint* vtkUniformGrid::GetCellVisibility  )  [protected, virtual]
 


Member Data Documentation

vtkVertex* vtkUniformGrid::Vertex [protected]
 

Definition at line 233 of file vtkUniformGrid.h.

vtkLine* vtkUniformGrid::Line [protected]
 

Definition at line 234 of file vtkUniformGrid.h.

vtkPixel* vtkUniformGrid::Pixel [protected]
 

Definition at line 235 of file vtkUniformGrid.h.

vtkVoxel* vtkUniformGrid::Voxel [protected]
 

Definition at line 236 of file vtkUniformGrid.h.

vtkEmptyCell* vtkUniformGrid::EmptyCell [protected]
 

Definition at line 237 of file vtkUniformGrid.h.

int vtkUniformGrid::Dimensions[3] [protected]
 

Definition at line 242 of file vtkUniformGrid.h.

int vtkUniformGrid::DataDescription [protected]
 

Definition at line 243 of file vtkUniformGrid.h.

double vtkUniformGrid::Origin[3] [protected]
 

Definition at line 245 of file vtkUniformGrid.h.

double vtkUniformGrid::Spacing[3] [protected]
 

Definition at line 246 of file vtkUniformGrid.h.

vtkStructuredVisibilityConstraint* vtkUniformGrid::PointVisibility [protected]
 

Definition at line 248 of file vtkUniformGrid.h.

vtkStructuredVisibilityConstraint* vtkUniformGrid::CellVisibility [protected]
 

Definition at line 251 of file vtkUniformGrid.h.


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