vtkStructuredData.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkStructuredData_h
#define vtkStructuredData_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDeprecation.h"           // For VTK_DEPRECATED_IN_9_6_0
#include "vtkObject.h"
#include "vtkSmartPointer.h" // For vtkSmartPointer
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDataArray;
class vtkIdList;
class vtkPoints;
class vtkStructuredCellArray;
class vtkUnsignedCharArray;
 
template <typename T, int ArrayType>
class vtkImplicitArray;
template <typename Type>
struct vtkConstantImplicitBackend;
template <typename Type>
using vtkConstantArray =
  vtkImplicitArray<vtkConstantImplicitBackend<Type>, vtkArrayTypes::VTK_CONSTANT_ARRAY>;
 
class VTKCOMMONDATAMODEL_EXPORT vtkStructuredData : public vtkObject
{
public:
  vtkTypeMacro(vtkStructuredData, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  enum vtkStructuredDataType
  {
    VTK_STRUCTURED_INVALID = -1, // An invalid/unset/unitialized grid
    VTK_STRUCTURED_UNCHANGED =
      0, // Used by vtkStructuredData API to signify that the type of the grid was not changed
    VTK_STRUCTURED_SINGLE_POINT = 1, // A single point, 0D
    VTK_STRUCTURED_X_LINE = 2,       // X aligned line, 1D
    VTK_STRUCTURED_Y_LINE = 3,       // Y aligned line, 1D
    VTK_STRUCTURED_Z_LINE = 4,       // Z aligned line, 1D
    VTK_STRUCTURED_XY_PLANE = 5,     // XY aligned plane, 2D
    VTK_STRUCTURED_YZ_PLANE = 6,     // XY aligned plane, 2D
    VTK_STRUCTURED_XZ_PLANE = 7,     // XY aligned plane, 2D
    VTK_STRUCTURED_XYZ_GRID = 8,     // XYZ grid, 3D
    VTK_STRUCTURED_EMPTY = 9         // An empty grid
  };


  static int SetDimensions(VTK_FUTURE_CONST int inDim[3], int dim[3]);
  static int SetExtent(VTK_FUTURE_CONST int inExt[6], int ext[6]);


  static int GetDataDescription(int dims[3]);
  static int GetDataDescriptionFromExtent(int ext[6]);


  static int GetDataDimension(int dataDescription);
  static int GetDataDimension(int ext[6]);

  static vtkIdType GetNumberOfPoints(
    const int ext[6], int dataDescription = vtkStructuredData::VTK_STRUCTURED_EMPTY);

  static vtkIdType GetNumberOfCells(
    const int ext[6], int dataDescription = vtkStructuredData::VTK_STRUCTURED_EMPTY);

  static void GetCellExtentFromPointExtent(const int pntExtent[6], int cellExtent[6],
    int dataDescription = vtkStructuredData::VTK_STRUCTURED_EMPTY);

  static inline void GetDimensionsFromExtent(
    const int ext[6], int dims[3], int dataDescription = vtkStructuredData::VTK_STRUCTURED_EMPTY);

  static bool IsPointVisible(vtkIdType cellId, vtkUnsignedCharArray* ghosts);

  static bool IsCellVisible(vtkIdType cellId, VTK_FUTURE_CONST int dimensions[3],
    int dataDescription, vtkUnsignedCharArray* cellGhostArray,
    vtkUnsignedCharArray* pointGhostArray = nullptr);

  static void GetCellDimensionsFromExtent(const int ext[6], int celldims[3],
    int dataDescription = vtkStructuredData::VTK_STRUCTURED_EMPTY);

  static void GetCellDimensionsFromPointDimensions(const int pntdims[3], int cellDims[3]);

  static void GetLocalStructuredCoordinates(const int ijk[3], const int ext[6], int lijk[3],
    int dataDescription = vtkStructuredData::VTK_STRUCTURED_EMPTY);

  static void GetGlobalStructuredCoordinates(const int lijk[3], const int ext[6], int ijk[3],
    int dataDescription = vtkStructuredData::VTK_STRUCTURED_EMPTY);

  static void GetCellPoints(vtkIdType cellId, vtkIdList* ptIds, int dataDescription, int dim[3]);

  static void GetPointCells(vtkIdType ptId, vtkIdList* cellIds, VTK_FUTURE_CONST int dim[3]);

  static void GetCellNeighbors(vtkIdType cellId, vtkIdList* ptIds, vtkIdList* cellIds, int dim[3]);
  static void GetCellNeighbors(
    vtkIdType cellId, vtkIdList* ptIds, vtkIdList* cellIds, int dim[3], int seedLoc[3]);

  static vtkIdType ComputePointIdForExtent(const int extent[6], const int ijk[3],
    int dataDescription = vtkStructuredData::VTK_STRUCTURED_EMPTY);

  static vtkIdType ComputeCellIdForExtent(const int extent[6], const int ijk[3],
    int dataDescription = vtkStructuredData::VTK_STRUCTURED_EMPTY);

  static vtkIdType ComputePointId(const int dim[3], const int ijk[3],
    int dataDescription = vtkStructuredData::VTK_STRUCTURED_EMPTY);

  static vtkIdType ComputeCellId(const int dim[3], const int ijk[3],
    int dataDescription = vtkStructuredData::VTK_STRUCTURED_EMPTY);

  static void ComputeCellStructuredCoordsForExtent(vtkIdType cellIdx, const int ext[6], int ijk[3],
    int dataDescription = vtkStructuredData::VTK_STRUCTURED_EMPTY);

  static void ComputeCellStructuredCoords(vtkIdType cellId, const int dim[3], int ijk[3],
    int dataDescription = vtkStructuredData::VTK_STRUCTURED_EMPTY);

  static void ComputeCellStructuredMinMaxCoords(vtkIdType cellId, const int dim[3], int ijkMin[3],
    int ijkMax[3], int dataDescription = vtkStructuredData::VTK_STRUCTURED_EMPTY);

  static void ComputePointStructuredCoordsForExtent(vtkIdType ptId, const int ext[6], int ijk[3],
    int dataDescription = vtkStructuredData::VTK_STRUCTURED_EMPTY);

  static void ComputePointStructuredCoords(vtkIdType ptId, const int dim[3], int ijk[3],
    int dataDescription = vtkStructuredData::VTK_STRUCTURED_EMPTY);

  static vtkSmartPointer<vtkStructuredCellArray> GetCellArray(
    int extent[6], bool usePixelVoxelOrientation);

  static vtkSmartPointer<vtkPoints> GetPoints(vtkDataArray* xCoords, vtkDataArray* yCoords,
    vtkDataArray* zCoords, int extent[6], double dirMatrix[9]);


  VTK_WRAPEXCLUDE static vtkSmartPointer<vtkConstantArray<unsigned char>> GetCellTypes(
    int extent[6], bool usePixelVoxelOrientation);
  VTK_DEPRECATED_IN_9_6_0(
    "Use vtkSmartPointer<vtkConstantArray<unsigned char>> GetCellTypes(extent, "
    "usePixelVoxelOrientation) instead")
  VTK_WRAPEXCLUDE static vtkSmartPointer<vtkConstantArray<int>> GetCellTypesArray(
    int extent[6], bool usePixelVoxelOrientation);
 
protected:
  vtkStructuredData() = default;
  ~vtkStructuredData() override = default;

  static vtkIdType GetLinearIndex(const int i, const int j, const int k, const int N1, const int N2)
  {
    return ((static_cast<vtkIdType>(k) * N2 + j) * N1 + i);
  }


  static void GetStructuredCoordinates(
    const vtkIdType idx, const int N1, const int N2, int& i, int& j, int& k)
  {
    vtkIdType N12 = N1 * N2;
    k = static_cast<int>(idx / N12);
    j = static_cast<int>((idx - k * N12) / N1);
    i = static_cast<int>(idx - k * N12 - j * N1);
  }

 
  // Want to avoid importing <algorithm> in the header...
  template <typename T>
  static T Max(const T& a, const T& b)
  {
    return (a > b) ? a : b;
  }
 
private:
  vtkStructuredData(const vtkStructuredData&) = delete;
  void operator=(const vtkStructuredData&) = delete;
};
 
//------------------------------------------------------------------------------
inline void vtkStructuredData::GetCellDimensionsFromExtent(const int ext[6], int celldims[3], int)
{
  celldims[0] = vtkStructuredData::Max(ext[1] - ext[0], 0);
  celldims[1] = vtkStructuredData::Max(ext[3] - ext[2], 0);
  celldims[2] = vtkStructuredData::Max(ext[5] - ext[4], 0);
}
 
//------------------------------------------------------------------------------
inline vtkIdType vtkStructuredData::ComputePointId(const int dims[3], const int ijk[3], int)
{
  return vtkStructuredData::GetLinearIndex(ijk[0], ijk[1], ijk[2], dims[0], dims[1]);
}
 
//------------------------------------------------------------------------------
inline vtkIdType vtkStructuredData::ComputeCellId(const int dims[3], const int ijk[3], int)
{
  return vtkStructuredData::GetLinearIndex(ijk[0], ijk[1], ijk[2],
    vtkStructuredData::Max(dims[0] - 1, 1), vtkStructuredData::Max(dims[1] - 1, 1));
}
 
//------------------------------------------------------------------------------
inline vtkIdType vtkStructuredData::GetNumberOfPoints(const int ext[6], int)
{
  return static_cast<vtkIdType>(ext[1] - ext[0] + 1) * static_cast<vtkIdType>(ext[3] - ext[2] + 1) *
    static_cast<vtkIdType>(ext[5] - ext[4] + 1);
}
 
//------------------------------------------------------------------------------
inline vtkIdType vtkStructuredData::GetNumberOfCells(const int ext[6], int)
{
  int dims[3];
  vtkStructuredData::GetDimensionsFromExtent(ext, dims);
 
  // if any of the dimensions is 0, then there are no cells
  const int cellDims[3] = { dims[0] != 0 ? vtkStructuredData::Max(dims[0] - 1, 1) : 0,
    dims[1] != 0 ? vtkStructuredData::Max(dims[1] - 1, 1) : 0,
    dims[2] != 0 ? vtkStructuredData::Max(dims[2] - 1, 1) : 0 };
 
  // Note, when we compute the result below, we statically cast to vtkIdType to
  // ensure the compiler will generate a 32x32=64 instruction.
  return static_cast<vtkIdType>(cellDims[0]) * static_cast<vtkIdType>(cellDims[1]) *
    static_cast<vtkIdType>(cellDims[2]);
}
 
//------------------------------------------------------------------------------
inline void vtkStructuredData::GetCellExtentFromPointExtent(
  const int nodeExtent[6], int cellExtent[6], int)
{
  cellExtent[0] = nodeExtent[0];
  cellExtent[2] = nodeExtent[2];
  cellExtent[4] = nodeExtent[4];
 
  cellExtent[1] = vtkStructuredData::Max(nodeExtent[0], nodeExtent[1] - 1);
  cellExtent[3] = vtkStructuredData::Max(nodeExtent[2], nodeExtent[3] - 1);
  cellExtent[5] = vtkStructuredData::Max(nodeExtent[4], nodeExtent[5] - 1);
}
 
//------------------------------------------------------------------------------
void vtkStructuredData::GetDimensionsFromExtent(const int ext[6], int dims[3], int)
{
  dims[0] = ext[1] - ext[0] + 1;
  dims[1] = ext[3] - ext[2] + 1;
  dims[2] = ext[5] - ext[4] + 1;
}
 
//------------------------------------------------------------------------------
inline void vtkStructuredData::GetCellDimensionsFromPointDimensions(
  const int nodeDims[3], int cellDims[3])
{
  cellDims[0] = vtkStructuredData::Max(nodeDims[0] - 1, 0);
  cellDims[1] = vtkStructuredData::Max(nodeDims[1] - 1, 0);
  cellDims[2] = vtkStructuredData::Max(nodeDims[2] - 1, 0);
}
 
//------------------------------------------------------------------------------
inline void vtkStructuredData::GetLocalStructuredCoordinates(
  const int ijk[3], const int ext[6], int lijk[3], int)
{
  lijk[0] = ijk[0] - ext[0];
  lijk[1] = ijk[1] - ext[2];
  lijk[2] = ijk[2] - ext[4];
}
 
//------------------------------------------------------------------------------
inline void vtkStructuredData::GetGlobalStructuredCoordinates(
  const int lijk[3], const int ext[6], int ijk[3], int)
{
  ijk[0] = ext[0] + lijk[0];
  ijk[1] = ext[2] + lijk[1];
  ijk[2] = ext[4] + lijk[2];
}
 
//------------------------------------------------------------------------------
inline vtkIdType vtkStructuredData::ComputePointIdForExtent(
  const int extent[6], const int ijk[3], int)
{
  int dims[3];
  vtkStructuredData::GetDimensionsFromExtent(extent, dims);
 
  int lijk[3];
  vtkStructuredData::GetLocalStructuredCoordinates(ijk, extent, lijk);
 
  return vtkStructuredData::ComputePointId(dims, lijk);
}
 
//------------------------------------------------------------------------------
inline vtkIdType vtkStructuredData::ComputeCellIdForExtent(
  const int extent[6], const int ijk[3], int)
{
  int nodeDims[3];
  vtkStructuredData::GetDimensionsFromExtent(extent, nodeDims);
 
  int lijk[3];
  vtkStructuredData::GetLocalStructuredCoordinates(ijk, extent, lijk);
 
  return vtkStructuredData::ComputeCellId(nodeDims, lijk);
}
 
//------------------------------------------------------------------------------
inline void vtkStructuredData::ComputeCellStructuredCoords(
  vtkIdType cellId, const int dims[3], int ijk[3], int)
{
  vtkStructuredData::GetStructuredCoordinates(
    cellId, dims[0] - 1, dims[1] - 1, ijk[0], ijk[1], ijk[2]);
}
 
//------------------------------------------------------------------------------
inline void vtkStructuredData::ComputeCellStructuredCoordsForExtent(
  vtkIdType cellIdx, const int ext[6], int ijk[3], int)
{
  int nodeDims[3];
  vtkStructuredData::GetDimensionsFromExtent(ext, nodeDims);
 
  int lijk[3];
  vtkStructuredData::ComputeCellStructuredCoords(cellIdx, nodeDims, lijk);
 
  vtkStructuredData::GetGlobalStructuredCoordinates(lijk, ext, ijk);
}
 
//------------------------------------------------------------------------------
inline void vtkStructuredData::ComputePointStructuredCoords(
  vtkIdType ptId, const int dim[3], int ijk[3], int)
{
  vtkStructuredData::GetStructuredCoordinates(ptId, dim[0], dim[1], ijk[0], ijk[1], ijk[2]);
}
 
//------------------------------------------------------------------------------
inline void vtkStructuredData::ComputePointStructuredCoordsForExtent(
  vtkIdType ptId, const int ext[6], int ijk[3], int)
{
  int nodeDims[3];
  vtkStructuredData::GetDimensionsFromExtent(ext, nodeDims);
 
  int lijk[3];
  vtkStructuredData::ComputePointStructuredCoords(ptId, nodeDims, lijk);
 
  vtkStructuredData::GetGlobalStructuredCoordinates(lijk, ext, ijk);
}
 
VTK_ABI_NAMESPACE_END
#endif