vtkArray Class Reference
#include <vtkArray.h>
Detailed Description
Abstract interface for N-dimensional arrays.vtkArray is the root of a hierarchy of arrays that can be used to store data with any number of dimensions. It provides an abstract interface for retrieving and setting array attributes that are independent of the type of values stored in the array - such as the number of dimensions, extents along each dimension, and number of values stored in the array.
To get and set array values, the vtkTypedArray template class derives from vtkArray and provides type-specific methods for retrieval and update.
Two concrete derivatives of vtkTypedArray are provided at the moment: vtkDenseArray and vtkSparseArray, which provide dense and sparse storage for arbitrary-dimension data, respectively. Toolkit users can create their own concrete derivatives that implement alternative storage strategies, such as compressed-sparse-row, etc. You could also create an array that provided read-only access to 'virtual' data, such as an array that returned a Fibonacci sequence, etc.
- See also:
- vtkTypedArray, vtkDenseArray, vtkSparseArray
- Thanks:
- Developed by Timothy M. Shead (tshead@sandia.gov) at Sandia National Laboratories.
- Examples:
- vtkArray (Examples)
- Tests:
- vtkArray (Tests)
Definition at line 68 of file vtkArray.h.
Member Typedef Documentation
| typedef vtkObject vtkArray::Superclass |
Reimplemented from vtkObject.
Reimplemented in vtkTypeTemplate< vtkSparseArray< T >, vtkTypedArray< T > >, vtkTypeTemplate< vtkTypedArray< T >, vtkArray >, and vtkTypeTemplate< vtkDenseArray< T >, vtkTypedArray< T > >.
Definition at line 71 of file vtkArray.h.
Reimplemented in vtkDenseArray< T >, vtkSparseArray< T >, and vtkTypedArray< T >.
Definition at line 74 of file vtkArray.h.
Reimplemented in vtkDenseArray< T >, and vtkSparseArray< T >.
Definition at line 75 of file vtkArray.h.
Reimplemented in vtkDenseArray< T >, vtkSparseArray< T >, and vtkTypedArray< T >.
Definition at line 76 of file vtkArray.h.
Member Enumeration Documentation
| anonymous enum |
- Enumerator:
-
DENSE Used with CreateArray() to create dense arrays. SPARSE Used with CreateArray() to create sparse arrays.
Definition at line 79 of file vtkArray.h.
Constructor & Destructor Documentation
| vtkArray::vtkArray | ( | ) | [protected] |
| vtkArray::~vtkArray | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkArray::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkObject.
| static int vtkArray::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkTypeTemplate< vtkSparseArray< T >, vtkTypedArray< T > >, vtkTypeTemplate< vtkTypedArray< T >, vtkArray >, and vtkTypeTemplate< vtkDenseArray< T >, vtkTypedArray< T > >.
| virtual int vtkArray::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkTypeTemplate< vtkSparseArray< T >, vtkTypedArray< T > >, vtkTypeTemplate< vtkTypedArray< T >, vtkArray >, and vtkTypeTemplate< vtkDenseArray< T >, vtkTypedArray< T > >.
| void vtkArray::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkObject.
Reimplemented in vtkDenseArray< T >, vtkSparseArray< T >, and vtkTypedArray< T >.
| static vtkArray* vtkArray::CreateArray | ( | int | StorageType, | |
| int | ValueType | |||
| ) | [static] |
Creates a new array where StorageType is one of vtkArray::DENSE or vtkArray::SPARSE, and ValueType is one of VTK_CHAR, VTK_UNSIGNED_CHAR, VTK_SHORT, VTK_UNSIGNED_SHORT, VTK_INT, VTK_UNSIGNED_INT, VTK_LONG, VTK_UNSIGNED_LONG, VTK_DOUBLE, VTK_ID_TYPE, or VTK_STRING. The caller is responsible for the lifetime of the returned object.
| virtual bool vtkArray::IsDense | ( | ) | [pure virtual] |
Returns true iff the underlying array storage is "dense", i.e. that GetSize() and GetNonNullSize() will always return the same value. If not, the array is "sparse".
Implemented in vtkDenseArray< T >, and vtkSparseArray< T >.
| void vtkArray::Resize | ( | const CoordinateT | i | ) |
Resizes the array to the given extents (number of dimensions and size of each dimension). Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize(). The contents of the array are undefined after calling Resize() - you should initialize its contents accordingly. In particular, dimension-labels will be undefined, dense array values will be undefined, and sparse arrays will be empty.
| void vtkArray::Resize | ( | const CoordinateT | i, | |
| const CoordinateT | j | |||
| ) |
Resizes the array to the given extents (number of dimensions and size of each dimension). Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize(). The contents of the array are undefined after calling Resize() - you should initialize its contents accordingly. In particular, dimension-labels will be undefined, dense array values will be undefined, and sparse arrays will be empty.
| void vtkArray::Resize | ( | const CoordinateT | i, | |
| const CoordinateT | j, | |||
| const CoordinateT | k | |||
| ) |
Resizes the array to the given extents (number of dimensions and size of each dimension). Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize(). The contents of the array are undefined after calling Resize() - you should initialize its contents accordingly. In particular, dimension-labels will be undefined, dense array values will be undefined, and sparse arrays will be empty.
| void vtkArray::Resize | ( | const vtkArrayRange & | i | ) |
Resizes the array to the given extents (number of dimensions and size of each dimension). Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize(). The contents of the array are undefined after calling Resize() - you should initialize its contents accordingly. In particular, dimension-labels will be undefined, dense array values will be undefined, and sparse arrays will be empty.
| void vtkArray::Resize | ( | const vtkArrayRange & | i, | |
| const vtkArrayRange & | j | |||
| ) |
Resizes the array to the given extents (number of dimensions and size of each dimension). Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize(). The contents of the array are undefined after calling Resize() - you should initialize its contents accordingly. In particular, dimension-labels will be undefined, dense array values will be undefined, and sparse arrays will be empty.
| void vtkArray::Resize | ( | const vtkArrayRange & | i, | |
| const vtkArrayRange & | j, | |||
| const vtkArrayRange & | k | |||
| ) |
Resizes the array to the given extents (number of dimensions and size of each dimension). Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize(). The contents of the array are undefined after calling Resize() - you should initialize its contents accordingly. In particular, dimension-labels will be undefined, dense array values will be undefined, and sparse arrays will be empty.
| void vtkArray::Resize | ( | const vtkArrayExtents & | extents | ) |
Resizes the array to the given extents (number of dimensions and size of each dimension). Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize(). The contents of the array are undefined after calling Resize() - you should initialize its contents accordingly. In particular, dimension-labels will be undefined, dense array values will be undefined, and sparse arrays will be empty.
| const vtkArrayRange vtkArray::GetExtent | ( | DimensionT | dimension | ) |
Returns the extent (valid coordinate range) along the given dimension.
| virtual const vtkArrayExtents& vtkArray::GetExtents | ( | ) | [pure virtual] |
Returns the extent (valid coordinate range) along the given dimension.
Implemented in vtkDenseArray< T >, and vtkSparseArray< T >.
| DimensionT vtkArray::GetDimensions | ( | ) |
Returns the number of dimensions stored in the array. Note that this is the same as calling GetExtents().GetDimensions().
| SizeT vtkArray::GetSize | ( | ) |
Returns the number of values stored in the array. Note that this is the same as calling GetExtents().GetSize(), and represents the maximum number of values that could ever be stored using the current extents. This is equal to the number of values stored in a dense array, but may be larger than the number of values stored in a sparse array.
| virtual SizeT vtkArray::GetNonNullSize | ( | ) | [pure virtual] |
Returns the number of non-null values stored in the array. Note that this value will equal GetSize() for dense arrays, and will be less-than-or-equal to GetSize() for sparse arrays.
Implemented in vtkDenseArray< T >, and vtkSparseArray< T >.
| void vtkArray::SetName | ( | const vtkStdString & | name | ) |
Sets the array name.
| vtkStdString vtkArray::GetName | ( | ) |
Sets the array name.
| void vtkArray::SetDimensionLabel | ( | DimensionT | i, | |
| const vtkStdString & | label | |||
| ) |
Sets the label for the i-th array dimension.
| vtkStdString vtkArray::GetDimensionLabel | ( | DimensionT | i | ) |
Returns the label for the i-th array dimension.
| virtual void vtkArray::GetCoordinatesN | ( | const SizeT | n, | |
| vtkArrayCoordinates & | coordinates | |||
| ) | [pure virtual] |
Returns the coordinates of the n-th value in the array, where n is in the range [0, GetNonNullSize()). Note that the order in which coordinates are visited is undefined, but is guaranteed to match the order in which values are visited using vtkTypedArray::GetValueN() and vtkTypedArray::SetValueN().
| vtkVariant vtkArray::GetVariantValue | ( | CoordinateT | i | ) | [inline] |
Returns the value stored in the array at the given coordinates. Note that the number of dimensions in the supplied coordinates must match the number of dimensions in the array.
Definition at line 236 of file vtkArray.h.
| vtkVariant vtkArray::GetVariantValue | ( | CoordinateT | i, | |
| CoordinateT | j | |||
| ) | [inline] |
Returns the value stored in the array at the given coordinates. Note that the number of dimensions in the supplied coordinates must match the number of dimensions in the array.
Definition at line 241 of file vtkArray.h.
| vtkVariant vtkArray::GetVariantValue | ( | CoordinateT | i, | |
| CoordinateT | j, | |||
| CoordinateT | k | |||
| ) | [inline] |
Returns the value stored in the array at the given coordinates. Note that the number of dimensions in the supplied coordinates must match the number of dimensions in the array.
Definition at line 246 of file vtkArray.h.
| virtual vtkVariant vtkArray::GetVariantValue | ( | const vtkArrayCoordinates & | coordinates | ) | [pure virtual] |
Returns the value stored in the array at the given coordinates. Note that the number of dimensions in the supplied coordinates must match the number of dimensions in the array.
Implemented in vtkTypedArray< T >.
| virtual vtkVariant vtkArray::GetVariantValueN | ( | const SizeT | n | ) | [pure virtual] |
Returns the n-th value stored in the array, where n is in the range [0, GetNonNullSize()). This is useful for efficiently visiting every value in the array. Note that the order in which values are visited is undefined, but is guaranteed to match the order used by vtkArray::GetCoordinatesN().
| void vtkArray::SetVariantValue | ( | CoordinateT | i, | |
| const vtkVariant & | value | |||
| ) | [inline] |
Overwrites the value stored in the array at the given coordinates. Note that the number of dimensions in the supplied coordinates must match the number of dimensions in the array.
Definition at line 251 of file vtkArray.h.
| void vtkArray::SetVariantValue | ( | CoordinateT | i, | |
| CoordinateT | j, | |||
| const vtkVariant & | value | |||
| ) | [inline] |
Overwrites the value stored in the array at the given coordinates. Note that the number of dimensions in the supplied coordinates must match the number of dimensions in the array.
Definition at line 256 of file vtkArray.h.
| void vtkArray::SetVariantValue | ( | CoordinateT | i, | |
| CoordinateT | j, | |||
| CoordinateT | k, | |||
| const vtkVariant & | value | |||
| ) | [inline] |
Overwrites the value stored in the array at the given coordinates. Note that the number of dimensions in the supplied coordinates must match the number of dimensions in the array.
Definition at line 261 of file vtkArray.h.
| virtual void vtkArray::SetVariantValue | ( | const vtkArrayCoordinates & | coordinates, | |
| const vtkVariant & | value | |||
| ) | [pure virtual] |
Overwrites the value stored in the array at the given coordinates. Note that the number of dimensions in the supplied coordinates must match the number of dimensions in the array.
Implemented in vtkTypedArray< T >.
| virtual void vtkArray::SetVariantValueN | ( | const SizeT | n, | |
| const vtkVariant & | value | |||
| ) | [pure virtual] |
Overwrites the n-th value stored in the array, where n is in the range [0, GetNonNullSize()). This is useful for efficiently visiting every value in the array. Note that the order in which values are visited is undefined, but is guaranteed to match the order used by vtkArray::GetCoordinatesN().
| virtual void vtkArray::CopyValue | ( | vtkArray * | source, | |
| const vtkArrayCoordinates & | source_coordinates, | |||
| const vtkArrayCoordinates & | target_coordinates | |||
| ) | [pure virtual] |
Overwrites a value with a value retrieved from another array. Both arrays must store the same data types.
Implemented in vtkTypedArray< T >.
| virtual void vtkArray::CopyValue | ( | vtkArray * | source, | |
| const SizeT | source_index, | |||
| const vtkArrayCoordinates & | target_coordinates | |||
| ) | [pure virtual] |
Overwrites a value with a value retrieved from another array. Both arrays must store the same data types.
| virtual void vtkArray::CopyValue | ( | vtkArray * | source, | |
| const vtkArrayCoordinates & | source_coordinates, | |||
| const SizeT | target_index | |||
| ) | [pure virtual] |
Overwrites a value with a value retrieved from another array. Both arrays must store the same data types.
| virtual vtkArray* vtkArray::DeepCopy | ( | ) | [pure virtual] |
Returns a new array that is a deep copy of this array.
Implemented in vtkDenseArray< T >, and vtkSparseArray< T >.
The documentation for this class was generated from the following file:
- dox/Common/vtkArray.h
