VTK
vtkRectilinearGrid.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkRectilinearGrid.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
36 #ifndef vtkRectilinearGrid_h
37 #define vtkRectilinearGrid_h
38 
39 #include "vtkCommonDataModelModule.h" // For export macro
40 #include "vtkDataSet.h"
41 #include "vtkStructuredData.h" // For inline methods
42 
43 class vtkVertex;
44 class vtkLine;
45 class vtkPixel;
46 class vtkVoxel;
47 class vtkDataArray;
48 class vtkPoints;
49 
50 class VTKCOMMONDATAMODEL_EXPORT vtkRectilinearGrid : public vtkDataSet
51 {
52 public:
53  static vtkRectilinearGrid *New();
54 
56  void PrintSelf(ostream& os, vtkIndent indent) override;
57 
61  int GetDataObjectType() override {return VTK_RECTILINEAR_GRID;};
62 
67  void CopyStructure(vtkDataSet *ds) override;
68 
72  void Initialize() override;
73 
75 
78  vtkIdType GetNumberOfCells() override;
79  vtkIdType GetNumberOfPoints() override;
80  double *GetPoint(vtkIdType ptId) VTK_SIZEHINT(3) override;
81  void GetPoint(vtkIdType id, double x[3]) override;
82  vtkCell *GetCell(vtkIdType cellId) override;
83  vtkCell *GetCell(int i, int j, int k) override;
84  void GetCell(vtkIdType cellId, vtkGenericCell *cell) override;
85  void GetCellBounds(vtkIdType cellId, double bounds[6]) override;
86  vtkIdType FindPoint(double x, double y, double z) { return this->vtkDataSet::FindPoint(x, y, z);};
87  vtkIdType FindPoint(double x[3]) override;
88  vtkIdType FindCell(double x[3], vtkCell *cell, vtkIdType cellId, double tol2,
89  int& subId, double pcoords[3], double *weights) override;
90  vtkIdType FindCell(double x[3], vtkCell *cell, vtkGenericCell *gencell,
91  vtkIdType cellId, double tol2, int& subId,
92  double pcoords[3], double *weights) override;
93  vtkCell *FindAndGetCell(double x[3], vtkCell *cell, vtkIdType cellId,
94  double tol2, int& subId, double pcoords[3],
95  double *weights) override;
96  int GetCellType(vtkIdType cellId) override;
97  void GetCellPoints(vtkIdType cellId, vtkIdList *ptIds) override
98  {vtkStructuredData::GetCellPoints(cellId,ptIds,this->DataDescription,
99  this->Dimensions);}
100  void GetPointCells(vtkIdType ptId, vtkIdList *cellIds) override
101  {vtkStructuredData::GetPointCells(ptId,cellIds,this->Dimensions);}
102  void ComputeBounds() override;
103  int GetMaxCellSize() override {return 8;}; //voxel is the largest
104  void GetCellNeighbors(vtkIdType cellId, vtkIdList *ptIds,
105  vtkIdList *cellIds) override;
107 
112  void GetPoints(vtkPoints* pnts);
113 
115 
119  void SetDimensions(int i, int j, int k);
120  void SetDimensions(int dim[3]);
122 
124 
127  vtkGetVectorMacro(Dimensions,int,3);
129 
133  int GetDataDimension();
134 
141  int ComputeStructuredCoordinates(double x[3], int ijk[3], double pcoords[3]);
142 
146  vtkIdType ComputePointId(int ijk[3]);
147 
151  vtkIdType ComputeCellId(int ijk[3]);
152 
158  void GetPoint(const int i,const int j,const int k,double p[3]);
159 
161 
164  virtual void SetXCoordinates(vtkDataArray*);
165  vtkGetObjectMacro(XCoordinates,vtkDataArray);
167 
169 
172  virtual void SetYCoordinates(vtkDataArray*);
173  vtkGetObjectMacro(YCoordinates,vtkDataArray);
175 
177 
180  virtual void SetZCoordinates(vtkDataArray*);
181  vtkGetObjectMacro(ZCoordinates,vtkDataArray);
183 
185 
190  void SetExtent(int extent[6]);
191  void SetExtent(int x1, int x2, int y1, int y2, int z1, int z2);
192  vtkGetVector6Macro(Extent, int);
194 
203  unsigned long GetActualMemorySize() override;
204 
206 
209  void ShallowCopy(vtkDataObject *src) override;
210  void DeepCopy(vtkDataObject *src) override;
212 
216  int GetExtentType() override { return VTK_3D_EXTENT; };
217 
223  void Crop(const int* updateExtent) override;
224 
226 
230  static vtkRectilinearGrid* GetData(vtkInformationVector* v, int i=0);
232 
233 protected:
235  ~vtkRectilinearGrid() override;
236 
237  // for the GetCell method
242 
243  int Dimensions[3];
245 
246  int Extent[6];
247 
251 
252  // Hang on to some space for returning points when GetPoint(id) is called.
253  double PointReturn[3];
254 
255 private:
256  void Cleanup();
257 
258 private:
259  vtkRectilinearGrid(const vtkRectilinearGrid&) = delete;
260  void operator=(const vtkRectilinearGrid&) = delete;
261 };
262 
263 //----------------------------------------------------------------------------
265 {
266  vtkIdType nCells=1;
267  int i;
268 
269  for (i=0; i<3; i++)
270  {
271  if (this->Dimensions[i] <= 0)
272  {
273  return 0;
274  }
275  if (this->Dimensions[i] > 1)
276  {
277  nCells *= (this->Dimensions[i]-1);
278  }
279  }
280 
281  return nCells;
282 }
283 
284 //----------------------------------------------------------------------------
286 {
287  return static_cast<vtkIdType>(this->Dimensions[0]) *
288  this->Dimensions[1] * this->Dimensions[2];
289 }
290 
291 //----------------------------------------------------------------------------
293 {
295 }
296 
297 //----------------------------------------------------------------------------
299 {
301 }
302 
303 //----------------------------------------------------------------------------
305 {
307 }
308 
309 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:33
vtkDataSet::GetNumberOfPoints
virtual vtkIdType GetNumberOfPoints()=0
Determine the number of points composing the dataset.
vtkDataSet::GetActualMemorySize
unsigned long GetActualMemorySize() override
Return the actual size of the data in kibibytes (1024 bytes).
vtkStructuredData::GetDataDimension
static int GetDataDimension(int dataDescription)
Return the topological dimension of the data (e.g., 0, 1, 2, or 3D).
vtkRectilinearGrid::GetExtentType
int GetExtentType() override
Structured extent.
Definition: vtkRectilinearGrid.h:216
vtkRectilinearGrid::Voxel
vtkVoxel * Voxel
Definition: vtkRectilinearGrid.h:241
vtkDataSet::ShallowCopy
void ShallowCopy(vtkDataObject *src) override
Shallow and Deep copy.
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkRectilinearGrid::Vertex
vtkVertex * Vertex
Definition: vtkRectilinearGrid.h:238
vtkRectilinearGrid
a dataset that is topologically regular with variable spacing in the three coordinate directions
Definition: vtkRectilinearGrid.h:50
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:35
vtkDataSet::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkRectilinearGrid::Pixel
vtkPixel * Pixel
Definition: vtkRectilinearGrid.h:240
vtkDataSet::GetData
static vtkDataSet * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
vtkRectilinearGrid::GetPointCells
void GetPointCells(vtkIdType ptId, vtkIdList *cellIds) override
Topological inquiry to get cells using point.
Definition: vtkRectilinearGrid.h:100
vtkRectilinearGrid::GetNumberOfPoints
vtkIdType GetNumberOfPoints() override
Determine the number of points composing the dataset.
Definition: vtkRectilinearGrid.h:285
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:48
vtkRectilinearGrid::GetNumberOfCells
vtkIdType GetNumberOfCells() override
Standard vtkDataSet API methods.
Definition: vtkRectilinearGrid.h:264
vtkRectilinearGrid::YCoordinates
vtkDataArray * YCoordinates
Definition: vtkRectilinearGrid.h:249
vtkVertex
a cell that represents a 3D point
Definition: vtkVertex.h:30
vtkDataSet::FindCell
virtual vtkIdType FindCell(double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)=0
Locate cell based on global coordinate x and tolerance squared.
vtkLine
cell represents a 1D line
Definition: vtkLine.h:29
VTK_3D_EXTENT
#define VTK_3D_EXTENT
Definition: vtkDataObject.h:55
vtkDataSet::ComputeBounds
virtual void ComputeBounds()
Compute the data bounding box from data points.
vtkStructuredData.h
vtkStructuredData::ComputePointId
static vtkIdType ComputePointId(int dim[3], int ijk[3], int dataDescription=VTK_EMPTY)
Given a location in structured coordinates (i-j-k), and the dimensions of the structured dataset,...
Definition: vtkStructuredData.h:292
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:42
vtkStructuredData::GetCellPoints
static void GetCellPoints(vtkIdType cellId, vtkIdList *ptIds, int dataDescription, int dim[3])
Get the points defining a cell.
vtkDataSet::FindPoint
vtkIdType FindPoint(double x, double y, double z)
Locate the closest point to the global coordinate x.
Definition: vtkDataSet.h:191
vtkDataSet::GetCellNeighbors
virtual void GetCellNeighbors(vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds)
Topological inquiry to get all cells using list of points exclusive of cell specified (e....
vtkCell
abstract class to specify cell behavior
Definition: vtkCell.h:56
vtkRectilinearGrid::GetCellPoints
void GetCellPoints(vtkIdType cellId, vtkIdList *ptIds) override
Topological inquiry to get points defining cell.
Definition: vtkRectilinearGrid.h:97
vtkRectilinearGrid::GetDataDimension
int GetDataDimension()
Return the dimensionality of the data.
Definition: vtkRectilinearGrid.h:292
vtkRectilinearGrid::GetDataObjectType
int GetDataObjectType() override
Return what type of dataset this is.
Definition: vtkRectilinearGrid.h:61
vtkStructuredData::GetPointCells
static void GetPointCells(vtkIdType ptId, vtkIdList *cellIds, int dim[3])
Get the cells using a point.
vtkRectilinearGrid::GetMaxCellSize
int GetMaxCellSize() override
Convenience method returns largest cell size in dataset.
Definition: vtkRectilinearGrid.h:103
vtkRectilinearGrid::FindPoint
vtkIdType FindPoint(double x, double y, double z)
Definition: vtkRectilinearGrid.h:86
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkRectilinearGrid::Line
vtkLine * Line
Definition: vtkRectilinearGrid.h:239
vtkDataSet::Initialize
void Initialize() override
Restore data object to initial state.
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:30
vtkRectilinearGrid::ComputePointId
vtkIdType ComputePointId(int ijk[3])
Given a location in structured coordinates (i-j-k), return the point id.
Definition: vtkRectilinearGrid.h:298
vtkRectilinearGrid::ComputeCellId
vtkIdType ComputeCellId(int ijk[3])
Given a location in structured coordinates (i-j-k), return the cell id.
Definition: vtkRectilinearGrid.h:304
vtkRectilinearGrid::Dimensions
int Dimensions[3]
Definition: vtkRectilinearGrid.h:243
vtkDataObject::Crop
virtual void Crop(const int *updateExtent)
This method crops the data object (if necessary) so that the extent matches the update extent.
vtkStructuredData::ComputeCellId
static vtkIdType ComputeCellId(int dim[3], int ijk[3], int dataDescription=VTK_EMPTY)
Given a location in structured coordinates (i-j-k), and the dimensions of the structured dataset,...
Definition: vtkStructuredData.h:299
vtkDataSet.h
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:56
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:80
vtkRectilinearGrid::XCoordinates
vtkDataArray * XCoordinates
Definition: vtkRectilinearGrid.h:248
vtkX3D::info
Definition: vtkX3D.h:376
vtkDataSet::GetPoint
virtual double * GetPoint(vtkIdType ptId)=0
Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints.
vtkPixel
a cell that represents an orthogonal quadrilateral
Definition: vtkPixel.h:34
vtkDataSet::CopyStructure
virtual void CopyStructure(vtkDataSet *ds)=0
Copy the geometric and topological structure of an object.
vtkGenericCell
provides thread-safe access to cells
Definition: vtkGenericCell.h:36
vtkX3D::extent
Definition: vtkX3D.h:345
vtkDataSet::GetNumberOfCells
virtual vtkIdType GetNumberOfCells()=0
Determine the number of cells composing the dataset.
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:58
vtkDataSet::GetCellType
virtual int GetCellType(vtkIdType cellId)=0
Get type of cell with cellId such that: 0 <= cellId < NumberOfCells.
vtkDataSet::GetCellBounds
virtual void GetCellBounds(vtkIdType cellId, double bounds[6])
Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells.
vtkRectilinearGrid::ZCoordinates
vtkDataArray * ZCoordinates
Definition: vtkRectilinearGrid.h:250
vtkDataSet::FindAndGetCell
virtual vtkCell * FindAndGetCell(double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
Locate the cell that contains a point and return the cell.
VTK_RECTILINEAR_GRID
#define VTK_RECTILINEAR_GRID
Definition: vtkType.h:94
vtkRectilinearGrid::DataDescription
int DataDescription
Definition: vtkRectilinearGrid.h:244
vtkDataSet::DeepCopy
void DeepCopy(vtkDataObject *src) override
vtkDataObject::New
static vtkDataObject * New()
vtkDataSet::GetCell
virtual vtkCell * GetCell(vtkIdType cellId)=0
Get cell with cellId such that: 0 <= cellId < NumberOfCells.
vtkVoxel
a cell that represents a 3D orthogonal parallelepiped
Definition: vtkVoxel.h:38