Base interface for all typed vtkDataArray subclasses. More...
#include <vtkGenericDataArray.h>
Public Types | |
| typedef ValueTypeT | ValueType |
 Public Types inherited from vtkDataArray | |
| typedef vtkAbstractArray | Superclass |
| Public Types inherited from vtkAbstractArray | |
| enum | DeleteMethod { VTK_DATA_ARRAY_FREE, VTK_DATA_ARRAY_DELETE, VTK_DATA_ARRAY_ALIGNED_FREE, VTK_DATA_ARRAY_USER_DEFINED } |
| enum | { MAX_DISCRETE_VALUES = 32 } |
| enum | { AbstractArray = 0, DataArray, AoSDataArrayTemplate, SoADataArrayTemplate, TypedDataArray, MappedDataArray, DataArrayTemplate = AoSDataArrayTemplate } |
| typedef vtkObject | Superclass |
Public Member Functions | |
| vtkTemplateTypeMacro (SelfType, vtkDataArray) enum | |
| Compile time access to the VTK type identifier. More... | |
| ValueType | GetValue (vtkIdType valueIdx) const |
| Get the value at valueIdx. More... | |
| void | SetValue (vtkIdType valueIdx, ValueType value) |
| Set the value at valueIdx to value. More... | |
| void | GetTypedTuple (vtkIdType tupleIdx, ValueType *tuple) const |
| Copy the tuple at tupleIdx into tuple. More... | |
| void | SetTypedTuple (vtkIdType tupleIdx, const ValueType *tuple) |
| Set this array's tuple at tupleIdx to the values in tuple. More... | |
| ValueType | GetTypedComponent (vtkIdType tupleIdx, int compIdx) const |
| Get component compIdx of the tuple at tupleIdx. More... | |
| void | SetTypedComponent (vtkIdType tupleIdx, int compIdx, ValueType value) |
| Set component compIdx of the tuple at tupleIdx to value. More... | |
| void | RemoveTuple (vtkIdType tupleIdx) override |
| Removes a tuple at the given index. More... | |
| vtkIdType | InsertNextValue (ValueType value) |
| Insert data at the end of the array. More... | |
| void | InsertValue (vtkIdType valueIdx, ValueType value) |
| Insert data at a specified position in the array. More... | |
| void | InsertTypedTuple (vtkIdType tupleIdx, const ValueType *t) |
| Insert (memory allocation performed) the tuple t at tupleIdx. More... | |
| vtkIdType | InsertNextTypedTuple (const ValueType *t) |
| Insert (memory allocation performed) the tuple onto the end of the array. More... | |
| void | InsertTypedComponent (vtkIdType tupleIdx, int compIdx, ValueType val) |
| Insert (memory allocation performed) the value at the specified tuple and component location. More... | |
| ValueType * | GetValueRange () |
| Get the range of array values for the 0th component in the native data type. More... | |
| void | GetValueRange (ValueType range[2]) |
| vtkIdType | Capacity () |
| Return the capacity in typeof T units of the current array. More... | |
| virtual void | FillTypedComponent (int compIdx, ValueType value) |
| Set component comp of all tuples to value. More... | |
| virtual void | FillValue (ValueType value) |
| Set all the values in array to value. More... | |
| int | GetDataType () override |
| Return the underlying data type. More... | |
| int | GetDataTypeSize () override |
| Return the size of the underlying data type. More... | |
| bool | HasStandardMemoryLayout () override |
| Returns true if this array uses the standard memory layout defined in the VTK user guide, e.g. More... | |
| vtkTypeBool | Allocate (vtkIdType size, vtkIdType ext=1000) override |
| Allocate memory for this array. More... | |
| vtkTypeBool | Resize (vtkIdType numTuples) override |
| Resize the array to the requested number of tuples and preserve data. More... | |
| void | SetNumberOfComponents (int num) override |
| Set/Get the dimension (n) of the components. More... | |
| void | SetNumberOfTuples (vtkIdType number) override |
| Set the number of tuples (a component group) in the array. More... | |
| void | Initialize () override |
| Release storage and reset array to initial state. More... | |
| void | Squeeze () override |
| Free any unnecessary memory. More... | |
| void | SetTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override |
| Set the tuple at dstTupleIdx in this array to the tuple at srcTupleIdx in the source array. More... | |
| void | SetTuple (vtkIdType tupleIdx, const float *tuple) override |
| Set the data tuple at tupleIdx. More... | |
| void | SetTuple (vtkIdType tupleIdx, const double *tuple) override |
| Set the data tuple at tupleIdx. More... | |
| void | InsertTuples (vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source) override |
| Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in this array. More... | |
| void | InsertTuples (vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray *source) override |
| Copy n consecutive tuples starting at srcStart from the source array to this array, starting at the dstStart location. More... | |
| void | InsertTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override |
| Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx. More... | |
| void | InsertTuple (vtkIdType tupleIdx, const float *source) override |
| Insert the data tuple at tupleIdx. More... | |
| void | InsertTuple (vtkIdType tupleIdx, const double *source) override |
| Insert the data tuple at tupleIdx. More... | |
| void | InsertComponent (vtkIdType tupleIdx, int compIdx, double value) override |
| Insert value at the location specified by tupleIdx and compIdx. More... | |
| vtkIdType | InsertNextTuple (vtkIdType srcTupleIdx, vtkAbstractArray *source) override |
| Insert the tuple from srcTupleIdx in the source array at the end of this array. More... | |
| vtkIdType | InsertNextTuple (const float *tuple) override |
| Insert the data tuple at the end of the array and return the tuple index at which the data was inserted. More... | |
| vtkIdType | InsertNextTuple (const double *tuple) override |
| Insert the data tuple at the end of the array and return the tuple index at which the data was inserted. More... | |
| void | GetTuples (vtkIdList *tupleIds, vtkAbstractArray *output) override |
| Given a list of tuple ids, return an array of tuples. More... | |
| void | GetTuples (vtkIdType p1, vtkIdType p2, vtkAbstractArray *output) override |
| Get the tuples for the range of tuple ids specified (i.e., p1->p2 inclusive). More... | |
| double * | GetTuple (vtkIdType tupleIdx) override |
| Get the data tuple at tupleIdx. More... | |
| void | GetTuple (vtkIdType tupleIdx, double *tuple) override |
| Get the data tuple at tupleIdx by filling in a user-provided array, Make sure that your array is large enough to hold the NumberOfComponents amount of data being returned. More... | |
| 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 the source array and associated interpolation weights. More... | |
| 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, srcTupleIdx1 and srcTupleIdx2, and an interpolation factor, t. More... | |
| void | SetComponent (vtkIdType tupleIdx, int compIdx, double value) override |
| Set the data component at the location specified by tupleIdx and compIdx to value. More... | |
| double | GetComponent (vtkIdType tupleIdx, int compIdx) override |
| Return the data component at the location specified by tupleIdx and compIdx. More... | |
| void | SetVariantValue (vtkIdType valueIdx, vtkVariant value) override |
| Set a value in the array from a variant. More... | |
| vtkVariant | GetVariantValue (vtkIdType valueIdx) override |
| Retrieve value from the array as a variant. More... | |
| void | InsertVariantValue (vtkIdType valueIdx, vtkVariant value) override |
| Insert a value into the array from a variant. More... | |
| vtkIdType | LookupValue (vtkVariant value) override |
| Return the value indices where a specific value appears. More... | |
| virtual vtkIdType | LookupTypedValue (ValueType value) |
| void | LookupValue (vtkVariant value, vtkIdList *valueIds) override |
| Return the value indices where a specific value appears. More... | |
| virtual void | LookupTypedValue (ValueType value, vtkIdList *valueIds) |
| void | ClearLookup () override |
| Delete the associated fast lookup data structure on this array, if it exists. More... | |
| void | DataChanged () override |
| Tell the array explicitly that the data has changed. More... | |
| void | FillComponent (int compIdx, double value) override |
| Fill a component of a data array with a specified value. More... | |
| vtkArrayIterator * | NewIterator () override |
| Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate. More... | |
| void * | GetVoidPointer (vtkIdType valueIdx) override |
| Default implementation raises a runtime error. More... | |
| ValueType * | GetPointer (vtkIdType valueIdx) |
| Default implementation raises a runtime error. More... | |
| void | SetVoidArray (void *, vtkIdType, int) override |
| Default implementation raises a runtime error. More... | |
| void | SetVoidArray (void *, vtkIdType, int, int) override |
| Default implementation raises a runtime error. More... | |
| void | SetArrayFreeFunction (void(*callback)(void *)) override |
| Default implementation raises a runtime error. More... | |
| void * | WriteVoidPointer (vtkIdType valueIdx, vtkIdType numValues) override |
| Default implementation raises a runtime error. More... | |
| ValueType * | WritePointer (vtkIdType valueIdx, vtkIdType numValues) |
| Default implementation raises a runtime error. More... | |
| void | GetValueRange (ValueType range[2], int comp) |
| Get the range of array values for the given component in the native data type. More... | |
| ValueType * | GetValueRange (int comp) |
| Get the range of array values for the given component in the native data type. More... | |
| Public Member Functions inherited from vtkDataArray | |
| virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
| vtkDataArray * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| int | IsNumeric () override |
| This method is here to make backward compatibility easier. More... | |
| int | GetElementComponentSize () override |
| Return the size, in bytes, of the lowest-level element of an array. More... | |
| virtual void | GetData (vtkIdType tupleMin, vtkIdType tupleMax, int compMin, int compMax, vtkDoubleArray *data) |
| Get the data as a double array in the range (tupleMin,tupleMax) and (compMin, compMax). More... | |
| virtual void | ShallowCopy (vtkDataArray *other) |
| Create a shallow copy of other into this, if possible. More... | |
| virtual void | Fill (double value) |
| Fill all values of a data array with a specified value. More... | |
| virtual void | CopyComponent (int dstComponent, vtkDataArray *src, int srcComponent) |
| Copy a component from one data array into a component on this data array. More... | |
| unsigned long | GetActualMemorySize () override |
| Return the memory in kibibytes (1024 bytes) consumed by this data array. More... | |
| void | CreateDefaultLookupTable () |
| Create default lookup table. More... | |
| void | GetRange (double range[2], int comp) |
| The range of the data array values for the given component will be returned in the provided range array argument. More... | |
| double * | GetRange () |
| Return the range of the data array. More... | |
| void | GetRange (double range[2]) |
| The range of the data array values will be returned in the provided range array argument. More... | |
| 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 array argument. More... | |
| double * | GetFiniteRange () |
| Return the range of the data array. More... | |
| void | GetFiniteRange (double range[2]) |
| The range of the data array values will be returned in the provided range array argument. More... | |
| virtual double | GetMaxNorm () |
| Return the maximum norm for the tuples. More... | |
| void | Modified () override |
| Removes out-of-date L2_NORM_RANGE() and L2_NORM_FINITE_RANGE() values. More... | |
| int | CopyInformation (vtkInformation *infoFrom, int deep=1) override |
| Copy information instance. More... | |
| int | GetArrayType () override |
| Method for type-checking in FastDownCast implementations. More... | |
| double | GetTuple1 (vtkIdType tupleIdx) |
| These methods are included as convenience for the wrappers. More... | |
| double * | GetTuple2 (vtkIdType tupleIdx) |
| These methods are included as convenience for the wrappers. More... | |
| double * | GetTuple3 (vtkIdType tupleIdx) |
| These methods are included as convenience for the wrappers. More... | |
| double * | GetTuple4 (vtkIdType tupleIdx) |
| These methods are included as convenience for the wrappers. More... | |
| double * | GetTuple6 (vtkIdType tupleIdx) |
| These methods are included as convenience for the wrappers. More... | |
| double * | GetTuple9 (vtkIdType tupleIdx) |
| These methods are included as convenience for the wrappers. More... | |
| void | SetTuple1 (vtkIdType tupleIdx, double value) |
| These methods are included as convenience for the wrappers. More... | |
| void | SetTuple2 (vtkIdType tupleIdx, double val0, double val1) |
| These methods are included as convenience for the wrappers. More... | |
| void | SetTuple3 (vtkIdType tupleIdx, double val0, double val1, double val2) |
| These methods are included as convenience for the wrappers. More... | |
| void | SetTuple4 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3) |
| These methods are included as convenience for the wrappers. More... | |
| void | SetTuple6 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3, double val4, double val5) |
| These methods are included as convenience for the wrappers. More... | |
| void | SetTuple9 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3, double val4, double val5, double val6, double val7, double val8) |
| These methods are included as convenience for the wrappers. More... | |
| void | InsertTuple1 (vtkIdType tupleIdx, double value) |
| These methods are included as convenience for the wrappers. More... | |
| void | InsertTuple2 (vtkIdType tupleIdx, double val0, double val1) |
| These methods are included as convenience for the wrappers. More... | |
| void | InsertTuple3 (vtkIdType tupleIdx, double val0, double val1, double val2) |
| These methods are included as convenience for the wrappers. More... | |
| void | InsertTuple4 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3) |
| These methods are included as convenience for the wrappers. More... | |
| void | InsertTuple6 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3, double val4, double val5) |
| These methods are included as convenience for the wrappers. More... | |
| void | InsertTuple9 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3, double val4, double val5, double val6, double val7, double val8) |
| These methods are included as convenience for the wrappers. More... | |
| void | InsertNextTuple1 (double value) |
| These methods are included as convenience for the wrappers. More... | |
| void | InsertNextTuple2 (double val0, double val1) |
| These methods are included as convenience for the wrappers. More... | |
| void | InsertNextTuple3 (double val0, double val1, double val2) |
| These methods are included as convenience for the wrappers. More... | |
| void | InsertNextTuple4 (double val0, double val1, double val2, double val3) |
| These methods are included as convenience for the wrappers. More... | |
| void | InsertNextTuple6 (double val0, double val1, double val2, double val3, double val4, double val5) |
| These methods are included as convenience for the wrappers. More... | |
| void | InsertNextTuple9 (double val0, double val1, double val2, double val3, double val4, double val5, double val6, double val7, double val8) |
| These methods are included as convenience for the wrappers. More... | |
| virtual void | RemoveFirstTuple () |
| These methods remove tuples from the data array. More... | |
| virtual void | RemoveLastTuple () |
| These methods remove tuples from the data array. More... | |
| void | DeepCopy (vtkAbstractArray *aa) override |
| Deep copy of data. More... | |
| virtual void | DeepCopy (vtkDataArray *da) |
| Deep copy of data. More... | |
| void | SetLookupTable (vtkLookupTable *lut) |
| Set/get the lookup table associated with this scalar data, if any. More... | |
| virtual vtkLookupTable * | GetLookupTable () |
| Set/get the lookup table associated with this scalar data, if any. More... | |
| double * | GetRange (int comp) |
| Return the range of the data array values for the given component. More... | |
| double * | GetFiniteRange (int comp) |
| Return the range of the data array values for the given component. More... | |
| void | GetDataTypeRange (double range[2]) |
| These methods return the Min and Max possible range of the native data type. More... | |
| double | GetDataTypeMin () |
| These methods return the Min and Max possible range of the native data type. More... | |
| double | GetDataTypeMax () |
| These methods return the Min and Max possible range of the native data type. More... | |
| Public Member Functions inherited from vtkAbstractArray | |
| vtkAbstractArray * | NewInstance () const |
| void | SetComponentName (vtkIdType component, const char *name) |
| Set the name for a component. More... | |
| const char * | GetComponentName (vtkIdType component) |
| Get the component name for a given component. More... | |
| bool | HasAComponentName () |
| Returns if any component has had a name assigned. More... | |
| int | CopyComponentNames (vtkAbstractArray *da) |
| 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. More... | |
| virtual void | SetNumberOfValues (vtkIdType numValues) |
| Specify the number of values (tuples * components) for this object to hold. More... | |
| vtkIdType | GetNumberOfTuples () |
| Get the number of complete tuples (a component group) in the array. More... | |
| vtkIdType | GetNumberOfValues () const |
| Get the total number of values in the array. More... | |
| vtkIdType | GetSize () |
| Return the size of the data. More... | |
| vtkIdType | GetMaxId () |
| What is the maximum id currently in the array. More... | |
| virtual void | ExportToVoidPointer (void *out_ptr) |
| This method copies the array data to the void pointer specified by the user. More... | |
| virtual const char * | GetDataTypeAsString (void) |
| Get the name of a data type as a string. More... | |
| virtual vtkIdType | GetDataSize () |
| Returns the size of the data in DataTypeSize units. More... | |
| virtual void | GetProminentComponentValues (int comp, vtkVariantArray *values, double uncertainty=1.e-6, double minimumProminence=1.e-3) |
| 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). More... | |
| vtkInformation * | GetInformation () |
| Get an information object that can be used to annotate the array. More... | |
| bool | HasInformation () |
| Inquire if this array has an instance of vtkInformation already associated with it. More... | |
| int | GetNumberOfComponents () |
| Set/Get the dimension (n) of the components. More... | |
| void | Reset () |
| Reset to an empty state, without freeing any memory. More... | |
| virtual void | SetVoidArray (void *vtkNotUsed(array), vtkIdType vtkNotUsed(size), int vtkNotUsed(save))=0 |
| This method lets the user specify data to be held by the array. More... | |
| virtual void | SetVoidArray (void *array, vtkIdType size, int save, int vtkNotUsed(deleteMethod)) |
| This method lets the user specify data to be held by the array. More... | |
| virtual void | SetName (const char *) |
| Set/get array's name. More... | |
| virtual char * | GetName () |
| Set/get array's name. More... | |
| virtual unsigned int | GetMaxDiscreteValues () |
| Get/Set the maximum number of prominent values this array may contain before it is considered continuous. More... | |
| virtual void | SetMaxDiscreteValues (unsigned int) |
| Get/Set the maximum number of prominent values this array may contain before it is considered continuous. More... | |
| Public Member Functions inherited from vtkObject | |
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
| virtual void | DebugOn () |
| Turn debugging output on. More... | |
| virtual void | DebugOff () |
| Turn debugging output off. More... | |
| bool | GetDebug () |
| Get the value of the debug flag. More... | |
| void | SetDebug (bool debugFlag) |
| Set the value of the debug flag. More... | |
| virtual vtkMTimeType | GetMTime () |
| Return this object's modified time. More... | |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| void | RemoveObserver (unsigned long tag) |
| void | RemoveObservers (unsigned long event) |
| void | RemoveObservers (const char *event) |
| void | RemoveAllObservers () |
| vtkTypeBool | HasObserver (unsigned long event) |
| vtkTypeBool | HasObserver (const char *event) |
| int | InvokeEvent (unsigned long event) |
| int | InvokeEvent (const char *event) |
| unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
| int | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| int | InvokeEvent (const char *event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| Public Member Functions inherited from vtkObjectBase | |
| const char * | GetClassName () const |
| Return the class name as a string. More... | |
| virtual void | Delete () |
| Delete a VTK object. More... | |
| virtual void | FastDelete () |
| Delete a reference to this object. More... | |
| void | InitializeObjectBase () |
| void | Print (ostream &os) |
| Print an object to an ostream. More... | |
| virtual void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object). More... | |
| virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object). More... | |
| int | GetReferenceCount () |
| Return the current reference count of this object. More... | |
| void | SetReferenceCount (int) |
| Sets the reference count. More... | |
| void | PrintRevisions (ostream &) |
| Legacy. More... | |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
Protected Member Functions | |
| vtkGenericDataArray () | |
| ~vtkGenericDataArray () override | |
| bool | AllocateTuples (vtkIdType numTuples) |
| Allocate space for numTuples. More... | |
| bool | ReallocateTuples (vtkIdType numTuples) |
| Allocate space for numTuples. More... | |
| bool | EnsureAccessToTuple (vtkIdType tupleIdx) |
| Protected Member Functions inherited from vtkDataArray | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| virtual void | ComputeRange (double range[2], int comp) |
| Compute the range for a specific component. More... | |
| virtual void | ComputeFiniteRange (double range[2], int comp) |
| Compute the range for a specific component. More... | |
| virtual bool | ComputeScalarRange (double *ranges) |
| Computes the range for each component of an array, the length of ranges must be two times the number of components. More... | |
| virtual bool | ComputeVectorRange (double range[2]) |
| virtual bool | ComputeFiniteScalarRange (double *ranges) |
| Computes the range for each component of an array, the length of ranges must be two times the number of components. More... | |
| virtual bool | ComputeFiniteVectorRange (double range[2]) |
| vtkDataArray () | |
| ~vtkDataArray () override | |
| Protected Member Functions inherited from vtkAbstractArray | |
| vtkAbstractArray () | |
| ~vtkAbstractArray () override | |
| virtual void | SetInformation (vtkInformation *) |
| Set an information object that can be used to annotate the array. More... | |
| virtual void | UpdateDiscreteValueSet (double uncertainty, double minProminence) |
| Obtain the set of unique values taken on by each component of the array, as well as by the tuples of the array. More... | |
| Protected Member Functions inherited from vtkObject | |
| vtkObject () | |
| ~vtkObject () override | |
| void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| These methods allow a command to exclusively grab all events. More... | |
| void | InternalReleaseFocus () |
| These methods allow a command to exclusively grab all events. More... | |
| Protected Member Functions inherited from vtkObjectBase | |
| vtkObjectBase () | |
| virtual | ~vtkObjectBase () |
| virtual void | CollectRevisions (ostream &) |
| virtual void | ReportReferences (vtkGarbageCollector *) |
| vtkObjectBase (const vtkObjectBase &) | |
| void | operator= (const vtkObjectBase &) |
Protected Attributes | |
| std::vector< double > | LegacyTuple |
| std::vector< ValueType > | LegacyValueRange |
| vtkGenericDataArrayLookupHelper< SelfType > | Lookup |
| Protected Attributes inherited from vtkDataArray | |
| vtkLookupTable * | LookupTable |
| double | Range [2] |
| double | FiniteRange [2] |
| Protected Attributes inherited from vtkAbstractArray | |
| vtkIdType | Size |
| vtkIdType | MaxId |
| int | NumberOfComponents |
| unsigned int | MaxDiscreteValues |
| char * | Name |
| bool | RebuildArray |
| vtkInformation * | Information |
| vtkInternalComponentNames * | ComponentNames |
| Protected Attributes inherited from vtkObject | |
| bool | Debug |
| vtkTimeStamp | MTime |
| vtkSubjectHelper * | SubjectHelper |
| Protected Attributes inherited from vtkObjectBase | |
| vtkAtomicInt32 | ReferenceCount |
| vtkWeakPointerBase ** | WeakPointers |
Additional Inherited Members | |
| Static Public Member Functions inherited from vtkDataArray | |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkDataArray * | SafeDownCast (vtkObjectBase *o) |
| static vtkDataArray * | FastDownCast (vtkAbstractArray *source) |
| Perform a fast, safe cast from a vtkAbstractArray to a vtkDataArray. More... | |
| static vtkDataArray * | CreateDataArray (int dataType) |
| Creates an array for dataType where dataType is one of VTK_BIT, VTK_CHAR, VTK_SIGNED_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. More... | |
| static vtkInformationDoubleVectorKey * | COMPONENT_RANGE () |
| This key is used to hold tight bounds on the range of one component over all tuples of the array. More... | |
| static vtkInformationDoubleVectorKey * | L2_NORM_RANGE () |
| This key is used to hold tight bounds on the $L_2$ norm of tuples in the array. More... | |
| static vtkInformationDoubleVectorKey * | L2_NORM_FINITE_RANGE () |
| This key is used to hold tight bounds on the $L_2$ norm of tuples in the array. More... | |
| static vtkInformationStringKey * | UNITS_LABEL () |
| A human-readable string indicating the units for the array data. More... | |
| static void | GetDataTypeRange (int type, double range[2]) |
| These methods return the Min and Max possible range of the native data type. More... | |
| static double | GetDataTypeMin (int type) |
| These methods return the Min and Max possible range of the native data type. More... | |
| static double | GetDataTypeMax (int type) |
| These methods return the Min and Max possible range of the native data type. More... | |
| Static Public Member Functions inherited from vtkAbstractArray | |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkAbstractArray * | SafeDownCast (vtkObjectBase *o) |
| static vtkAbstractArray * | CreateArray (int dataType) |
| 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. More... | |
| static vtkInformationIntegerKey * | GUI_HIDE () |
| This key is a hint to end user interface that this array is internal and should not be shown to the end user. More... | |
| static vtkInformationInformationVectorKey * | PER_COMPONENT () |
| 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. More... | |
| static vtkInformationInformationVectorKey * | PER_FINITE_COMPONENT () |
| 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. More... | |
| static vtkInformationVariantVectorKey * | DISCRETE_VALUES () |
| 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). More... | |
| static vtkInformationDoubleVectorKey * | DISCRETE_VALUE_SAMPLE_PARAMETERS () |
| A key used to hold conditions under which cached discrete values were generated; the value is a 2-vector of doubles. More... | |
| static int | GetDataTypeSize (int type) |
| Return the size of the underlying data type. More... | |
| Static Public Member Functions inherited from vtkObject | |
| static vtkObject * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
| static void | BreakOnError () |
| This method is called when vtkErrorMacro executes. More... | |
| static void | SetGlobalWarningDisplay (int val) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOn () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOff () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static int | GetGlobalWarningDisplay () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| Static Public Member Functions inherited from vtkObjectBase | |
| static vtkTypeBool | IsTypeOf (const char *name) |
| Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
| static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Detailed Description
template<class DerivedT, class ValueTypeT>
class vtkGenericDataArray< DerivedT, ValueTypeT >
Base interface for all typed vtkDataArray subclasses.
A more detailed description of this class and related tools can be found here.
The vtkGenericDataArray class provides a generic implementation of the vtkDataArray API. It relies on subclasses providing access to data via 8 "concept methods", which should be implemented as non-virtual methods of the subclass. These methods are:
- ValueType GetValue(vtkIdType valueIdx) const
- [public] void SetValue(vtkIdType valueIdx, ValueType value)
- [public] void GetTypedTuple(vtkIdType tupleIdx, ValueType* tuple) const
- [public] void SetTypedTuple(vtkIdType tupleIdx, const ValueType* tuple)
- [public] ValueType GetTypedComponent(vtkIdType tupleIdx, int compIdx) const
- [public] void SetTypedComponent(vtkIdType tupleIdx, int compIdx, ValueType value)
- [protected] bool AllocateTuples(vtkIdType numTuples)
- [protected] bool ReallocateTuples(vtkIdType numTuples)
Note that these methods use the CRTP idiom, which provides static binding to avoid virtual calls. This allows the compiler to optimize away layers of indirection when these methods are used. Well-designed implementations of these methods will reduce to raw memory accesses, providing efficient performance comparable to working with the pointer data.
See vtkAOSDataArrayTemplate and vtkSOADataArrayTemplate for example implementations.
In practice, code should not be written to use vtkGenericDataArray objects. Doing so is rather unweildy due to the CRTP pattern requiring the derived class be provided as a template argument. Instead, the vtkArrayDispatch framework can be used to detect a vtkDataArray's implementation type and instantiate appropriate templated worker code.
vtkArrayDispatch is also intended to replace code that currently relies on the encapsulation-breaking GetVoidPointer method. Not all subclasses of vtkDataArray use the memory layout assumed by GetVoidPointer; calling this method on, e.g. a vtkSOADataArrayTemplate will trigger a deep copy of the array data into an AOS buffer. This is very inefficient and should be avoided.
- See also
- vtkArrayDispatcher vtkDataArrayAccessor
Definition at line 80 of file vtkGenericDataArray.h.
Member Typedef Documentation
| typedef ValueTypeT vtkGenericDataArray< DerivedT, ValueTypeT >::ValueType |
Definition at line 84 of file vtkGenericDataArray.h.
Constructor & Destructor Documentation
|
protected |
|
overrideprotected |
Member Function Documentation
|
inline |
Compile time access to the VTK type identifier.
Definition at line 85 of file vtkGenericDataArray.h.
|
overridevirtual |
Default implementation raises a runtime error.
If subclasses keep on supporting this API, they should override this method.
Implements vtkAbstractArray.
| ValueType* vtkGenericDataArray< DerivedT, ValueTypeT >::GetPointer | ( | vtkIdType | valueIdx | ) |
Default implementation raises a runtime error.
If subclasses keep on supporting this API, they should override this method.
|
override |
Default implementation raises a runtime error.
If subclasses keep on supporting this API, they should override this method.
|
override |
Default implementation raises a runtime error.
If subclasses keep on supporting this API, they should override this method.
|
overridevirtual |
Default implementation raises a runtime error.
If subclasses keep on supporting this API, they should override this method.
Implements vtkAbstractArray.
|
overridevirtual |
Default implementation raises a runtime error.
If subclasses keep on supporting this API, they should override this method.
Implements vtkDataArray.
| ValueType* vtkGenericDataArray< DerivedT, ValueTypeT >::WritePointer | ( | vtkIdType | valueIdx, |
| vtkIdType | numValues | ||
| ) |
Default implementation raises a runtime error.
If subclasses keep on supporting this API, they should override this method.
|
overridevirtual |
Removes a tuple at the given index.
Default implementation iterates over tuples to move elements. Subclasses are encouraged to reimplemented this method to support faster implementations, if needed.
Implements vtkDataArray.
| vtkIdType vtkGenericDataArray< DerivedT, ValueTypeT >::InsertNextValue | ( | ValueType | value | ) |
Insert data at the end of the array.
Return its location in the array.
| void vtkGenericDataArray< DerivedT, ValueTypeT >::InsertValue | ( | vtkIdType | valueIdx, |
| ValueType | value | ||
| ) |
Insert data at a specified position in the array.
| void vtkGenericDataArray< DerivedT, ValueTypeT >::InsertTypedTuple | ( | vtkIdType | tupleIdx, |
| const ValueType * | t | ||
| ) |
Insert (memory allocation performed) the tuple t at tupleIdx.
| vtkIdType vtkGenericDataArray< DerivedT, ValueTypeT >::InsertNextTypedTuple | ( | const ValueType * | t | ) |
Insert (memory allocation performed) the tuple onto the end of the array.
| void vtkGenericDataArray< DerivedT, ValueTypeT >::InsertTypedComponent | ( | vtkIdType | tupleIdx, |
| int | compIdx, | ||
| ValueType | val | ||
| ) |
Insert (memory allocation performed) the value at the specified tuple and component location.
| void vtkGenericDataArray< DerivedT, ValueTypeT >::GetValueRange | ( | ValueType | range[2], |
| int | comp | ||
| ) |
Get the range of array values for the given component in the native data type.
| ValueType* vtkGenericDataArray< DerivedT, ValueTypeT >::GetValueRange | ( | int | comp | ) |
Get the range of array values for the given component in the native data type.
|
inline |
Get the range of array values for the 0th component in the native data type.
Definition at line 236 of file vtkGenericDataArray.h.
|
inline |
Definition at line 237 of file vtkGenericDataArray.h.
|
inline |
Return the capacity in typeof T units of the current array.
TODO Leftover from vtkDataArrayTemplate, redundant with GetSize. Deprecate?
Definition at line 243 of file vtkGenericDataArray.h.
|
virtual |
Set component comp of all tuples to value.
Reimplemented in vtkAOSDataArrayTemplate< ValueTypeT >, vtkAOSDataArrayTemplate< long >, vtkAOSDataArrayTemplate< Scalar >, vtkAOSDataArrayTemplate< unsigned long >, vtkAOSDataArrayTemplate< double >, vtkAOSDataArrayTemplate< vtkIdType >, vtkAOSDataArrayTemplate< unsigned long long >, vtkAOSDataArrayTemplate< float >, vtkAOSDataArrayTemplate< int >, vtkAOSDataArrayTemplate< unsigned int >, vtkAOSDataArrayTemplate< signed char >, vtkAOSDataArrayTemplate< unsigned short >, vtkAOSDataArrayTemplate< short >, vtkAOSDataArrayTemplate< long long >, vtkAOSDataArrayTemplate< unsigned char >, vtkAOSDataArrayTemplate< ValueType >, vtkAOSDataArrayTemplate< char >, and vtkSOADataArrayTemplate< ValueTypeT >.
|
virtual |
Set all the values in array to value.
Reimplemented in vtkAOSDataArrayTemplate< ValueTypeT >, vtkAOSDataArrayTemplate< long >, vtkAOSDataArrayTemplate< Scalar >, vtkAOSDataArrayTemplate< unsigned long >, vtkAOSDataArrayTemplate< double >, vtkAOSDataArrayTemplate< vtkIdType >, vtkAOSDataArrayTemplate< unsigned long long >, vtkAOSDataArrayTemplate< float >, vtkAOSDataArrayTemplate< int >, vtkAOSDataArrayTemplate< unsigned int >, vtkAOSDataArrayTemplate< signed char >, vtkAOSDataArrayTemplate< unsigned short >, vtkAOSDataArrayTemplate< short >, vtkAOSDataArrayTemplate< long long >, vtkAOSDataArrayTemplate< unsigned char >, vtkAOSDataArrayTemplate< ValueType >, and vtkAOSDataArrayTemplate< char >.
|
overridevirtual |
Return the underlying data type.
An integer indicating data type is returned as specified in vtkType.h.
Implements vtkAbstractArray.
|
overridevirtual |
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.
Implements vtkAbstractArray.
|
overridevirtual |
Returns true if this array uses the standard memory layout defined in the VTK user guide, e.g.
a contiguous array: {t1c1, t1c2, t1c3, ... t1cM, t2c1, ... tNcM} where t1c2 is the second component of the first tuple.
Reimplemented from vtkAbstractArray.
|
overridevirtual |
Allocate memory for this array.
Delete old storage only if necessary. Note that ext is no longer used. This method will reset MaxId to -1 and resize the array capacity such that this->Size >= numValues. If numValues is 0, all memory will be freed. Return 1 on success, 0 on failure.
Implements vtkAbstractArray.
|
overridevirtual |
Resize the array to the requested number of tuples and preserve data.
Increasing the array size may allocate extra memory beyond what was requested. MaxId will not be modified when increasing array size. Decreasing the array size will trim memory to the requested size and may update MaxId if the valid id range is truncated. Requesting an array size of 0 will free all memory. Returns 1 if resizing succeeded and 0 otherwise.
Implements vtkAbstractArray.
|
overridevirtual |
Set/Get the dimension (n) of the components.
Must be >= 1. Make sure that this is set before allocation.
Reimplemented from vtkAbstractArray.
|
overridevirtual |
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).
Implements vtkAbstractArray.
|
overridevirtual |
Release storage and reset array to initial state.
Implements vtkAbstractArray.
|
overridevirtual |
Free any unnecessary memory.
Description: Resize object to just fit data requirement. Reclaims extra memory.
Implements vtkAbstractArray.
|
overridevirtual |
Set the tuple at dstTupleIdx in this array to the tuple at srcTupleIdx 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.
Reimplemented from vtkDataArray.
|
inlineoverridevirtual |
Set the data tuple at tupleIdx.
Note that range checking or memory allocation is not performed; use this method in conjunction with SetNumberOfTuples() to allocate space.
Reimplemented from vtkDataArray.
Definition at line 268 of file vtkGenericDataArray.h.
|
inlineoverridevirtual |
Set the data tuple at tupleIdx.
Note that range checking or memory allocation is not performed; use this method in conjunction with SetNumberOfTuples() to allocate space.
Reimplemented from vtkDataArray.
Definition at line 270 of file vtkGenericDataArray.h.
|
overridevirtual |
Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in this array.
Note that memory allocation is performed as necessary to hold the data.
Reimplemented from vtkDataArray.
|
inlineoverridevirtual |
Copy n consecutive tuples starting at srcStart from the source array to this array, starting at the dstStart location.
Note that memory allocation is performed as necessary to hold the data.
Reimplemented from vtkDataArray.
Definition at line 277 of file vtkGenericDataArray.h.
|
overridevirtual |
Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx.
Note that memory allocation is performed as necessary to hold the data.
Reimplemented from vtkDataArray.
|
overridevirtual |
Insert the data tuple at tupleIdx.
Note that memory allocation is performed as necessary to hold the data.
Implements vtkDataArray.
|
overridevirtual |
Insert the data tuple at tupleIdx.
Note that memory allocation is performed as necessary to hold the data.
Implements vtkDataArray.
|
overridevirtual |
Insert value at the location specified by tupleIdx and compIdx.
Note that memory allocation is performed as necessary to hold the data.
Reimplemented from vtkDataArray.
|
overridevirtual |
Insert the tuple from srcTupleIdx in the source array at the end of this array.
Note that memory allocation is performed as necessary to hold the data. Returns the tuple index at which the data was inserted.
Reimplemented from vtkDataArray.
|
overridevirtual |
Insert the data tuple at the end of the array and return the tuple index at which the data was inserted.
Memory is allocated as necessary to hold the data.
Implements vtkDataArray.
|
overridevirtual |
Insert the data tuple at the end of the array and return the tuple index at which the data was inserted.
Memory is allocated as necessary to hold the data.
Implements vtkDataArray.
|
overridevirtual |
Given a list of tuple 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 from vtkDataArray.
|
overridevirtual |
Get the tuples for the range of tuple 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 from vtkDataArray.
|
overridevirtual |
Get the data tuple at tupleIdx.
Return it as a pointer to an array. Note: this method is not thread-safe, and the pointer is only valid as long as another method invocation to a vtk object is not performed.
Implements vtkDataArray.
|
overridevirtual |
Get the data tuple at tupleIdx by filling in a user-provided array, Make sure that your array is large enough to hold the NumberOfComponents amount of data being returned.
Implements vtkDataArray.
|
overridevirtual |
Set the tuple at dstTupleIdx in this array to 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 structure.
Reimplemented from vtkDataArray.
|
overridevirtual |
Insert the tuple at dstTupleIdx in this array to the tuple interpolated from the two tuple indices, srcTupleIdx1 and srcTupleIdx2, and an interpolation factor, t.
The interpolation factor ranges from (0,1), with t=0 located at the tuple described by srcTupleIdx1. This method assumes that the three arrays are of the same type, srcTupleIdx1 is an index to array source1, and srcTupleIdx2 is an index to array source2.
Reimplemented from vtkDataArray.
|
overridevirtual |
Set the data component at the location specified by tupleIdx and compIdx to value.
Note that i is less than NumberOfTuples and j is less than NumberOfComponents. Make sure enough memory has been allocated (use SetNumberOfTuples() and SetNumberOfComponents()).
Reimplemented from vtkDataArray.
|
overridevirtual |
Return the data component at the location specified by tupleIdx and compIdx.
Reimplemented from vtkDataArray.
|
overridevirtual |
Set a value in the array from a variant.
This method does NOT do bounds checking.
Implements vtkAbstractArray.
|
overridevirtual |
Retrieve value from the array as a variant.
Reimplemented from vtkAbstractArray.
|
overridevirtual |
Insert a value into the array from a variant.
This method does bounds checking.
Implements vtkAbstractArray.
|
overridevirtual |
Return the value indices where a specific value appears.
Implements vtkAbstractArray.
|
virtual |
|
overridevirtual |
Return the value indices where a specific value appears.
Implements vtkAbstractArray.
|
virtual |
|
overridevirtual |
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.
Implements vtkAbstractArray.
|
overridevirtual |
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.
Implements vtkAbstractArray.
|
overridevirtual |
Fill a component of a data array with a specified value.
This method sets the specified component to specified value for all tuples in the data array. This methods can be used to initialize or reinitialize a single component of a multi-component array.
Reimplemented from vtkDataArray.
|
overridevirtual |
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate.
Implements vtkAbstractArray.
|
protected |
Member Data Documentation
|
protected |
Definition at line 345 of file vtkGenericDataArray.h.
|
protected |
Definition at line 346 of file vtkGenericDataArray.h.
|
protected |
Definition at line 348 of file vtkGenericDataArray.h.
The documentation for this class was generated from the following file:
- /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Common/Core/vtkGenericDataArray.h
