VTK  9.2.5
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=========================================================================*/
43#ifndef vtkRectilinearGrid_h
44#define vtkRectilinearGrid_h
45
46#include "vtkCommonDataModelModule.h" // For export macro
47#include "vtkDataSet.h"
48#include "vtkStructuredData.h" // For inline methods
49
50class vtkVertex;
51class vtkLine;
52class vtkPixel;
53class vtkVoxel;
54class vtkDataArray;
55class vtkPoints;
56
57class VTKCOMMONDATAMODEL_EXPORT vtkRectilinearGrid : public vtkDataSet
58{
59public:
62
64 void PrintSelf(ostream& os, vtkIndent indent) override;
65
69 int GetDataObjectType() override { return VTK_RECTILINEAR_GRID; }
70
75 void CopyStructure(vtkDataSet* ds) override;
76
80 void Initialize() override;
81
83
86 vtkIdType GetNumberOfCells() override;
88 double* GetPoint(vtkIdType ptId) VTK_SIZEHINT(3) override;
89 void GetPoint(vtkIdType id, double x[3]) override;
90 vtkCell* GetCell(vtkIdType cellId) override;
91 vtkCell* GetCell(int i, int j, int k) override;
92 void GetCell(vtkIdType cellId, vtkGenericCell* cell) override;
93 void GetCellBounds(vtkIdType cellId, double bounds[6]) override;
94 vtkIdType FindPoint(double x, double y, double z) { return this->vtkDataSet::FindPoint(x, y, z); }
95 vtkIdType FindPoint(double x[3]) override;
96 vtkIdType FindCell(double x[3], vtkCell* cell, vtkIdType cellId, double tol2, int& subId,
97 double pcoords[3], double* weights) override;
98 vtkIdType FindCell(double x[3], vtkCell* cell, vtkGenericCell* gencell, vtkIdType cellId,
99 double tol2, int& subId, double pcoords[3], double* weights) override;
100 vtkCell* FindAndGetCell(double x[3], vtkCell* cell, vtkIdType cellId, double tol2, int& subId,
101 double pcoords[3], double* weights) override;
102 int GetCellType(vtkIdType cellId) override;
105 void GetCellPoints(vtkIdType cellId, vtkIdList* ptIds) override
106 {
107 vtkStructuredData::GetCellPoints(cellId, ptIds, this->DataDescription, this->Dimensions);
108 }
109 void GetPointCells(vtkIdType ptId, vtkIdList* cellIds) override
110 {
111 vtkStructuredData::GetPointCells(ptId, cellIds, this->Dimensions);
112 }
113 void ComputeBounds() override;
114 int GetMaxCellSize() override { return 8; } // voxel is the largest
115 void GetCellNeighbors(vtkIdType cellId, vtkIdList* ptIds, vtkIdList* cellIds) override;
116 void GetCellNeighbors(vtkIdType cellId, vtkIdList* ptIds, vtkIdList* cellIds, int* seedLoc);
118
124 unsigned char IsPointVisible(vtkIdType ptId);
125
131 unsigned char IsCellVisible(vtkIdType cellId);
132
137 bool HasAnyBlankPoints() override;
142 bool HasAnyBlankCells() override;
143
150 void GetCellDims(int cellDims[3]);
151
156 void GetPoints(vtkPoints* pnts);
157
159
163 void SetDimensions(int i, int j, int k);
164 void SetDimensions(const int dim[3]);
166
168
171 vtkGetVectorMacro(Dimensions, int, 3);
173
177 int GetDataDimension();
178
185 int ComputeStructuredCoordinates(double x[3], int ijk[3], double pcoords[3]);
186
190 vtkIdType ComputePointId(int ijk[3]);
191
195 vtkIdType ComputeCellId(int ijk[3]);
196
202 void GetPoint(const int i, const int j, const int k, double p[3]);
203
205
209 vtkGetObjectMacro(XCoordinates, vtkDataArray);
211
213
217 vtkGetObjectMacro(YCoordinates, vtkDataArray);
219
221
225 vtkGetObjectMacro(ZCoordinates, vtkDataArray);
227
229
234 void SetExtent(int extent[6]);
235 void SetExtent(int xMin, int xMax, int yMin, int yMax, int zMin, int zMax);
236 vtkGetVector6Macro(Extent, int);
238
247 unsigned long GetActualMemorySize() override;
248
250
253 void ShallowCopy(vtkDataObject* src) override;
254 void DeepCopy(vtkDataObject* src) override;
256
260 int GetExtentType() override { return VTK_3D_EXTENT; }
261
267 void Crop(const int* updateExtent) override;
268
270
276
278
281 static void SetScalarType(int, vtkInformation* meta_data);
282 static int GetScalarType(vtkInformation* meta_data);
283 static bool HasScalarType(vtkInformation* meta_data);
285 const char* GetScalarTypeAsString() { return vtkImageScalarTypeNameMacro(this->GetScalarType()); }
287
289
293 static void SetNumberOfScalarComponents(int n, vtkInformation* meta_data);
298
299protected:
302
303 // for the GetCell method
308
309 int Dimensions[3];
311
312 int Extent[6];
313
317
318 // Hang on to some space for returning points when GetPoint(id) is called.
319 double PointReturn[3];
320
321private:
322 void Cleanup();
323
324private:
325 vtkRectilinearGrid(const vtkRectilinearGrid&) = delete;
326 void operator=(const vtkRectilinearGrid&) = delete;
327};
328
329//----------------------------------------------------------------------------
331{
332 vtkIdType nCells = 1;
333 int i;
334
335 for (i = 0; i < 3; i++)
336 {
337 if (this->Dimensions[i] <= 0)
338 {
339 return 0;
340 }
341 if (this->Dimensions[i] > 1)
342 {
343 nCells *= (this->Dimensions[i] - 1);
344 }
345 }
346
347 return nCells;
348}
349
350//----------------------------------------------------------------------------
352{
353 return static_cast<vtkIdType>(this->Dimensions[0]) * this->Dimensions[1] * this->Dimensions[2];
354}
355
356//----------------------------------------------------------------------------
358{
360}
361
362//----------------------------------------------------------------------------
364{
366}
367
368//----------------------------------------------------------------------------
370{
372}
373
374#endif
abstract class to specify cell behavior
Definition: vtkCell.h:61
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:56
general representation of visualization data
Definition: vtkDataObject.h:66
abstract class to specify dataset behavior
Definition: vtkDataSet.h:63
virtual vtkIdType GetNumberOfPoints()=0
Determine the number of points composing the dataset.
virtual vtkIdType GetNumberOfCells()=0
Determine the number of cells composing the dataset.
virtual void GetCellPoints(vtkIdType cellId, vtkIdList *ptIds)=0
Topological inquiry to get points defining cell.
vtkIdType FindPoint(double x, double y, double z)
Locate the closest point to the global coordinate x.
Definition: vtkDataSet.h:232
provides thread-safe access to cells
list of point or cell ids
Definition: vtkIdList.h:34
a simple class to control print indentation
Definition: vtkIndent.h:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
cell represents a 1D line
Definition: vtkLine.h:34
a cell that represents an orthogonal quadrilateral
Definition: vtkPixel.h:38
represent and manipulate 3D points
Definition: vtkPoints.h:40
a dataset that is topologically regular with variable spacing in the three coordinate directions
static vtkRectilinearGrid * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
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.
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.
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.
static vtkRectilinearGrid * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
vtkDataArray * YCoordinates
vtkCell * GetCell(vtkIdType cellId) override
Standard vtkDataSet API methods.
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
const char * GetScalarTypeAsString()
Set/Get the scalar data type for the points.
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 GetCellSize(vtkIdType cellId) override
Standard vtkDataSet API methods.
vtkIdType FindPoint(double x[3]) override
Standard vtkDataSet API methods.
int GetNumberOfScalarComponents()
Set/Get the number of scalar components for points.
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.
double * GetPoint(vtkIdType ptId) override
Standard vtkDataSet API methods.
vtkDataArray * ZCoordinates
void GetCellBounds(vtkIdType cellId, double bounds[6]) override
Standard vtkDataSet API methods.
vtkCell * GetCell(int i, int j, int k) override
Standard vtkDataSet API methods.
static vtkRectilinearGrid * New()
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.
vtkCell * FindAndGetCell(double x[3], vtkCell *cell, 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].
int GetMaxCellSize() override
Standard vtkDataSet API methods.
void ShallowCopy(vtkDataObject *src) override
Shallow and Deep copy.
static vtkRectilinearGrid * ExtendedNew()
void SetExtent(int xMin, int xMax, int yMin, int yMax, int zMin, int zMax)
Different ways to set the extent of the data array.
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:34
a cell that represents a 3D orthogonal parallelepiped
Definition: vtkVoxel.h:42
#define VTK_3D_EXTENT
Definition: vtkDataObject.h:62
int vtkIdType
Definition: vtkType.h:332
#define VTK_RECTILINEAR_GRID
Definition: vtkType.h:80
#define VTK_SIZEHINT(...)