VTK  9.5.20250802
vtkDataArray.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
138#ifndef vtkDataArray_h
139#define vtkDataArray_h
140
141#include "vtkAbstractArray.h"
142#include "vtkCommonCoreModule.h" // For export macro
143#include "vtkVTK_USE_SCALED_SOA_ARRAYS.h" // For #define of VTK_USE_SCALED_SOA_ARRAYS
144#include "vtkWrappingHints.h" // For VTK_MARSHALMANUAL
145
146VTK_ABI_NAMESPACE_BEGIN
147class vtkDoubleArray;
148class vtkIdList;
151class vtkLookupTable;
152class vtkPoints;
153
154class VTKCOMMONCORE_EXPORT VTK_MARSHALMANUAL vtkDataArray : public vtkAbstractArray
155{
156public:
158 void PrintSelf(ostream& os, vtkIndent indent) override;
159
166 static vtkDataArray* FastDownCast(vtkAbstractArray* source);
167
174 int IsNumeric() const override { return 1; }
175
181 int GetElementComponentSize() const override { return this->GetDataTypeSize(); }
182
183 // Reimplemented virtuals (doc strings are inherited from superclass):
185
190 void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) override;
192 void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
194 vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
196 vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) override;
197 void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) override;
199 void GetTuples(vtkIdList* tupleIds, vtkAbstractArray* output) override;
200 void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray* output) override;
202 double* weights) override;
203 void InterpolateTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx1, vtkAbstractArray* source1,
204 vtkIdType srcTupleIdx2, vtkAbstractArray* source2, double t) override;
205
211 virtual double* GetTuple(vtkIdType tupleIdx)
212 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples()) = 0;
213
219 virtual void GetTuple(vtkIdType tupleIdx, double* tuple)
220 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples()) = 0;
221
223
232 virtual void GetIntegerTuple(vtkIdType tupleIdx, vtkTypeInt64* tuple)
233 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples());
234 virtual void SetIntegerTuple(vtkIdType tupleIdx, vtkTypeInt64* tuple)
235 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples());
237
239
248 virtual void GetUnsignedTuple(vtkIdType tupleIdx, vtkTypeUInt64* tuple)
249 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples());
250 virtual void SetUnsignedTuple(vtkIdType tupleIdx, vtkTypeUInt64* tuple)
251 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples());
253
255
260 double GetTuple1(vtkIdType tupleIdx) VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples());
261 double* GetTuple2(vtkIdType tupleIdx) VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
262 VTK_SIZEHINT(2);
263 double* GetTuple3(vtkIdType tupleIdx) VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
264 VTK_SIZEHINT(3);
265 double* GetTuple4(vtkIdType tupleIdx) VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
266 VTK_SIZEHINT(4);
267 double* GetTuple6(vtkIdType tupleIdx) VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
268 VTK_SIZEHINT(6);
269 double* GetTuple9(vtkIdType tupleIdx) VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
270 VTK_SIZEHINT(9);
272
274
279 virtual void SetTuple(vtkIdType tupleIdx, const float* tuple)
280 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples());
281 virtual void SetTuple(vtkIdType tupleIdx, const double* tuple)
282 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples());
284
286
291 void SetTuple1(vtkIdType tupleIdx, double value)
292 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples());
293 void SetTuple2(vtkIdType tupleIdx, double val0, double val1)
294 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples());
295 void SetTuple3(vtkIdType tupleIdx, double val0, double val1, double val2)
296 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples());
297 void SetTuple4(vtkIdType tupleIdx, double val0, double val1, double val2, double val3)
298 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples());
299 void SetTuple6(vtkIdType tupleIdx, double val0, double val1, double val2, double val3,
300 double val4, double val5) VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples());
301 void SetTuple9(vtkIdType tupleIdx, double val0, double val1, double val2, double val3,
302 double val4, double val5, double val6, double val7, double val8)
303 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples());
305
307
311 virtual void InsertTuple(vtkIdType tupleIdx, const float* tuple) VTK_EXPECTS(0 <= tupleIdx) = 0;
312 virtual void InsertTuple(vtkIdType tupleIdx, const double* tuple) VTK_EXPECTS(0 <= tupleIdx) = 0;
314
316
321 void InsertTuple1(vtkIdType tupleIdx, double value) VTK_EXPECTS(0 <= tupleIdx);
322 void InsertTuple2(vtkIdType tupleIdx, double val0, double val1) VTK_EXPECTS(0 <= tupleIdx);
323 void InsertTuple3(vtkIdType tupleIdx, double val0, double val1, double val2)
324 VTK_EXPECTS(0 <= tupleIdx);
325 void InsertTuple4(vtkIdType tupleIdx, double val0, double val1, double val2, double val3)
326 VTK_EXPECTS(0 <= tupleIdx);
327 void InsertTuple6(vtkIdType tupleIdx, double val0, double val1, double val2, double val3,
328 double val4, double val5) VTK_EXPECTS(0 <= tupleIdx);
329 void InsertTuple9(vtkIdType tupleIdx, double val0, double val1, double val2, double val3,
330 double val4, double val5, double val6, double val7, double val8) VTK_EXPECTS(0 <= tupleIdx);
332
334
339 virtual vtkIdType InsertNextTuple(const float* tuple) = 0;
340 virtual vtkIdType InsertNextTuple(const double* tuple) = 0;
342
344
349 void InsertNextTuple1(double value);
350 void InsertNextTuple2(double val0, double val1);
351 void InsertNextTuple3(double val0, double val1, double val2);
352 void InsertNextTuple4(double val0, double val1, double val2, double val3);
353 void InsertNextTuple6(
354 double val0, double val1, double val2, double val3, double val4, double val5);
355 void InsertNextTuple9(double val0, double val1, double val2, double val3, double val4,
356 double val5, double val6, double val7, double val8);
358
360
365 virtual void RemoveTuple(vtkIdType tupleIdx)
366 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples()) = 0;
367 virtual void RemoveFirstTuple() { this->RemoveTuple(0); }
368 virtual void RemoveLastTuple();
370
375 virtual double GetComponent(vtkIdType tupleIdx, int compIdx)
376 VTK_EXPECTS(0 <= tupleIdx && GetNumberOfComponents() * tupleIdx + compIdx < GetNumberOfValues())
377 VTK_EXPECTS(0 <= compIdx && compIdx < GetNumberOfComponents());
378
386 virtual void SetComponent(vtkIdType tupleIdx, int compIdx, double value)
387 VTK_EXPECTS(0 <= tupleIdx && GetNumberOfComponents() * tupleIdx + compIdx < GetNumberOfValues())
388 VTK_EXPECTS(0 <= compIdx && compIdx < GetNumberOfComponents());
389
394 virtual void InsertComponent(vtkIdType tupleIdx, int compIdx, double value)
395 VTK_EXPECTS(0 <= tupleIdx) VTK_EXPECTS(0 <= compIdx && compIdx < GetNumberOfComponents());
396
405 virtual void GetData(
406 vtkIdType tupleMin, vtkIdType tupleMax, int compMin, int compMax, vtkDoubleArray* data);
407
409
413 void DeepCopy(vtkAbstractArray* aa) override;
414 virtual void DeepCopy(vtkDataArray* da);
416
426 virtual void ShallowCopy(vtkDataArray* other);
427
434 virtual void FillComponent(int compIdx, double value)
435 VTK_EXPECTS(0 <= compIdx && compIdx < GetNumberOfComponents());
436
440 virtual void Fill(double value);
441
450 virtual void CopyComponent(int dstComponent, vtkDataArray* src, int srcComponent);
451
457 virtual void* WriteVoidPointer(vtkIdType valueIdx, vtkIdType numValues) = 0;
458
467 unsigned long GetActualMemorySize() const override;
468
473 void CreateDefaultLookupTable();
474
476
479 void SetLookupTable(vtkLookupTable* lut);
480 vtkGetObjectMacro(LookupTable, vtkLookupTable);
482
484
501 void GetRange(double range[2], int comp) { this->ComputeRange(range, comp); }
502 void GetRange(double range[2], int comp, const unsigned char* ghosts, unsigned char ghostsToSkip)
503 {
504 this->ComputeRange(range, comp, ghosts, ghostsToSkip);
505 }
507
509
517 double* GetRange(int comp) VTK_SIZEHINT(2)
518 {
519 this->GetRange(this->Range, comp);
520 return this->Range;
521 }
523
531 double* GetRange() VTK_SIZEHINT(2) { return this->GetRange(0); }
532
541 void GetRange(double range[2]) { this->GetRange(range, 0); }
542
544
562 void GetFiniteRange(double range[2], int comp) { this->ComputeFiniteRange(range, comp); }
564 double range[2], int comp, const unsigned char* ghosts, unsigned char ghostsToSkip)
565 {
566 this->ComputeFiniteRange(range, comp, ghosts, ghostsToSkip);
567 }
569
571
579 double* GetFiniteRange(int comp) VTK_SIZEHINT(2)
580 {
581 this->GetFiniteRange(this->FiniteRange, comp);
582 return this->FiniteRange;
583 }
585
593 double* GetFiniteRange() VTK_SIZEHINT(2) { return this->GetFiniteRange(0); }
594
603 void GetFiniteRange(double range[2]) { this->GetFiniteRange(range, 0); }
604
606
611 void GetDataTypeRange(double range[2]);
614 static void GetDataTypeRange(int type, double range[2]);
615 static double GetDataTypeMin(int type);
616 static double GetDataTypeMax(int type);
618
623 virtual double GetMaxNorm();
624
634 static vtkDataArray* CreateDataArray(int dataType);
635
645
655
665
669 void Modified() override;
670
676
684 int CopyInformation(vtkInformation* infoFrom, vtkTypeBool deep = 1) override;
685
689 int GetArrayType() const override { return DataArray; }
690
691protected:
692 friend class vtkPoints;
693 friend class vtkFieldData;
694
696
712 virtual void ComputeRange(double range[2], int comp);
713 virtual void ComputeRange(
714 double range[2], int comp, const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
716
718
734 virtual void ComputeFiniteRange(double range[2], int comp);
735 virtual void ComputeFiniteRange(
736 double range[2], int comp, const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
738
740
755 virtual bool ComputeScalarRange(double* ranges);
756 virtual bool ComputeScalarRange(
757 double* ranges, const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
759
761
773 virtual bool ComputeVectorRange(double range[2]);
774 virtual bool ComputeVectorRange(
775 double range[2], const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
777
779
793 virtual bool ComputeFiniteScalarRange(double* ranges);
795 double* ranges, const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
797
799
811 virtual bool ComputeFiniteVectorRange(double range[2]);
813 double range[2], const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
815
816 // Construct object with default tuple dimension (number of components) of 1.
818 ~vtkDataArray() override;
819
821 double Range[2];
822 double FiniteRange[2];
823
824private:
825 double* GetTupleN(vtkIdType i, int n);
826
827 vtkDataArray(const vtkDataArray&) = delete;
828 void operator=(const vtkDataArray&) = delete;
829};
830
831//------------------------------------------------------------------------------
833{
834 if (source)
835 {
836 switch (source->GetArrayType())
837 {
840 case ImplicitArray:
841 case TypedDataArray:
842 case DataArray:
843 case MappedDataArray:
844 return static_cast<vtkDataArray*>(source);
845 default:
846 break;
847 }
848 }
849 return nullptr;
850}
851
853VTK_ABI_NAMESPACE_END
854
855// These are used by vtkDataArrayPrivate.txx, but need to be available to
856// vtkGenericDataArray.h as well.
857namespace vtkDataArrayPrivate
858{
859VTK_ABI_NAMESPACE_BEGIN
861{
862};
864{
865};
866VTK_ABI_NAMESPACE_END
867}
868
869#endif
Abstract superclass for all arrays.
int GetNumberOfComponents() const
Set/Get the dimension (n) of the components.
vtkIdType GetNumberOfTuples() const
Get the number of complete tuples (a component group) in the array.
virtual int GetDataTypeSize() const =0
Return the size of the underlying data type.
vtkIdType GetNumberOfValues() const
Get the total number of values in the array.
abstract superclass for arrays of numeric data
virtual double * GetTuple(vtkIdType tupleIdx)=0
Get the data tuple at tupleIdx.
double * GetRange()
Return the range of the data array.
virtual void ComputeRange(double range[2], int comp, const unsigned char *ghosts, unsigned char ghostsToSkip=0xff)
Compute the range for a specific component.
static double GetDataTypeMin(int type)
These methods return the Min and Max possible range of the native data type.
double * GetTuple2(vtkIdType tupleIdx)
These methods are included as convenience for the wrappers.
void InterpolateTuple(vtkIdType dstTupleIdx, vtkIdList *ptIndices, vtkAbstractArray *source, double *weights) override
Set the tuple at dstTupleIdx in this array to the interpolated tuple value, given the ptIndices in th...
virtual bool ComputeScalarRange(double *ranges, const unsigned char *ghosts, unsigned char ghostsToSkip=0xff)
Computes the range for each component of an array, the length of ranges must be two times the number ...
virtual bool ComputeVectorRange(double range[2])
Returns true if the range was computed.
int IsNumeric() const override
This method is here to make backward compatibility easier.
void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
See documentation from parent class.
void GetDataTypeRange(double range[2])
These methods return the Min and Max possible range of the native data type.
void InterpolateTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx1, vtkAbstractArray *source1, vtkIdType srcTupleIdx2, vtkAbstractArray *source2, double t) override
Insert the tuple at dstTupleIdx in this array to the tuple interpolated from the two tuple indices,...
virtual void ComputeRange(double range[2], int comp)
Compute the range for a specific component.
double * GetFiniteRange()
Return the range of the data array.
virtual bool ComputeScalarRange(double *ranges)
Computes the range for each component of an array, the length of ranges must be two times the number ...
void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source) override
See documentation from parent class.
virtual bool ComputeFiniteVectorRange(double range[2], const unsigned char *ghosts, unsigned char ghostsToSkip=0xff)
Returns true if the range was computed.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void GetIntegerTuple(vtkIdType tupleIdx, vtkTypeInt64 *tuple)
Get/set the data at tupleIdx by filling in a user-provided array of integers.
virtual void SetIntegerTuple(vtkIdType tupleIdx, vtkTypeInt64 *tuple)
Get/set the data at tupleIdx by filling in a user-provided array of integers.
virtual bool ComputeVectorRange(double range[2], const unsigned char *ghosts, unsigned char ghostsToSkip=0xff)
Returns true if the range was computed.
~vtkDataArray() override
int GetArrayType() const override
Method for type-checking in FastDownCast implementations.
int GetElementComponentSize() const override
Return the size, in bytes, of the lowest-level element of an array.
virtual bool ComputeFiniteVectorRange(double range[2])
Returns true if the range was computed.
virtual void SetUnsignedTuple(vtkIdType tupleIdx, vtkTypeUInt64 *tuple)
Get/set the data at tupleIdx by filling in a user-provided array of unsigned integers.
virtual void GetUnsignedTuple(vtkIdType tupleIdx, vtkTypeUInt64 *tuple)
Get/set the data at tupleIdx by filling in a user-provided array of unsigned integers.
virtual void RemoveLastTuple()
These methods remove tuples from the data array.
double * GetRange(int comp)
Return the range of the data array values for the given component.
void GetFiniteRange(double range[2], int comp)
The range of the data array values for the given component will be returned in the provided range arr...
void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray *output) override
Get the tuples for the range of tuple ids specified (i.e., p1->p2 inclusive).
double GetDataTypeMin()
These methods return the Min and Max possible range of the native data type.
void InsertTuplesStartingAt(vtkIdType dstStart, vtkIdList *srcIds, vtkAbstractArray *source) override
See documentation from parent class.
void GetTuples(vtkIdList *tupleIds, vtkAbstractArray *output) override
Given a list of tuple ids, return an array of tuples.
virtual void GetTuple(vtkIdType tupleIdx, double *tuple)=0
Get the data tuple at tupleIdx by filling in a user-provided array, Make sure that your array is larg...
double GetTuple1(vtkIdType tupleIdx)
These methods are included as convenience for the wrappers.
double GetDataTypeMax()
These methods return the Min and Max possible range of the native data type.
void GetRange(double range[2])
The range of the data array values will be returned in the provided range array argument.
static vtkDataArray * FastDownCast(vtkAbstractArray *source)
Perform a fast, safe cast from a vtkAbstractArray to a vtkDataArray.
virtual double GetComponent(vtkIdType tupleIdx, int compIdx)
Return the data component at the location specified by tupleIdx and compIdx.
int CopyInformation(vtkInformation *infoFrom, vtkTypeBool deep=1) override
Copy information instance.
vtkIdType InsertNextTuple(vtkIdType srcTupleIdx, vtkAbstractArray *source) override
See documentation from parent class.
virtual void ComputeFiniteRange(double range[2], int comp)
Compute the range for a specific component.
virtual double GetMaxNorm()
Return the maximum norm for the tuples.
void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
See documentation from parent class.
void GetRange(double range[2], int comp, const unsigned char *ghosts, unsigned char ghostsToSkip)
The range of the data array values for the given component will be returned in the provided range arr...
static void GetDataTypeRange(int type, double range[2])
These methods return the Min and Max possible range of the native data type.
virtual bool ComputeFiniteScalarRange(double *ranges, const unsigned char *ghosts, unsigned char ghostsToSkip=0xff)
Computes the range for each component of an array, the length of ranges must be two times the number ...
virtual void ComputeFiniteRange(double range[2], int comp, const unsigned char *ghosts, unsigned char ghostsToSkip=0xff)
Compute the range for a specific component.
static vtkDataArray * CreateDataArray(int dataType)
Creates an array for dataType where dataType is one of VTK_BIT, VTK_CHAR, VTK_SIGNED_CHAR,...
void GetFiniteRange(double range[2], int comp, const unsigned char *ghosts, unsigned char ghostsToSkip)
The range of the data array values for the given component will be returned in the provided range arr...
void GetFiniteRange(double range[2])
The range of the data array values will be returned in the provided range array argument.
double * GetFiniteRange(int comp)
Return the range of the data array values for the given component.
void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray *source) override
See documentation from parent class.
virtual bool ComputeFiniteScalarRange(double *ranges)
Computes the range for each component of an array, the length of ranges must be two times the number ...
void Modified() override
Removes out-of-date L2_NORM_RANGE() and L2_NORM_FINITE_RANGE() values.
static double GetDataTypeMax(int type)
These methods return the Min and Max possible range of the native data type.
vtkLookupTable * LookupTable
dynamic, self-adjusting array of double
Represents and manipulates a collection of data arrays.
list of point or cell ids
Definition vtkIdList.h:133
a simple class to control print indentation
Definition vtkIndent.h:108
Key for string values in vtkInformation.
Store vtkAlgorithm input/output information.
map scalar values into colors via a lookup table
represent and manipulate 3D points
Definition vtkPoints.h:139
static vtkInformationDoubleVectorKey * COMPONENT_RANGE()
This key is used to hold tight bounds on the range of one component over all tuples of the array.
static vtkInformationDoubleVectorKey * L2_NORM_RANGE()
This key is used to hold tight bounds on the $L_2$ norm of tuples in the array.
static vtkInformationDoubleVectorKey * L2_NORM_FINITE_RANGE()
This key is used to hold tight bounds on the $L_2$ norm of tuples in the array.
static vtkInformationStringKey * UNITS_LABEL()
A human-readable string indicating the units for the array data.
int vtkTypeBool
Definition vtkABI.h:64
#define vtkArrayDownCast_FastCastMacro(ArrayT)
This macro is used to tell vtkArrayDownCast to use FastDownCast instead of SafeDownCast.
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
#define vtkDataArray
int vtkIdType
Definition vtkType.h:332
#define VTK_SIZEHINT(...)
#define VTK_EXPECTS(x)
#define VTK_MARSHALMANUAL
#define VTK_NEWINSTANCE