Abstract superclass for all arrays. More...
#include <vtkAbstractArray.h>
Detailed Description
Abstract superclass for all arrays.
vtkAbstractArray is an abstract superclass for data array objects. This class defines an API that all subclasses must support. The data type must be assignable and copy-constructible, but no other assumptions about its type are made. Most of the subclasses of this array deal with numeric data either as scalars or tuples of scalars. A program can use the IsNumeric() method to check whether an instance of vtkAbstractArray contains numbers. It is also possible to test for this by attempting to SafeDownCast an array to an instance of vtkDataArray, although this assumes that all numeric arrays will always be descended from vtkDataArray.
Every array has a character-string name. The naming of the array occurs automatically when it is instantiated, but you are free to change this name using the SetName() method. (The array name is used for data manipulation.)
- See also:
- vtkDataArray vtkStringArray vtkCellArray
- Tests:
- vtkAbstractArray (Tests)
Definition at line 64 of file vtkAbstractArray.h.
Member Typedef Documentation
Reimplemented from vtkObject.
Reimplemented in vtkDataArray, vtkVariantArray, vtkDoubleArray, vtkFloatArray, vtkIdTypeArray, vtkIntArray, vtkStringArray, vtkUnsignedCharArray, vtkUnicodeStringArray, vtkCharArray, vtkLongArray, vtkShortArray, vtkSignedCharArray, vtkUnsignedIntArray, vtkUnsignedLongArray, vtkUnsignedShortArray, vtk__Int64Array, vtkLongLongArray, vtkUnsigned__Int64Array, vtkUnsignedLongLongArray, vtkBitArray, and vtkDataArrayTemplate< T >.
Definition at line 67 of file vtkAbstractArray.h.
Member Enumeration Documentation
| anonymous enum |
Definition at line 412 of file vtkAbstractArray.h.
Constructor & Destructor Documentation
| vtkAbstractArray::vtkAbstractArray | ( | vtkIdType | numComp = 1 | ) | [protected] |
| vtkAbstractArray::~vtkAbstractArray | ( | ) | [protected] |
Member Function Documentation
| static int vtkAbstractArray::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 vtkDataArray, vtkVariantArray, vtkDoubleArray, vtkFloatArray, vtkIdTypeArray, vtkIntArray, vtkStringArray, vtkUnsignedCharArray, vtkUnicodeStringArray, vtkCharArray, vtkLongArray, vtkShortArray, vtkSignedCharArray, vtkUnsignedIntArray, vtkUnsignedLongArray, vtkUnsignedShortArray, vtk__Int64Array, vtkLongLongArray, vtkUnsigned__Int64Array, vtkUnsignedLongLongArray, and vtkBitArray.
| virtual int vtkAbstractArray::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 vtkDataArray, vtkVariantArray, vtkDoubleArray, vtkFloatArray, vtkIdTypeArray, vtkIntArray, vtkStringArray, vtkUnsignedCharArray, vtkUnicodeStringArray, vtkCharArray, vtkLongArray, vtkShortArray, vtkSignedCharArray, vtkUnsignedIntArray, vtkUnsignedLongArray, vtkUnsignedShortArray, vtk__Int64Array, vtkLongLongArray, vtkUnsigned__Int64Array, vtkUnsignedLongLongArray, and vtkBitArray.
| static vtkAbstractArray* vtkAbstractArray::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkObject.
Reimplemented in vtkDataArray, vtkVariantArray, vtkDoubleArray, vtkFloatArray, vtkIdTypeArray, vtkIntArray, vtkStringArray, vtkUnsignedCharArray, vtkUnicodeStringArray, vtkCharArray, vtkLongArray, vtkShortArray, vtkSignedCharArray, vtkUnsignedIntArray, vtkUnsignedLongArray, vtkUnsignedShortArray, vtk__Int64Array, vtkLongLongArray, vtkUnsigned__Int64Array, vtkUnsignedLongLongArray, and vtkBitArray.
| virtual vtkObjectBase* vtkAbstractArray::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkObject.
Reimplemented in vtkDataArray, vtkVariantArray, vtkDoubleArray, vtkFloatArray, vtkIdTypeArray, vtkIntArray, vtkStringArray, vtkUnsignedCharArray, vtkUnicodeStringArray, vtkCharArray, vtkLongArray, vtkShortArray, vtkSignedCharArray, vtkUnsignedIntArray, vtkUnsignedLongArray, vtkUnsignedShortArray, vtk__Int64Array, vtkLongLongArray, vtkUnsigned__Int64Array, vtkUnsignedLongLongArray, and vtkBitArray.
| vtkAbstractArray* vtkAbstractArray::NewInstance | ( | ) | const |
Reimplemented from vtkObject.
Reimplemented in vtkDataArray, vtkVariantArray, vtkDoubleArray, vtkFloatArray, vtkIdTypeArray, vtkIntArray, vtkStringArray, vtkUnsignedCharArray, vtkUnicodeStringArray, vtkCharArray, vtkLongArray, vtkShortArray, vtkSignedCharArray, vtkUnsignedIntArray, vtkUnsignedLongArray, vtkUnsignedShortArray, vtk__Int64Array, vtkLongLongArray, vtkUnsigned__Int64Array, vtkUnsignedLongLongArray, and vtkBitArray.
| void vtkAbstractArray::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 vtkDataArray, vtkVariantArray, vtkDoubleArray, vtkFloatArray, vtkIdTypeArray, vtkIntArray, vtkStringArray, vtkUnsignedCharArray, vtkUnicodeStringArray, vtkCharArray, vtkLongArray, vtkShortArray, vtkSignedCharArray, vtkUnsignedIntArray, vtkUnsignedLongArray, vtkUnsignedShortArray, vtk__Int64Array, vtkLongLongArray, vtkUnsigned__Int64Array, vtkUnsignedLongLongArray, vtkBitArray, and vtkDataArrayTemplate< T >.
| virtual int vtkAbstractArray::Allocate | ( | vtkIdType | sz, |
| vtkIdType | ext = 1000 |
||
| ) | [pure virtual] |
Allocate memory for this array. Delete old storage only if necessary. Note that ext is no longer used.
Implemented in vtkStringArray, vtkVariantArray, vtkUnicodeStringArray, vtkBitArray, and vtkDataArrayTemplate< T >.
| virtual void vtkAbstractArray::Initialize | ( | ) | [pure virtual] |
Release storage and reset array to initial state.
Implemented in vtkVariantArray, vtkStringArray, vtkUnicodeStringArray, vtkBitArray, and vtkDataArrayTemplate< T >.
| virtual int vtkAbstractArray::GetDataType | ( | ) | [pure virtual] |
Return the underlying data type. An integer indicating data type is returned as specified in vtkSetGet.h.
Implemented in vtkVariantArray, vtkStringArray, vtkDoubleArray, vtkFloatArray, vtkIdTypeArray, vtkIntArray, vtkUnsignedCharArray, vtkCharArray, vtkLongArray, vtkShortArray, vtkSignedCharArray, vtkUnicodeStringArray, vtkUnsignedIntArray, vtkUnsignedLongArray, vtkUnsignedShortArray, vtkBitArray, vtk__Int64Array, vtkLongLongArray, vtkUnsigned__Int64Array, and vtkUnsignedLongLongArray.
| virtual int vtkAbstractArray::GetDataTypeSize | ( | ) | [pure virtual] |
Return the size of the underlying data type. For a bit, 0 is returned. For string 0 is returned. Arrays with variable length components return 0.
Implemented in vtkVariantArray, vtkStringArray, vtkUnicodeStringArray, vtkBitArray, and vtkDataArrayTemplate< T >.
| static int vtkAbstractArray::GetDataTypeSize | ( | int | type | ) | [static] |
Return the size of the underlying data type. For a bit, 0 is returned. For string 0 is returned. Arrays with variable length components return 0.
| virtual int vtkAbstractArray::GetElementComponentSize | ( | ) | [pure virtual] |
Return the size, in bytes, of the lowest-level element of an array. For vtkDataArray and subclasses this is the size of the data type. For vtkStringArray, this is sizeof(vtkStdString::value_type), which winds up being sizeof(char).
Implemented in vtkStringArray, vtkVariantArray, vtkDataArray, and vtkUnicodeStringArray.
| virtual void vtkAbstractArray::SetNumberOfComponents | ( | int | ) | [virtual] |
Set/Get the dimension (n) of the components. Must be >= 1. Make sure that this is set before allocation.
| int vtkAbstractArray::GetNumberOfComponents | ( | ) | [inline] |
Set/Get the dimension (n) of the components. Must be >= 1. Make sure that this is set before allocation.
Definition at line 99 of file vtkAbstractArray.h.
| void vtkAbstractArray::SetComponentName | ( | vtkIdType | component, |
| const char * | name | ||
| ) |
Set the name for a component. Must be >= 1.
| const char* vtkAbstractArray::GetComponentName | ( | vtkIdType | component | ) |
Get the component name for a given component. Note: will return the actual string that is stored
| bool vtkAbstractArray::HasAComponentName | ( | ) |
Returns if any component has had a name assigned
Copies the component names from the inputed array to the current array make sure that the current array has the same number of components as the input array
| virtual void vtkAbstractArray::SetNumberOfTuples | ( | vtkIdType | number | ) | [pure virtual] |
Set the number of tuples (a component group) in the array. Note that this may allocate space depending on the number of components. Also note that if allocation is performed no copy is performed so existing data will be lost (if data conservation is sought, one may use the Resize method instead).
Implemented in vtkStringArray, vtkVariantArray, vtkBitArray, vtkUnicodeStringArray, and vtkDataArrayTemplate< T >.
| vtkIdType vtkAbstractArray::GetNumberOfTuples | ( | ) | [inline] |
Get the number of tuples (a component group) in the array.
Definition at line 126 of file vtkAbstractArray.h.
| virtual void vtkAbstractArray::SetTuple | ( | vtkIdType | i, |
| vtkIdType | j, | ||
| vtkAbstractArray * | source | ||
| ) | [pure virtual] |
Set the tuple at the ith location using the jth tuple in the source array. This method assumes that the two arrays have the same type and structure. Note that range checking and memory allocation is not performed; use in conjunction with SetNumberOfTuples() to allocate space.
Implemented in vtkVariantArray, vtkStringArray, vtkDataArray, vtkBitArray, vtkDataArrayTemplate< T >, and vtkUnicodeStringArray.
| virtual void vtkAbstractArray::InsertTuple | ( | vtkIdType | i, |
| vtkIdType | j, | ||
| vtkAbstractArray * | source | ||
| ) | [pure virtual] |
Insert the jth tuple in the source array, at ith location in this array. Note that memory allocation is performed as necessary to hold the data.
Implemented in vtkVariantArray, vtkStringArray, vtkDataArray, vtkBitArray, vtkDataArrayTemplate< T >, and vtkUnicodeStringArray.
| virtual vtkIdType vtkAbstractArray::InsertNextTuple | ( | vtkIdType | j, |
| vtkAbstractArray * | source | ||
| ) | [pure virtual] |
Insert the jth tuple in the source array, at the end in this array. Note that memory allocation is performed as necessary to hold the data. Returns the location at which the data was inserted.
Implemented in vtkVariantArray, vtkStringArray, vtkDataArray, vtkBitArray, vtkDataArrayTemplate< T >, and vtkUnicodeStringArray.
| virtual void vtkAbstractArray::GetTuples | ( | vtkIdList * | ptIds, |
| vtkAbstractArray * | output | ||
| ) | [virtual] |
Given a list of point ids, return an array of tuples. You must insure that the output array has been previously allocated with enough space to hold the data.
Reimplemented in vtkStringArray, and vtkDataArray.
| virtual void vtkAbstractArray::GetTuples | ( | vtkIdType | p1, |
| vtkIdType | p2, | ||
| vtkAbstractArray * | output | ||
| ) | [virtual] |
Get the tuples for the range of points ids specified (i.e., p1->p2 inclusive). You must insure that the output array has been previously allocated with enough space to hold the data.
Reimplemented in vtkStringArray, and vtkDataArray.
| virtual void* vtkAbstractArray::GetVoidPointer | ( | vtkIdType | id | ) | [pure virtual] |
Return a void pointer. For image pipeline interface and other special pointer manipulation.
Implemented in vtkStringArray, vtkDataArrayTemplate< T >, vtkBitArray, vtkVariantArray, and vtkUnicodeStringArray.
| virtual void vtkAbstractArray::DeepCopy | ( | vtkAbstractArray * | da | ) | [virtual] |
Deep copy of data. Implementation left to subclasses, which should support as many type conversions as possible given the data type. Subclasses should call vtkAbstractArray::DeepCopy() so that the information object (if one exists) is copied from da.
Reimplemented in vtkDataArray, vtkStringArray, vtkDataArrayTemplate< T >, vtkBitArray, vtkVariantArray, and vtkUnicodeStringArray.
| virtual void vtkAbstractArray::InterpolateTuple | ( | vtkIdType | i, |
| vtkIdList * | ptIndices, | ||
| vtkAbstractArray * | source, | ||
| double * | weights | ||
| ) | [pure virtual] |
Set the ith tuple in this array as the interpolated tuple value, given the ptIndices in the source array and associated interpolation weights. This method assumes that the two arrays are of the same type and strcuture.
Implemented in vtkVariantArray, vtkDataArray, vtkStringArray, and vtkUnicodeStringArray.
| virtual void vtkAbstractArray::InterpolateTuple | ( | vtkIdType | i, |
| vtkIdType | id1, | ||
| vtkAbstractArray * | source1, | ||
| vtkIdType | id2, | ||
| vtkAbstractArray * | source2, | ||
| double | t | ||
| ) | [pure virtual] |
Insert the ith tuple in this array as interpolated from the two values, p1 and p2, and an interpolation factor, t. The interpolation factor ranges from (0,1), with t=0 located at p1. This method assumes that the three arrays are of the same type. p1 is value at index id1 in source1, while, p2 is value at index id2 in source2.
Implemented in vtkVariantArray, vtkDataArray, vtkStringArray, and vtkUnicodeStringArray.
| virtual void vtkAbstractArray::Squeeze | ( | ) | [pure virtual] |
Free any unnecessary memory. Description: Resize object to just fit data requirement. Reclaims extra memory.
Implemented in vtkVariantArray, vtkDataArrayTemplate< T >, vtkBitArray, vtkStringArray, and vtkUnicodeStringArray.
| virtual int vtkAbstractArray::Resize | ( | vtkIdType | numTuples | ) | [pure virtual] |
Resize the array while conserving the data. Returns 1 if resizing succeeded and 0 otherwise.
Implemented in vtkVariantArray, vtkDataArrayTemplate< T >, vtkBitArray, vtkStringArray, and vtkUnicodeStringArray.
| void vtkAbstractArray::Reset | ( | ) | [inline] |
Reset to an empty state, without freeing any memory.
Definition at line 197 of file vtkAbstractArray.h.
| vtkIdType vtkAbstractArray::GetSize | ( | ) | [inline] |
Return the size of the data.
Definition at line 203 of file vtkAbstractArray.h.
| vtkIdType vtkAbstractArray::GetMaxId | ( | ) | [inline] |
What is the maximum id currently in the array.
Definition at line 209 of file vtkAbstractArray.h.
| virtual void vtkAbstractArray::SetVoidArray | ( | void * | vtkNotUsedarray, |
| vtkIdType | vtkNotUsedsize, | ||
| int | vtkNotUsedsave | ||
| ) | [pure virtual] |
This method lets the user specify data to be held by the array. The array argument is a pointer to the data. size is the size of the array supplied by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The class uses the actual array provided; it does not copy the data from the supplied array.
| virtual void vtkAbstractArray::ExportToVoidPointer | ( | void * | vtkNotUsedout_ptr | ) | [inline, virtual] |
This method copies the array data to the void pointer specified by the user. It is up to the user to allocate enough memory for the void pointer.
Definition at line 228 of file vtkAbstractArray.h.
| virtual unsigned long vtkAbstractArray::GetActualMemorySize | ( | ) | [pure virtual] |
Return the memory in kilobytes consumed by this data array. Used to support streaming and reading/writing data. The value returned is guaranteed to be greater than or equal to the memory required to actually represent the data represented by this object. The information returned is valid only after the pipeline has been updated.
Implemented in vtkDataArray, vtkStringArray, vtkVariantArray, and vtkUnicodeStringArray.
| virtual void vtkAbstractArray::SetName | ( | const char * | ) | [virtual] |
Set/get array's name
| virtual char* vtkAbstractArray::GetName | ( | ) | [virtual] |
Set/get array's name
| virtual const char* vtkAbstractArray::GetDataTypeAsString | ( | void | ) | [inline, virtual] |
Get the name of a data type as a string.
Definition at line 246 of file vtkAbstractArray.h.
| static vtkAbstractArray* vtkAbstractArray::CreateArray | ( | int | dataType | ) | [static] |
Creates an array for dataType where dataType is one of VTK_BIT, VTK_CHAR, VTK_UNSIGNED_CHAR, VTK_SHORT, VTK_UNSIGNED_SHORT, VTK_INT, VTK_UNSIGNED_INT, VTK_LONG, VTK_UNSIGNED_LONG, VTK_DOUBLE, VTK_DOUBLE, VTK_ID_TYPE, VTK_STRING. Note that the data array returned has to be deleted by the user.
| virtual int vtkAbstractArray::IsNumeric | ( | ) | [pure virtual] |
This method is here to make backward compatibility easier. It must return true if and only if an array contains numeric data.
Implemented in vtkVariantArray, vtkUnicodeStringArray, vtkDataArray, and vtkStringArray.
| virtual vtkArrayIterator* vtkAbstractArray::NewIterator | ( | ) | [pure virtual] |
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate.
Implemented in vtkDataArrayTemplate< T >, vtkStringArray, vtkBitArray, vtkVariantArray, and vtkUnicodeStringArray.
| virtual vtkIdType vtkAbstractArray::GetDataSize | ( | ) | [inline, virtual] |
Returns the size of the data in DataTypeSize units. Thus, the number of bytes for the data can be computed by GetDataSize() * GetDataTypeSize(). Non-contiguous or variable- size arrays need to override this method.
Reimplemented in vtkStringArray.
Definition at line 270 of file vtkAbstractArray.h.
| virtual vtkIdType vtkAbstractArray::LookupValue | ( | vtkVariant | value | ) | [pure virtual] |
Return the indices where a specific value appears.
Implemented in vtkDataArrayTemplate< T >, vtkStringArray, vtkVariantArray, vtkBitArray, and vtkUnicodeStringArray.
| virtual void vtkAbstractArray::LookupValue | ( | vtkVariant | value, |
| vtkIdList * | ids | ||
| ) | [pure virtual] |
Return the indices where a specific value appears.
Implemented in vtkDataArrayTemplate< T >, vtkStringArray, vtkVariantArray, vtkBitArray, and vtkUnicodeStringArray.
| virtual vtkVariant vtkAbstractArray::GetVariantValue | ( | vtkIdType | idx | ) | [virtual] |
Retrieve value from the array as a variant.
Reimplemented in vtkUnicodeStringArray.
| virtual void vtkAbstractArray::InsertVariantValue | ( | vtkIdType | idx, |
| vtkVariant | value | ||
| ) | [virtual] |
Insert a value into the array from a variant. This method does bounds checking.
| virtual void vtkAbstractArray::SetVariantValue | ( | vtkIdType | idx, |
| vtkVariant | value | ||
| ) | [pure virtual] |
Set a value in the array from a variant. This method does NOT do bounds checking.
Implemented in vtkVariantArray, vtkStringArray, vtkDataArrayTemplate< T >, vtkBitArray, and vtkUnicodeStringArray.
| virtual void vtkAbstractArray::DataChanged | ( | ) | [pure virtual] |
Tell the array explicitly that the data has changed. This is only necessary to call when you modify the array contents without using the array's API (i.e. you retrieve a pointer to the data and modify the array contents). You need to call this so that the fast lookup will know to rebuild itself. Otherwise, the lookup functions will give incorrect results.
Implemented in vtkStringArray, vtkDataArrayTemplate< T >, vtkVariantArray, vtkBitArray, and vtkUnicodeStringArray.
| virtual void vtkAbstractArray::ClearLookup | ( | ) | [pure virtual] |
Delete the associated fast lookup data structure on this array, if it exists. The lookup will be rebuilt on the next call to a lookup function.
Implemented in vtkStringArray, vtkDataArrayTemplate< T >, vtkVariantArray, vtkBitArray, and vtkUnicodeStringArray.
| virtual void vtkAbstractArray::GetProminentComponentValues | ( | int | comp, |
| vtkVariantArray * | values, | ||
| double | uncertainty = 1.e-6, |
||
| double | minimumProminence = 1.e-3 |
||
| ) | [virtual] |
Populate the given vtkVariantArray with a set of distinct values taken on by the requested component (or, when passed -1, by the tuples as a whole). If the set of prominent values has more than 32 entries, then the array is assumed to be continuous in nature and no values are returned. This method takes 2 parameters: uncertainty and minimumProminence. Note that this set of returned values may not be complete if uncertainty and minimumProminence are both larger than 0.0; in order to perform interactively, a subsample of the array is used to determine the set of values. The first parameter (uncertainty, U) is the maximum acceptable probability that a prominent value will not be detected. Setting this to 0 will cause every value in the array to be examined. The second parameter (minimumProminence, P) specifies the smallest relative frequency (in [0,1]) with which a value in the array may occur and still be considered prominent. Setting this to 0 will force every value in the array to be traversed. Using numbers close to 0 for this parameter quickly causes the number of samples required to obtain the given uncertainty to subsume the entire array, as rare occurrences require frequent sampling to detect. For an array with T tuples and given uncertainty U and mininumum prominence P, we sample N values, with N = f(T; P, U). We want f to be sublinear in T in order to interactively handle large arrays; in practice, we can make f independent of T: 
, but note that small values of P are costly to achieve. The default parameters will locate prominent values that occur at least 1 out of every 1000 samples with a confidence of 0.999999 (= 1 - 1e6). Thanks to Seshadri Comandur (Sandia National Laboratories) for the bounds on the number of samples. The first time this is called, the array is examined and unique values are stored in the vtkInformation object associated with the array. The list of unique values will be updated on subsequent calls only if the array's MTime is newer than the associated vtkInformation object or if better sampling (lower uncertainty or minimumProminence) is requested. The DISCRETE_VALUE_SAMPLE_PARAMETERS() information key is used to store the numbers which produced any current set of prominent values. Also, note that every value encountered is reported and counts toward the maximum of 32 distinct values, regardless of the value's frequency. This is required for an efficient implementation. Use the vtkOrderStatistics filter if you wish to threshold the set of distinct values to eliminate "unprominent" (infrequently-occurring) values.
Get an information object that can be used to annotate the array. This will always return an instance of vtkInformation, if one is not currently associated with the array it will be created.
| bool vtkAbstractArray::HasInformation | ( | ) | [inline] |
Inquire if this array has an instance of vtkInformation already associated with it.
Definition at line 365 of file vtkAbstractArray.h.
| virtual int vtkAbstractArray::CopyInformation | ( | vtkInformation * | infoFrom, |
| int | deep = 1 |
||
| ) | [virtual] |
Copy information instance. Arrays use information objects in a variety of ways. It is important to have flexibility in this regard because certain keys should not be coppied, while others must be. NOTE: Subclasses must always call their superclass's CopyInformation method, so that all classes in the hierarchy get a chance to remove keys they do not wish to be coppied. The subclass will not need to explicilty copy the keys as it's handled here.
Reimplemented in vtkDataArray.
| static vtkInformationIntegerKey* vtkAbstractArray::GUI_HIDE | ( | ) | [static] |
This key is a hint to end user interface that this array is internal and should not be shown to the end user.
| static vtkInformationInformationVectorKey* vtkAbstractArray::PER_COMPONENT | ( | ) | [static] |
This key is used to hold a vector of COMPONENT_VALUES (and, for vtkDataArray subclasses, COMPONENT_RANGE) keys -- one for each component of the array. You may add additional per-component key-value pairs to information objects in this vector. However if you do so, you must be sure to either (1) set COMPONENT_VALUES to an invalid variant and set COMPONENT_RANGE to {VTK_DOUBLE_MAX, VTK_DOUBLE_MIN} or (2) call ComputeUniqueValues(component) and ComputeRange(component) before modifying the information object. Otherwise it is possible for modifications to the array to take place without the bounds on the component being updated since the modification time of the vtkInformation object is used to determine when the COMPONENT_RANGE values are out of date.
| static vtkInformationVariantVectorKey* vtkAbstractArray::DISCRETE_VALUES | ( | ) | [static] |
A key used to hold discrete values taken on either by the tuples of the array (when present in this->GetInformation()) or individual components (when present in one entry of the PER_COMPONENT() information vector).
| static vtkInformationDoubleVectorKey* vtkAbstractArray::DISCRETE_VALUE_SAMPLE_PARAMETERS | ( | ) | [static] |
A key used to hold conditions under which cached discrete values were generated; the value is a 2-vector of doubles. The first entry corresponds to the maximum uncertainty that prominent values exist but have not been detected. The second entry corresponds to the smallest relative frequency a value is allowed to have and still appear on the list.
| virtual void vtkAbstractArray::SetInformation | ( | vtkInformation * | ) | [protected, virtual] |
Set an information object that can be used to annotate the array. Use this with caution as array instances depend on persistence of information keys. See CopyInformation.
| virtual void vtkAbstractArray::UpdateDiscreteValueSet | ( | double | uncertainty, |
| double | minProminence | ||
| ) | [protected, virtual] |
Obtain the set of unique values taken on by each component of the array, as well as by the tuples of the array. The results are stored in the PER_COMPONENT() vtkInformation objects using the DISCRETE_VALUES() key. If the key is present but stores 0 values, the array either has no entries or does not behave as a discrete set. If the key is not present, the array has not been examined for distinct values or has been modified since the last examination.
Member Data Documentation
vtkIdType vtkAbstractArray::Size [protected] |
Definition at line 435 of file vtkAbstractArray.h.
vtkIdType vtkAbstractArray::MaxId [protected] |
Definition at line 436 of file vtkAbstractArray.h.
int vtkAbstractArray::NumberOfComponents [protected] |
Definition at line 437 of file vtkAbstractArray.h.
char* vtkAbstractArray::Name [protected] |
Definition at line 439 of file vtkAbstractArray.h.
bool vtkAbstractArray::RebuildArray [protected] |
Definition at line 441 of file vtkAbstractArray.h.
vtkInformation* vtkAbstractArray::Information [protected] |
Definition at line 443 of file vtkAbstractArray.h.
vtkInternalComponentNames* vtkAbstractArray::ComponentNames [protected] |
Definition at line 446 of file vtkAbstractArray.h.
The documentation for this class was generated from the following file:
- dox/Common/Core/vtkAbstractArray.h
