VTK  9.2.6
vtkPeriodicDataArray.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPeriodicDataArray.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 =========================================================================*/
15 
29 #ifndef vtkPeriodicDataArray_h
30 #define vtkPeriodicDataArray_h
31 
32 #include "vtkAOSDataArrayTemplate.h" // Template
33 #include "vtkGenericDataArray.h" // Parent
34 
35 template <class Scalar>
36 class vtkPeriodicDataArray : public vtkGenericDataArray<vtkPeriodicDataArray<Scalar>, Scalar>
37 {
39 
40 public:
42  typedef typename Superclass::ValueType ValueType;
43 
44  void PrintSelf(ostream& os, vtkIndent indent) override;
45 
50 
54  void Initialize() override;
55 
59  void GetTuples(vtkIdList* ptIds, vtkAbstractArray* output) override;
60 
64  void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray* output) override;
65 
69  void Squeeze() override;
70 
75 
80 
84  void LookupValue(vtkVariant value, vtkIdList* ids) override;
85 
89  vtkVariant GetVariantValue(vtkIdType idx) override;
90 
94  void ClearLookup() override;
95 
100  double* GetTuple(vtkIdType i) override;
101 
105  void GetTuple(vtkIdType i, double* tuple) override;
106 
110  vtkIdType LookupTypedValue(Scalar value) override;
111 
115  void LookupTypedValue(Scalar value, vtkIdList* ids) override;
116 
122  ValueType GetValue(vtkIdType idx) const;
123 
129  ValueType& GetValueReference(vtkIdType idx);
130 
134  void GetTypedTuple(vtkIdType idx, Scalar* t) const;
135 
141  ValueType GetTypedComponent(vtkIdType tupleIdx, int compIdx) const;
142 
146  unsigned long GetActualMemorySize() const override;
147 
151  vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext) override;
152 
156  vtkTypeBool Resize(vtkIdType numTuples) override;
157 
161  void SetNumberOfTuples(vtkIdType number) override;
162 
166  void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) override;
167 
171  void SetTuple(vtkIdType i, const float* source) override;
172 
176  void SetTuple(vtkIdType i, const double* source) override;
177 
181  void InsertTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) override;
182 
186  void InsertTuple(vtkIdType i, const float* source) override;
187 
191  void InsertTuple(vtkIdType i, const double* source) override;
192 
196  void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
197 
202  vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) override;
203 
207  void InsertTuples(
208  vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
209 
214 
218  vtkIdType InsertNextTuple(const float* source) override;
219 
223  vtkIdType InsertNextTuple(const double* source) override;
224 
228  void DeepCopy(vtkAbstractArray* aa) override;
229 
233  void DeepCopy(vtkDataArray* da) override;
234 
238  void InterpolateTuple(
239  vtkIdType i, vtkIdList* ptIndices, vtkAbstractArray* source, double* weights) override;
240 
245  vtkAbstractArray* source2, double t) override;
246 
250  void SetVariantValue(vtkIdType idx, vtkVariant value) override;
251 
255  void InsertVariantValue(vtkIdType idx, vtkVariant value) override;
256 
260  void RemoveTuple(vtkIdType id) override;
261 
265  void RemoveFirstTuple() override;
266 
270  void RemoveLastTuple() override;
271 
275  void SetTypedTuple(vtkIdType i, const Scalar* t);
276 
280  void SetTypedComponent(vtkIdType t, int c, Scalar v);
281 
285  void InsertTypedTuple(vtkIdType i, const Scalar* t);
286 
290  vtkIdType InsertNextTypedTuple(const Scalar* t);
291 
295  void SetValue(vtkIdType idx, Scalar value);
296 
300  vtkIdType InsertNextValue(Scalar v);
301 
305  void InsertValue(vtkIdType idx, Scalar v);
306 
308 
311  vtkSetMacro(Normalize, bool);
312  vtkGetMacro(Normalize, bool);
314 
315 protected:
317  ~vtkPeriodicDataArray() override;
318 
320 
323  bool AllocateTuples(vtkIdType numTuples);
324  bool ReallocateTuples(vtkIdType numTuples);
326 
330  virtual void Transform(Scalar* tuple) const = 0;
331 
332  using Superclass::ComputeFiniteScalarRange;
333  using Superclass::ComputeFiniteVectorRange;
334  using Superclass::ComputeScalarRange;
335  using Superclass::ComputeVectorRange;
336 
340  bool ComputeScalarRange(double* range) override;
341 
345  bool ComputeVectorRange(double range[2]) override;
346 
350  bool ComputeFiniteScalarRange(double* range) override;
351 
355  bool ComputeFiniteVectorRange(double range[2]) override;
356 
360  virtual void ComputePeriodicRange(bool finite = false);
361 
365  void InvalidateRange();
366 
367  bool Normalize; // If transformed vector must be normalized
368 
369 private:
371  void operator=(const vtkPeriodicDataArray&) = delete;
372 
373  friend class vtkGenericDataArray<vtkPeriodicDataArray<Scalar>, Scalar>;
374 
375  Scalar* TempScalarArray; // Temporary array used by GetTypedTuple methods
376  double* TempDoubleArray; // Temporary array used by GetTuple vethods
377  vtkIdType TempTupleIdx; // Location of currently stored Temp Tuple to use as cache
378  vtkAOSDataArrayTemplate<Scalar>* Data; // Original data
379 
380  bool InvalidRange = true;
381  double PeriodicRange[6]; // Transformed periodic range
382  bool InvalidFiniteRange = true;
383  double PeriodicFiniteRange[6]; // Transformed periodic finite range
384 };
385 
386 #include "vtkPeriodicDataArray.txx"
387 
388 #endif // vtkPeriodicDataArray_h
389 // VTK-HeaderTest-Exclude: vtkPeriodicDataArray.h
vtkIdType InsertNextValue(Scalar v)
Read only container, not supported.
void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source) override
Read only container, not supported.
void RemoveFirstTuple() override
Read only container, not supported.
ValueType GetValue(vtkIdType idx) const
Get value at index idx.
bool ComputeFiniteVectorRange(double range[2]) override
Get the transformed finite range on all components.
Abstract superclass for all arrays.
vtkIdType LookupTypedValue(Scalar value) override
Not implemented.
void DeepCopy(vtkAbstractArray *aa) override
Read only container, not supported.
void InsertValue(vtkIdType idx, Scalar v)
Read only container, not supported.
bool AllocateTuples(vtkIdType numTuples)
Read only container, not supported.
vtkTemplateTypeMacro(vtkPeriodicDataArray< Scalar >, GenericBase)
vtkIdType LookupValue(vtkVariant value) override
Not implemented.
virtual void ComputePeriodicRange(bool finite=false)
Update the transformed periodic range.
void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
Read only container, not supported.
void InvalidateRange()
Set the invalid range flag to false.
ValueType GetTypedComponent(vtkIdType tupleIdx, int compIdx) const
Return the requested component of the specified tuple.
Superclass::ValueType ValueType
int vtkIdType
Definition: vtkType.h:332
Base interface for all typed vtkDataArray subclasses.
A atomic type representing the union of many types.
Definition: vtkVariant.h:69
void SetTypedTuple(vtkIdType i, const Scalar *t)
Read only container, not supported.
vtkVariant GetVariantValue(vtkIdType idx) override
Not implemented.
vtkIdType InsertNextTuple(vtkIdType j, vtkAbstractArray *source) override
Read only container, error.
void Squeeze() override
No effect.
int vtkTypeBool
Definition: vtkABI.h:69
void Initialize() override
Initialize array with zero values.
void SetNumberOfTuples(vtkIdType number) override
Read only container, not supported.
void InsertTypedTuple(vtkIdType i, const Scalar *t)
Read only container, not supported.
Map native an Array into an angulat periodic array.
void InterpolateTuple(vtkIdType i, vtkIdList *ptIndices, vtkAbstractArray *source, double *weights) override
Read only container, not supported.
void ClearLookup() override
Not implemented.
bool ComputeFiniteScalarRange(double *range) override
Get the finite transformed range by components.
a simple class to control print indentation
Definition: vtkIndent.h:39
unsigned long GetActualMemorySize() const override
Return the memory in kilobytes consumed by this data array.
list of point or cell ids
Definition: vtkIdList.h:33
void InsertTuplesStartingAt(vtkIdType dstStart, vtkIdList *srcIds, vtkAbstractArray *source) override
Read only container, not supported.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
void InsertVariantValue(vtkIdType idx, vtkVariant value) override
Read only container, not supported.
void SetTypedComponent(vtkIdType t, int c, Scalar v)
Read only container, not supported.
virtual void Transform(Scalar *tuple) const =0
Transform the provided tuple.
Abstract superclass to iterate over elements in an vtkAbstractArray.
double * GetTuple(vtkIdType i) override
Return tuple at location i.
vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext) override
Read only container, not supported.
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
#define VTK_NEWINSTANCE
void InitializeArray(vtkAOSDataArrayTemplate< Scalar > *inputData)
Initialize the mapped array with the original input data array.
void InsertTuple(vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
Read only container, not supported.
bool ComputeScalarRange(double *range) override
Get the transformed range by components.
void GetTypedTuple(vtkIdType idx, Scalar *t) const
Copy tuple value at location idx into provided array.
void RemoveTuple(vtkIdType id) override
Read only container, not supported.
bool ReallocateTuples(vtkIdType numTuples)
Read only container, not supported.
~vtkPeriodicDataArray() override
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void RemoveLastTuple() override
Read only container, not supported.
vtkArrayIterator * NewIterator() override
Not implemented.
vtkTypeBool Resize(vtkIdType numTuples) override
Read only container, not supported.
ValueType & GetValueReference(vtkIdType idx)
Get value at index idx as reference.
void SetVariantValue(vtkIdType idx, vtkVariant value) override
Read only container, not supported.
void GetTuples(vtkIdList *ptIds, vtkAbstractArray *output) override
Copy tuples values, selected by ptIds into provided array.
void SetValue(vtkIdType idx, Scalar value)
Read only container, not supported.
bool ComputeVectorRange(double range[2]) override
Get the transformed range on all components.
vtkIdType InsertNextTypedTuple(const Scalar *t)
Read only container, not supported.