File: vtkStructuredPointBackend.h

package info (click to toggle)
vtk9 9.5.2%2Bdfsg3-4
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 205,916 kB
  • sloc: cpp: 2,336,565; ansic: 327,116; python: 111,200; yacc: 4,104; java: 3,977; sh: 3,032; xml: 2,771; perl: 2,189; lex: 1,787; makefile: 178; javascript: 165; objc: 153; tcl: 59
file content (313 lines) | stat: -rw-r--r-- 14,956 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
 * @class vtkStructuredPointBackend
 * @brief A backend for the `vtkImplicitArray` to query structured points efficiently.
 *
 * A backend for the `vtkImplicitArray` to query structured points efficiently.
 *
 * @sa
 * vtkImplicitArray vtkStructuredPointArray
 */

#ifndef vtkStructuredPointBackend_h
#define vtkStructuredPointBackend_h

#include "vtkCommonCoreModule.h" // For export macro
#include "vtkDataArrayRange.h"   // For vtkDataArrayRange
#include "vtkSmartPointer.h"     // For vtkSmartPointer

#include <array> // For std::array

VTK_ABI_NAMESPACE_BEGIN
//------------------------------------------------------------------------------
template <typename ValueType>
class VTKCOMMONCORE_EXPORT vtkStructuredPointBackend
{
public:
  //------------------------------------------------------------------------------
  vtkStructuredPointBackend();

  //------------------------------------------------------------------------------
  virtual ~vtkStructuredPointBackend();

  /**
   * These function should only be used when direction matrix is NOT identity.
   */
  virtual ValueType mapStructuredXComponent(int i) const = 0;

  /**
   * These function should only be used when direction matrix is NOT identity.
   */
  virtual ValueType mapStructuredYComponent(int j) const = 0;

  /**
   * These function should only be used when direction matrix is NOT identity.
   */
  virtual ValueType mapStructuredZComponent(int k) const = 0;

  //------------------------------------------------------------------------------
  virtual void mapStructuredTuple(int ijk[3], ValueType tuple[3]) const = 0;

  //------------------------------------------------------------------------------
  virtual void mapTuple(vtkIdType tupleId, ValueType tuple[3]) const = 0;

  //------------------------------------------------------------------------------
  virtual ValueType mapComponent(vtkIdType tupleId, int comp) const = 0;

  //------------------------------------------------------------------------------
  virtual ValueType map(vtkIdType valueId) const = 0;
};

//------------------------------------------------------------------------------
template <typename ValueType, typename ArrayTypeX, typename ArrayTypeY, typename ArrayTypeZ,
  int DataDescription, bool UseDirMatrix>
class vtkStructuredTPointBackend : public vtkStructuredPointBackend<ValueType>
{
  vtkSmartPointer<ArrayTypeX> ArrayX;
  const vtk::detail::ValueRange<ArrayTypeX, 1> X;
  vtkSmartPointer<ArrayTypeY> ArrayY;
  const vtk::detail::ValueRange<ArrayTypeY, 1> Y;
  vtkSmartPointer<ArrayTypeZ> ArrayZ;
  const vtk::detail::ValueRange<ArrayTypeZ, 1> Z;
  const std::array<int, 6> Extent;
  const std::array<vtkIdType, 3> Dimensions;
  const vtkIdType Dimension_0_BY_1;

  // these are used only by vtkImageData and when direction matrix is not identity.
  std::array<double, 16> IndexToPhysicalMatrix;
  // this is a copy of vtkImageData::TransformCoordinates
  void TransformIndexToPhysicalPoint(int i, int j, int k, ValueType* out) const;

public:
  //------------------------------------------------------------------------------
  vtkStructuredTPointBackend();

  //------------------------------------------------------------------------------
  vtkStructuredTPointBackend(
    ArrayTypeX* arrayX, ArrayTypeY* arrayY, ArrayTypeZ* arrayZ, int extent[6], double dirMatrix[9])
    : ArrayX(arrayX)
    , X(vtk::DataArrayValueRange<1>(ArrayX))
    , ArrayY(arrayY)
    , Y(vtk::DataArrayValueRange<1>(ArrayY))
    , ArrayZ(arrayZ)
    , Z(vtk::DataArrayValueRange<1>(ArrayZ))
    , Extent({ { extent[0], extent[1], extent[2], extent[3], extent[4], extent[5] } })
    , Dimensions(
        { { extent[1] - extent[0] + 1, extent[3] - extent[2] + 1, extent[5] - extent[4] + 1 } })
    , Dimension_0_BY_1(this->Dimensions[0] * this->Dimensions[1])
    , IndexToPhysicalMatrix({ {} })
  {
    if (UseDirMatrix)
    {
      assert(this->ArrayX->GetNumberOfTuples() == 2);
      assert(this->ArrayY->GetNumberOfTuples() == 2);
      assert(this->ArrayZ->GetNumberOfTuples() == 2);
      // compute origin
      std::array<double, 3> origin = { { this->X[0], this->Y[0], this->Z[0] } };
      // compute spacing
      std::array<double, 3> spacing = { { this->X[1] - this->X[0], this->Y[1] - this->Y[0],
        this->Z[1] - this->Z[0] } };
      // compute index to physical matrix
      this->IndexToPhysicalMatrix[0] = dirMatrix[0] * spacing[0];
      this->IndexToPhysicalMatrix[1] = dirMatrix[1] * spacing[1];
      this->IndexToPhysicalMatrix[2] = dirMatrix[2] * spacing[2];
      this->IndexToPhysicalMatrix[3] = origin[0];
      this->IndexToPhysicalMatrix[4] = dirMatrix[3] * spacing[0];
      this->IndexToPhysicalMatrix[5] = dirMatrix[4] * spacing[1];
      this->IndexToPhysicalMatrix[6] = dirMatrix[5] * spacing[2];
      this->IndexToPhysicalMatrix[7] = origin[1];
      this->IndexToPhysicalMatrix[8] = dirMatrix[6] * spacing[0];
      this->IndexToPhysicalMatrix[9] = dirMatrix[7] * spacing[1];
      this->IndexToPhysicalMatrix[10] = dirMatrix[8] * spacing[2];
      this->IndexToPhysicalMatrix[11] = origin[2];
      this->IndexToPhysicalMatrix[12] = 0.0;
      this->IndexToPhysicalMatrix[13] = 0.0;
      this->IndexToPhysicalMatrix[14] = 0.0;
      this->IndexToPhysicalMatrix[15] = 1.0;
    }
  }

  //------------------------------------------------------------------------------
  ~vtkStructuredTPointBackend() override;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 9 /*VTK_EMPTY*/), ValueType>::type VTK_ALWAYS_INLINE
  mapStructuredXComponentImpl(int i) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description != 9 /*VTK_EMPTY*/), ValueType>::type VTK_ALWAYS_INLINE
  mapStructuredXComponentImpl(int i) const;

  //------------------------------------------------------------------------------
  ValueType mapStructuredXComponent(int i) const override;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 9 /*VTK_EMPTY*/), ValueType>::type VTK_ALWAYS_INLINE
  mapStructuredYComponentImpl(int j) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description != 9 /*VTK_EMPTY*/), ValueType>::type VTK_ALWAYS_INLINE
  mapStructuredYComponentImpl(int j) const;

  //------------------------------------------------------------------------------
  ValueType mapStructuredYComponent(int j) const override;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 9 /*VTK_EMPTY*/), ValueType>::type VTK_ALWAYS_INLINE
  mapStructuredZComponentImpl(int k) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description != 9 /*VTK_EMPTY*/), ValueType>::type VTK_ALWAYS_INLINE
  mapStructuredZComponentImpl(int k) const;

  //------------------------------------------------------------------------------
  ValueType mapStructuredZComponent(int k) const override;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 9 /*VTK_EMPTY*/), void>::type VTK_ALWAYS_INLINE
  mapStructuredTupleImpl(int ijk[3], ValueType tuple[3]) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description != 9 /*VTK_EMPTY*/), void>::type VTK_ALWAYS_INLINE
  mapStructuredTupleImpl(int ijk[3], ValueType tuple[3]) const;

  //------------------------------------------------------------------------------
  void mapStructuredTuple(int ijk[3], ValueType tuple[3]) const override;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 9 /*VTK_EMPTY*/), void>::type VTK_ALWAYS_INLINE
  ComputePointStructuredCoords(vtkIdType pointId, int ijk[3]) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 1 /*VTK_SINGLE_POINT*/), void>::type VTK_ALWAYS_INLINE
  ComputePointStructuredCoords(vtkIdType pointId, int ijk[3]) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 2 /*VTK_X_LINE*/), void>::type VTK_ALWAYS_INLINE
  ComputePointStructuredCoords(vtkIdType pointId, int ijk[3]) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 3 /*VTK_Y_LINE*/), void>::type VTK_ALWAYS_INLINE
  ComputePointStructuredCoords(vtkIdType pointId, int ijk[3]) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 4 /*VTK_Z_LINE*/), void>::type VTK_ALWAYS_INLINE
  ComputePointStructuredCoords(vtkIdType pointId, int ijk[3]) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 5 /*VTK_XY_PLANE*/), void>::type VTK_ALWAYS_INLINE
  ComputePointStructuredCoords(vtkIdType pointId, int ijk[3]) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 6 /*VTK_YZ_PLANE*/), void>::type VTK_ALWAYS_INLINE
  ComputePointStructuredCoords(vtkIdType pointId, int ijk[3]) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 7 /*VTK_XZ_PLANE*/), void>::type VTK_ALWAYS_INLINE
  ComputePointStructuredCoords(vtkIdType pointId, int ijk[3]) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 8 /*VTK_XYZ_GRID*/), void>::type VTK_ALWAYS_INLINE
  ComputePointStructuredCoords(vtkIdType pointId, int ijk[3]) const;

  //------------------------------------------------------------------------------
  void mapTuple(vtkIdType tupleId, ValueType tuple[3]) const override;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 9 /*VTK_EMPTY*/), ValueType>::type VTK_ALWAYS_INLINE
  mapComponentImpl(vtkIdType tupleId, int comp) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 1 /*VTK_SINGLE_POINT*/), ValueType>::type
    VTK_ALWAYS_INLINE
    mapComponentImpl(vtkIdType tupleId, int comp) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 2 /*VTK_X_LINE*/), ValueType>::type VTK_ALWAYS_INLINE
  mapComponentImpl(vtkIdType tupleId, int comp) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 3 /*VTK_Y_LINE*/), ValueType>::type VTK_ALWAYS_INLINE
  mapComponentImpl(vtkIdType tupleId, int comp) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 4 /*VTK_Z_LINE*/), ValueType>::type VTK_ALWAYS_INLINE
  mapComponentImpl(vtkIdType tupleId, int comp) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 5 /*VTK_XY_PLANE*/), ValueType>::type VTK_ALWAYS_INLINE
  mapComponentImpl(vtkIdType tupleId, int comp) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 6 /*VTK_YZ_PLANE*/), ValueType>::type VTK_ALWAYS_INLINE
  mapComponentImpl(vtkIdType tupleId, int comp) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 7 /*VTK_XZ_PLANE*/), ValueType>::type VTK_ALWAYS_INLINE
  mapComponentImpl(vtkIdType tupleId, int comp) const;

  //------------------------------------------------------------------------------
  template <int Description = DataDescription>
  typename std::enable_if<(Description == 8 /*VTK_XYZ_GRID*/), ValueType>::type VTK_ALWAYS_INLINE
  mapComponentImpl(vtkIdType tupleId, int comp) const;

  //------------------------------------------------------------------------------
  ValueType mapComponent(vtkIdType tupleId, int comp) const override;

  //------------------------------------------------------------------------------
  ValueType map(vtkIdType valueId) const override;
};
VTK_ABI_NAMESPACE_END

#endif // vtkStructuredPointBackend_h
/* VTK-HeaderTest-Exclude: vtkStructuredPointBackend.h */

#if defined(VTK_STRUCTURED_POINT_BACKEND_INSTANTIATING)

#define VTK_INSTANTIATE_STRUCTURED_POINT_BACKEND(ValueType)                                        \
  VTK_ABI_NAMESPACE_BEGIN                                                                          \
  template class VTKCOMMONCORE_EXPORT vtkStructuredPointBackend<ValueType>;                        \
  VTK_ABI_NAMESPACE_END
#elif defined(VTK_USE_EXTERN_TEMPLATE)

#ifndef VTK_STRUCTURED_POINT_BACKEND_TEMPLATE_EXTERN
#define VTK_STRUCTURED_POINT_BACKEND_TEMPLATE_EXTERN
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable : 4910) // extern and dllexport incompatible
#endif
VTK_ABI_NAMESPACE_BEGIN
vtkExternTemplateMacro(extern template class VTKCOMMONCORE_EXPORT vtkStructuredPointBackend);
VTK_ABI_NAMESPACE_END
#ifdef _MSC_VER
#pragma warning(pop)
#endif
#endif // VTK_STRUCTURED_POINT_BACKEND_TEMPLATE_EXTERN

#endif