VTK  9.1.0
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 =========================================================================*/
37 #ifndef vtkRectilinearGrid_h
38 #define vtkRectilinearGrid_h
39 
40 #include "vtkCommonDataModelModule.h" // For export macro
41 #include "vtkDataSet.h"
42 #include "vtkStructuredData.h" // For inline methods
43 
44 class vtkVertex;
45 class vtkLine;
46 class vtkPixel;
47 class vtkVoxel;
48 class vtkDataArray;
49 class vtkPoints;
50 
51 class VTKCOMMONDATAMODEL_EXPORT vtkRectilinearGrid : public vtkDataSet
52 {
53 public:
56 
58  void PrintSelf(ostream& os, vtkIndent indent) override;
59 
63  int GetDataObjectType() override { return VTK_RECTILINEAR_GRID; }
64 
69  void CopyStructure(vtkDataSet* ds) override;
70 
74  void Initialize() override;
75 
77 
80  vtkIdType GetNumberOfCells() override;
81  vtkIdType GetNumberOfPoints() override;
82  double* GetPoint(vtkIdType ptId) VTK_SIZEHINT(3) override;
83  void GetPoint(vtkIdType id, double x[3]) override;
84  vtkCell* GetCell(vtkIdType cellId) override;
85  vtkCell* GetCell(int i, int j, int k) override;
86  void GetCell(vtkIdType cellId, vtkGenericCell* cell) override;
87  void GetCellBounds(vtkIdType cellId, double bounds[6]) override;
88  vtkIdType FindPoint(double x, double y, double z) { return this->vtkDataSet::FindPoint(x, y, z); }
89  vtkIdType FindPoint(double x[3]) override;
90  vtkIdType FindCell(double x[3], vtkCell* cell, vtkIdType cellId, double tol2, int& subId,
91  double pcoords[3], double* weights) override;
92  vtkIdType FindCell(double x[3], vtkCell* cell, vtkGenericCell* gencell, vtkIdType cellId,
93  double tol2, int& subId, double pcoords[3], double* weights) override;
94  vtkCell* FindAndGetCell(double x[3], vtkCell* cell, vtkIdType cellId, double tol2, int& subId,
95  double pcoords[3], double* weights) override;
96  int GetCellType(vtkIdType cellId) override;
97  void GetCellPoints(vtkIdType cellId, vtkIdList* ptIds) override
98  {
99  vtkStructuredData::GetCellPoints(cellId, ptIds, this->DataDescription, this->Dimensions);
100  }
101  void GetPointCells(vtkIdType ptId, vtkIdList* cellIds) override
102  {
103  vtkStructuredData::GetPointCells(ptId, cellIds, this->Dimensions);
104  }
105  void ComputeBounds() override;
106  int GetMaxCellSize() override { return 8; } // voxel is the largest
107  void GetCellNeighbors(vtkIdType cellId, vtkIdList* ptIds, vtkIdList* cellIds) override;
108  void GetCellNeighbors(vtkIdType cellId, vtkIdList* ptIds, vtkIdList* cellIds, int* seedLoc);
110 
116  unsigned char IsPointVisible(vtkIdType ptId);
117 
123  unsigned char IsCellVisible(vtkIdType cellId);
124 
129  bool HasAnyBlankPoints() override;
134  bool HasAnyBlankCells() override;
135 
142  void GetCellDims(int cellDims[3]);
143 
148  void GetPoints(vtkPoints* pnts);
149 
151 
155  void SetDimensions(int i, int j, int k);
156  void SetDimensions(const int dim[3]);
158 
160 
163  vtkGetVectorMacro(Dimensions, int, 3);
165 
169  int GetDataDimension();
170 
177  int ComputeStructuredCoordinates(double x[3], int ijk[3], double pcoords[3]);
178 
182  vtkIdType ComputePointId(int ijk[3]);
183 
187  vtkIdType ComputeCellId(int ijk[3]);
188 
194  void GetPoint(const int i, const int j, const int k, double p[3]);
195 
197 
201  vtkGetObjectMacro(XCoordinates, vtkDataArray);
203 
205 
209  vtkGetObjectMacro(YCoordinates, vtkDataArray);
211 
213 
217  vtkGetObjectMacro(ZCoordinates, vtkDataArray);
219 
221 
226  void SetExtent(int extent[6]);
227  void SetExtent(int xMin, int xMax, int yMin, int yMax, int zMin, int zMax);
228  vtkGetVector6Macro(Extent, int);
230 
239  unsigned long GetActualMemorySize() override;
240 
242 
245  void ShallowCopy(vtkDataObject* src) override;
246  void DeepCopy(vtkDataObject* src) override;
248 
252  int GetExtentType() override { return VTK_3D_EXTENT; }
253 
259  void Crop(const int* updateExtent) override;
260 
262 
268 
270 
273  static void SetScalarType(int, vtkInformation* meta_data);
274  static int GetScalarType(vtkInformation* meta_data);
275  static bool HasScalarType(vtkInformation* meta_data);
277  const char* GetScalarTypeAsString() { return vtkImageScalarTypeNameMacro(this->GetScalarType()); }
279 
281 
285  static void SetNumberOfScalarComponents(int n, vtkInformation* meta_data);
290 
291 protected:
294 
295  // for the GetCell method
300 
301  int Dimensions[3];
303 
304  int Extent[6];
305 
309 
310  // Hang on to some space for returning points when GetPoint(id) is called.
311  double PointReturn[3];
312 
313 private:
314  void Cleanup();
315 
316 private:
317  vtkRectilinearGrid(const vtkRectilinearGrid&) = delete;
318  void operator=(const vtkRectilinearGrid&) = delete;
319 };
320 
321 //----------------------------------------------------------------------------
323 {
324  vtkIdType nCells = 1;
325  int i;
326 
327  for (i = 0; i < 3; i++)
328  {
329  if (this->Dimensions[i] <= 0)
330  {
331  return 0;
332  }
333  if (this->Dimensions[i] > 1)
334  {
335  nCells *= (this->Dimensions[i] - 1);
336  }
337  }
338 
339  return nCells;
340 }
341 
342 //----------------------------------------------------------------------------
344 {
345  return static_cast<vtkIdType>(this->Dimensions[0]) * this->Dimensions[1] * this->Dimensions[2];
346 }
347 
348 //----------------------------------------------------------------------------
350 {
352 }
353 
354 //----------------------------------------------------------------------------
356 {
358 }
359 
360 //----------------------------------------------------------------------------
362 {
363  return vtkStructuredData::ComputeCellId(this->Dimensions, ijk);
364 }
365 
366 #endif
abstract class to specify cell behavior
Definition: vtkCell.h:58
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:50
general representation of visualization data
Definition: vtkDataObject.h:60
abstract class to specify dataset behavior
Definition: vtkDataSet.h:57
virtual vtkIdType GetNumberOfPoints()=0
Determine the number of points composing the dataset.
virtual vtkIdType GetNumberOfCells()=0
Determine the number of cells composing the dataset.
vtkIdType FindPoint(double x, double y, double z)
Locate the closest point to the global coordinate x.
Definition: vtkDataSet.h:201
provides thread-safe access to cells
list of point or cell ids
Definition: vtkIdList.h:31
a simple class to control print indentation
Definition: vtkIndent.h:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
cell represents a 1D line
Definition: vtkLine.h:31
a cell that represents an orthogonal quadrilateral
Definition: vtkPixel.h:35
represent and manipulate 3D points
Definition: vtkPoints.h:34
a dataset that is topologically regular with variable spacing in the three coordinate directions
static bool HasScalarType(vtkInformation *meta_data)
Set/Get the scalar data type for the points.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void Initialize() override
Restore object to initial state.
unsigned long GetActualMemorySize() override
Return the actual size of the data in kibibytes (1024 bytes).
vtkIdType FindCell(double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
Standard vtkDataSet API methods.
virtual void SetZCoordinates(vtkDataArray *)
Specify the grid coordinates in the z-direction.
void GetPointCells(vtkIdType ptId, vtkIdList *cellIds) override
Standard vtkDataSet API methods.
void 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.
vtkIdType GetNumberOfPoints() override
Standard vtkDataSet API methods.
bool HasAnyBlankCells() override
Returns 1 if there is any visibility constraint on the cells, 0 otherwise.
unsigned char IsCellVisible(vtkIdType cellId)
Return non-zero value if specified point is visible.
const char * GetScalarTypeAsString()
Set/Get the scalar data type for the points.
bool HasAnyBlankPoints() override
Returns 1 if there is any visibility constraint on the points, 0 otherwise.
virtual void SetYCoordinates(vtkDataArray *)
Specify the grid coordinates in the y-direction.
virtual void SetXCoordinates(vtkDataArray *)
Specify the grid coordinates in the x-direction.
vtkCell * GetCell(vtkIdType cellId) override
Standard vtkDataSet API methods.
vtkIdType ComputeCellId(int ijk[3])
Given a location in structured coordinates (i-j-k), return the cell id.
int GetExtentType() override
Structured extent.
void DeepCopy(vtkDataObject *src) override
Shallow and Deep copy.
vtkDataArray * YCoordinates
vtkIdType GetNumberOfCells() override
Standard vtkDataSet API methods.
void SetExtent(int extent[6])
Different ways to set the extent of the data array.
vtkIdType FindPoint(double x, double y, double z)
Standard vtkDataSet API methods.
int GetDataObjectType() override
Return what type of dataset this is.
static void SetNumberOfScalarComponents(int n, vtkInformation *meta_data)
Set/Get the number of scalar components for points.
static int GetNumberOfScalarComponents(vtkInformation *meta_data)
Set/Get the number of scalar components for points.
vtkDataArray * XCoordinates
static vtkRectilinearGrid * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
void CopyStructure(vtkDataSet *ds) override
Copy the geometric and topological structure of an input rectilinear grid object.
static int GetScalarType(vtkInformation *meta_data)
Set/Get the scalar data type for the points.
void SetDimensions(int i, int j, int k)
Set dimensions of rectilinear grid dataset.
void GetPoints(vtkPoints *pnts)
Given a user-supplied vtkPoints container object, this method fills in all the points of the Rectilin...
static void SetScalarType(int, vtkInformation *meta_data)
Set/Get the scalar data type for the points.
~vtkRectilinearGrid() override
void GetCellDims(int cellDims[3])
Given the node dimensions of this grid instance, this method computes the node dimensions.
unsigned char IsPointVisible(vtkIdType ptId)
Return non-zero value if specified point is visible.
vtkIdType ComputePointId(int ijk[3])
Given a location in structured coordinates (i-j-k), return the point id.
void GetCellPoints(vtkIdType cellId, vtkIdList *ptIds) override
Standard vtkDataSet API methods.
static bool HasNumberOfScalarComponents(vtkInformation *meta_data)
Set/Get the number of scalar components for points.
vtkIdType FindPoint(double x[3]) override
Standard vtkDataSet API methods.
int GetNumberOfScalarComponents()
Set/Get the number of scalar components for points.
double * GetPoint(vtkIdType ptId) override
Standard vtkDataSet API methods.
int GetCellType(vtkIdType cellId) override
Standard vtkDataSet API methods.
void GetCellNeighbors(vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds, int *seedLoc)
Standard vtkDataSet API methods.
void GetPoint(vtkIdType id, double x[3]) override
Standard vtkDataSet API methods.
vtkDataArray * ZCoordinates
static vtkRectilinearGrid * ExtendedNew()
void GetCellBounds(vtkIdType cellId, double bounds[6]) override
Standard vtkDataSet API methods.
static vtkRectilinearGrid * New()
vtkCell * GetCell(int i, int j, int k) override
Standard vtkDataSet API methods.
int GetScalarType()
Set/Get the scalar data type for the points.
int GetDataDimension()
Return the dimensionality of the data.
void ComputeBounds() override
Standard vtkDataSet API methods.
void GetCellNeighbors(vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds) override
Standard vtkDataSet API methods.
void Crop(const int *updateExtent) override
Reallocates and copies to set the Extent to the UpdateExtent.
vtkIdType FindCell(double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
Standard vtkDataSet API methods.
int ComputeStructuredCoordinates(double x[3], int ijk[3], double pcoords[3])
Convenience function computes the structured coordinates for a point x[3].
static vtkRectilinearGrid * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
int GetMaxCellSize() override
Standard vtkDataSet API methods.
void ShallowCopy(vtkDataObject *src) override
Shallow and Deep copy.
void SetExtent(int xMin, int xMax, int yMin, int yMax, int zMin, int zMax)
Different ways to set the extent of the data array.
vtkCell * FindAndGetCell(double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
Standard vtkDataSet API methods.
void GetCell(vtkIdType cellId, vtkGenericCell *cell) override
Standard vtkDataSet API methods.
void SetDimensions(const int dim[3])
Set dimensions of rectilinear grid dataset.
static void GetCellPoints(vtkIdType cellId, vtkIdList *ptIds, int dataDescription, int dim[3])
Get the points defining a cell.
static int GetDataDimension(int dataDescription)
Return the topological dimension of the data (e.g., 0, 1, 2, or 3D).
static vtkIdType ComputePointId(const int dim[3], const int ijk[3], int dataDescription=VTK_EMPTY)
Given a location in structured coordinates (i-j-k), and the dimensions of the structured dataset,...
static void GetPointCells(vtkIdType ptId, vtkIdList *cellIds, int dim[3])
Get the cells using a point.
static vtkIdType ComputeCellId(const int dim[3], const int ijk[3], int dataDescription=VTK_EMPTY)
Given a location in structured coordinates (i-j-k), and the dimensions of the structured dataset,...
a cell that represents a 3D point
Definition: vtkVertex.h:31
a cell that represents a 3D orthogonal parallelepiped
Definition: vtkVoxel.h:39
@ info
Definition: vtkX3D.h:382
@ extent
Definition: vtkX3D.h:351
#define VTK_3D_EXTENT
Definition: vtkDataObject.h:56
int vtkIdType
Definition: vtkType.h:332
#define VTK_RECTILINEAR_GRID
Definition: vtkType.h:80
#define VTK_SIZEHINT(...)