VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkDataArray Class Referenceabstract

abstract superclass for arrays of numeric data More...

#include <vtkDataArray.h>

Inheritance diagram for vtkDataArray:
[legend]
Collaboration diagram for vtkDataArray:
[legend]

Public Types

typedef vtkAbstractArray Superclass
 
- Public Types inherited from vtkAbstractArray
enum  { MAX_DISCRETE_VALUES = 32 }
 
enum  {
  AbstractArray = 0, DataArray, TypedDataArray, DataArrayTemplate,
  MappedDataArray
}
 
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkDataArrayNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetTuple (vtkIdType i, vtkIdType j, vtkAbstractArray *source)=0
 
virtual void InsertTuple (vtkIdType i, vtkIdType j, vtkAbstractArray *source)=0
 
virtual vtkIdType InsertNextTuple (vtkIdType j, vtkAbstractArray *source)=0
 
virtual void GetTuples (vtkIdList *ptIds, vtkAbstractArray *output)
 
virtual void GetTuples (vtkIdType p1, vtkIdType p2, vtkAbstractArray *output)
 
virtual doubleGetTuple (vtkIdType i)=0
 
virtual void GetTuple (vtkIdType i, double *tuple)=0
 
virtual double GetComponent (vtkIdType i, int j)
 
virtual void SetComponent (vtkIdType i, int j, double c)
 
virtual void InsertComponent (vtkIdType i, int j, double c)
 
virtual void FillComponent (int j, double c)
 
virtual void * WriteVoidPointer (vtkIdType id, vtkIdType number)=0
 
virtual unsigned long GetActualMemorySize ()
 
void CreateDefaultLookupTable ()
 
virtual double GetMaxNorm ()
 
virtual int CopyInformation (vtkInformation *infoFrom, int deep=1)
 
virtual int GetArrayType ()
 
virtual int IsNumeric ()
 
virtual int GetElementComponentSize ()
 
virtual void InterpolateTuple (vtkIdType i, vtkIdList *ptIndices, vtkAbstractArray *source, double *weights)
 
virtual void InterpolateTuple (vtkIdType i, vtkIdType id1, vtkAbstractArray *source1, vtkIdType id2, vtkAbstractArray *source2, double t)
 
double GetTuple1 (vtkIdType i)
 
doubleGetTuple2 (vtkIdType i)
 
doubleGetTuple3 (vtkIdType i)
 
doubleGetTuple4 (vtkIdType i)
 
doubleGetTuple6 (vtkIdType i)
 
doubleGetTuple9 (vtkIdType i)
 
virtual void SetTuple (vtkIdType i, const float *tuple)=0
 
virtual void SetTuple (vtkIdType i, const double *tuple)=0
 
void SetTuple1 (vtkIdType i, double value)
 
void SetTuple2 (vtkIdType i, double val0, double val1)
 
void SetTuple3 (vtkIdType i, double val0, double val1, double val2)
 
void SetTuple4 (vtkIdType i, double val0, double val1, double val2, double val3)
 
void SetTuple6 (vtkIdType i, double val0, double val1, double val2, double val3, double val4, double val5)
 
void SetTuple9 (vtkIdType i, double val0, double val1, double val2, double val3, double val4, double val5, double val6, double val7, double val8)
 
virtual void InsertTuple (vtkIdType i, const float *tuple)=0
 
virtual void InsertTuple (vtkIdType i, const double *tuple)=0
 
void InsertTuple1 (vtkIdType i, double value)
 
void InsertTuple2 (vtkIdType i, double val0, double val1)
 
void InsertTuple3 (vtkIdType i, double val0, double val1, double val2)
 
void InsertTuple4 (vtkIdType i, double val0, double val1, double val2, double val3)
 
void InsertTuple9 (vtkIdType i, double val0, double val1, double val2, double val3, double val4, double val5, double val6, double val7, double val8)
 
virtual vtkIdType InsertNextTuple (const float *tuple)=0
 
virtual vtkIdType InsertNextTuple (const double *tuple)=0
 
void InsertNextTuple1 (double value)
 
void InsertNextTuple2 (double val0, double val1)
 
void InsertNextTuple3 (double val0, double val1, double val2)
 
void InsertNextTuple4 (double val0, double val1, double val2, double val3)
 
void InsertNextTuple9 (double val0, double val1, double val2, double val3, double val4, double val5, double val6, double val7, double val8)
 
virtual void RemoveTuple (vtkIdType id)=0
 
virtual void RemoveFirstTuple ()=0
 
virtual void RemoveLastTuple ()=0
 
virtual void GetData (vtkIdType tupleMin, vtkIdType tupleMax, int compMin, int compMax, vtkDoubleArray *data)
 
virtual void DeepCopy (vtkAbstractArray *aa)
 
virtual void DeepCopy (vtkDataArray *da)
 
virtual void CopyComponent (int j, vtkDataArray *from, int fromComponent)
 
void SetLookupTable (vtkLookupTable *lut)
 
virtual vtkLookupTableGetLookupTable ()
 
void GetRange (double range[2], int comp)
 
doubleGetRange (int comp)
 
doubleGetRange ()
 
void GetRange (double range[2])
 
- Public Member Functions inherited from vtkAbstractArray
vtkAbstractArrayNewInstance () const
 
virtual int Allocate (vtkIdType sz, vtkIdType ext=1000)=0
 
virtual void Initialize ()=0
 
virtual int GetDataType ()=0
 
void SetComponentName (vtkIdType component, const char *name)
 
const char * GetComponentName (vtkIdType component)
 
bool HasAComponentName ()
 
int CopyComponentNames (vtkAbstractArray *da)
 
virtual void SetNumberOfTuples (vtkIdType number)=0
 
virtual bool HasStandardMemoryLayout ()
 
virtual void * GetVoidPointer (vtkIdType id)=0
 
virtual void Squeeze ()=0
 
virtual int Resize (vtkIdType numTuples)=0
 
virtual void ExportToVoidPointer (void *vtkNotUsed(out_ptr))
 
virtual vtkArrayIteratorNewIterator ()=0
 
virtual vtkVariant GetVariantValue (vtkIdType idx)
 
virtual void InsertVariantValue (vtkIdType idx, vtkVariant value)
 
virtual void SetVariantValue (vtkIdType idx, vtkVariant value)=0
 
virtual void DataChanged ()=0
 
virtual void ClearLookup ()=0
 
vtkInformationGetInformation ()
 
virtual void SetNumberOfComponents (int)
 
int GetNumberOfComponents ()
 
vtkIdType GetNumberOfTuples ()
 
virtual void InsertTuples (vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source)=0
 
virtual void InsertTuples (vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray *source)=0
 
void Reset ()
 
vtkIdType GetSize ()
 
vtkIdType GetMaxId ()
 
virtual void SetVoidArray (void *vtkNotUsed(array), vtkIdType vtkNotUsed(size), int vtkNotUsed(save))=0
 
virtual void SetName (const char *)
 
virtual char * GetName ()
 
virtual const char * GetDataTypeAsString (void)
 
virtual vtkIdType GetDataSize ()
 
virtual vtkIdType LookupValue (vtkVariant value)=0
 
virtual void LookupValue (vtkVariant value, vtkIdList *ids)=0
 
virtual void GetProminentComponentValues (int comp, vtkVariantArray *values, double uncertainty=1.e-6, double minimumProminence=1.e-3)
 
bool HasInformation ()
 
virtual unsigned int GetMaxDiscreteValues ()
 
virtual void SetMaxDiscreteValues (unsigned int)
 
virtual int GetDataTypeSize ()=0
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkDataArraySafeDownCast (vtkObjectBase *o)
 
static vtkDataArrayFastDownCast (vtkAbstractArray *source)
 
static vtkDataArrayCreateDataArray (int dataType)
 
static vtkInformationDoubleVectorKeyCOMPONENT_RANGE ()
 
static vtkInformationDoubleVectorKeyL2_NORM_RANGE ()
 
- Static Public Member Functions inherited from vtkAbstractArray
static int IsTypeOf (const char *type)
 
static vtkAbstractArraySafeDownCast (vtkObjectBase *o)
 
static vtkAbstractArrayCreateArray (int dataType)
 
static vtkInformationIntegerKeyGUI_HIDE ()
 
static vtkInformationInformationVectorKeyPER_COMPONENT ()
 
static vtkInformationVariantVectorKeyDISCRETE_VALUES ()
 
static vtkInformationDoubleVectorKeyDISCRETE_VALUE_SAMPLE_PARAMETERS ()
 
static int GetDataTypeSize (int type)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
virtual void ComputeRange (double range[2], int comp)
 
virtual bool ComputeScalarRange (double *ranges)
 
virtual bool ComputeVectorRange (double range[2])
 
 vtkDataArray ()
 
 ~vtkDataArray ()
 
- Protected Member Functions inherited from vtkAbstractArray
 vtkAbstractArray ()
 
 ~vtkAbstractArray ()
 
virtual void SetInformation (vtkInformation *)
 
virtual void UpdateDiscreteValueSet (double uncertainty, double minProminence)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- 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

vtkLookupTableLookupTable
 
double Range [2]
 
- Protected Attributes inherited from vtkAbstractArray
vtkIdType Size
 
vtkIdType MaxId
 
int NumberOfComponents
 
unsigned int MaxDiscreteValues
 
char * Name
 
bool RebuildArray
 
vtkInformationInformation
 
vtkInternalComponentNames * ComponentNames
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkPoints
 
static void GetDataTypeRange (int type, double range[2])
 
static double GetDataTypeMin (int type)
 
static double GetDataTypeMax (int type)
 
void GetDataTypeRange (double range[2])
 
double GetDataTypeMin ()
 
double GetDataTypeMax ()
 

Detailed Description

abstract superclass for arrays of numeric data

vtkDataArray is an abstract superclass for data array objects containing numeric data. It extends the API defined in vtkAbstractArray. vtkDataArray is an abstract superclass for data array objects. This class defines an API that all array objects must support. Note that the concrete subclasses of this class represent data in native form (char, int, etc.) and often have specialized more efficient methods for operating on this data (for example, getting pointers to data or getting/inserting data in native form). Subclasses of vtkDataArray are assumed to contain data whose components are meaningful when cast to and from double.

See also
vtkBitArray vtkCharArray vtkUnsignedCharArray vtkShortArray vtkUnsignedShortArray vtkIntArray vtkUnsignedIntArray vtkLongArray vtkUnsignedLongArray vtkDoubleArray vtkDoubleArray
Examples:
vtkDataArray (Examples)
Tests:
vtkDataArray (Tests)

Definition at line 54 of file vtkDataArray.h.

Member Typedef Documentation

Definition at line 57 of file vtkDataArray.h.

Constructor & Destructor Documentation

vtkDataArray::vtkDataArray ( )
protected
vtkDataArray::~vtkDataArray ( )
protected

Member Function Documentation

static int vtkDataArray::IsTypeOf ( const char *  type)
static
virtual int vtkDataArray::IsA ( const char *  name)
virtual
static vtkDataArray* vtkDataArray::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkDataArray::NewInstanceInternal ( ) const
protectedvirtual
vtkDataArray* vtkDataArray::NewInstance ( ) const
void vtkDataArray::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual
vtkDataArray * vtkDataArray::FastDownCast ( vtkAbstractArray source)
inlinestatic

Perform a fast, safe cast from a vtkAbstractArray to a vtkDataArray. This method checks if source->GetArrayType() returns DataArrayFastCast or a more derived type, and performs a static_cast to return source as a vtkDataArray pointer. Otherwise, NULL is returned.

Definition at line 441 of file vtkDataArray.h.

virtual int vtkDataArray::IsNumeric ( )
inlinevirtual

This method is here to make backward compatibility easier. It must return true if and only if an array contains numeric data. All vtkDataArray subclasses contain numeric data, hence this method always returns 1(true).

Implements vtkAbstractArray.

Definition at line 72 of file vtkDataArray.h.

virtual int vtkDataArray::GetElementComponentSize ( )
inlinevirtual

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.

Implements vtkAbstractArray.

Definition at line 79 of file vtkDataArray.h.

virtual void vtkDataArray::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.

Implements vtkAbstractArray.

Implemented in vtkPeriodicDataArray< Scalar >, vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, and vtkBitArray.

virtual void vtkDataArray::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. This pure virtual function is redeclared here to avoid declaration hidden warnings.

Implements vtkAbstractArray.

Implemented in vtkPeriodicDataArray< Scalar >, vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, and vtkBitArray.

virtual vtkIdType vtkDataArray::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. This pure virtual function is redeclared here to avoid declaration hidden warnings.

Implements vtkAbstractArray.

Implemented in vtkPeriodicDataArray< Scalar >, vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkBitArray, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

virtual void vtkDataArray::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 from vtkAbstractArray.

Reimplemented in vtkMappedDataArray< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, and vtkPeriodicDataArray< Scalar >.

virtual void vtkDataArray::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 from vtkAbstractArray.

Reimplemented in vtkMappedDataArray< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, and vtkPeriodicDataArray< Scalar >.

virtual void vtkDataArray::InterpolateTuple ( vtkIdType  i,
vtkIdList ptIndices,
vtkAbstractArray source,
double weights 
)
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.

Implements vtkAbstractArray.

Reimplemented in vtkPeriodicDataArray< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, and vtkMappedDataArray< Scalar >.

virtual void vtkDataArray::InterpolateTuple ( vtkIdType  i,
vtkIdType  id1,
vtkAbstractArray source1,
vtkIdType  id2,
vtkAbstractArray source2,
double  t 
)
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.

Implements vtkAbstractArray.

Reimplemented in vtkPeriodicDataArray< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, and vtkMappedDataArray< Scalar >.

virtual double* vtkDataArray::GetTuple ( vtkIdType  i)
pure virtual

Get the data tuple at ith location. 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.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkBitArray, vtkPeriodicDataArray< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

virtual void vtkDataArray::GetTuple ( vtkIdType  i,
double tuple 
)
pure virtual

Get the data tuple at ith location by filling in a user-provided array, Make sure that your array is large enough to hold the NumberOfComponents amount of data being returned.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkBitArray, vtkPeriodicDataArray< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

double vtkDataArray::GetTuple1 ( vtkIdType  i)

These methods are included as convenience for the wrappers. GetTuple() and SetTuple() which return/take arrays can not be used from wrapped languages. These methods can be used instead.

double* vtkDataArray::GetTuple2 ( vtkIdType  i)

These methods are included as convenience for the wrappers. GetTuple() and SetTuple() which return/take arrays can not be used from wrapped languages. These methods can be used instead.

double* vtkDataArray::GetTuple3 ( vtkIdType  i)

These methods are included as convenience for the wrappers. GetTuple() and SetTuple() which return/take arrays can not be used from wrapped languages. These methods can be used instead.

double* vtkDataArray::GetTuple4 ( vtkIdType  i)

These methods are included as convenience for the wrappers. GetTuple() and SetTuple() which return/take arrays can not be used from wrapped languages. These methods can be used instead.

double* vtkDataArray::GetTuple6 ( vtkIdType  i)

These methods are included as convenience for the wrappers. GetTuple() and SetTuple() which return/take arrays can not be used from wrapped languages. These methods can be used instead.

double* vtkDataArray::GetTuple9 ( vtkIdType  i)

These methods are included as convenience for the wrappers. GetTuple() and SetTuple() which return/take arrays can not be used from wrapped languages. These methods can be used instead.

virtual void vtkDataArray::SetTuple ( vtkIdType  i,
const float tuple 
)
pure virtual

Set the data tuple at ith location. Note that range checking or memory allocation is not performed; use this method in conjunction with SetNumberOfTuples() to allocate space.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkPeriodicDataArray< Scalar >, vtkBitArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

virtual void vtkDataArray::SetTuple ( vtkIdType  i,
const double tuple 
)
pure virtual

Set the data tuple at ith location. Note that range checking or memory allocation is not performed; use this method in conjunction with SetNumberOfTuples() to allocate space.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkPeriodicDataArray< Scalar >, vtkBitArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

void vtkDataArray::SetTuple1 ( vtkIdType  i,
double  value 
)

These methods are included as convenience for the wrappers. GetTuple() and SetTuple() which return/take arrays can not be used from wrapped languages. These methods can be used instead.

void vtkDataArray::SetTuple2 ( vtkIdType  i,
double  val0,
double  val1 
)

These methods are included as convenience for the wrappers. GetTuple() and SetTuple() which return/take arrays can not be used from wrapped languages. These methods can be used instead.

void vtkDataArray::SetTuple3 ( vtkIdType  i,
double  val0,
double  val1,
double  val2 
)

These methods are included as convenience for the wrappers. GetTuple() and SetTuple() which return/take arrays can not be used from wrapped languages. These methods can be used instead.

void vtkDataArray::SetTuple4 ( vtkIdType  i,
double  val0,
double  val1,
double  val2,
double  val3 
)

These methods are included as convenience for the wrappers. GetTuple() and SetTuple() which return/take arrays can not be used from wrapped languages. These methods can be used instead.

void vtkDataArray::SetTuple6 ( vtkIdType  i,
double  val0,
double  val1,
double  val2,
double  val3,
double  val4,
double  val5 
)

These methods are included as convenience for the wrappers. GetTuple() and SetTuple() which return/take arrays can not be used from wrapped languages. These methods can be used instead.

void vtkDataArray::SetTuple9 ( vtkIdType  i,
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. GetTuple() and SetTuple() which return/take arrays can not be used from wrapped languages. These methods can be used instead.

virtual void vtkDataArray::InsertTuple ( vtkIdType  i,
const float tuple 
)
pure virtual

Insert the data tuple at ith location. Note that memory allocation is performed as necessary to hold the data.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkPeriodicDataArray< Scalar >, vtkBitArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

virtual void vtkDataArray::InsertTuple ( vtkIdType  i,
const double tuple 
)
pure virtual

Insert the data tuple at ith location. Note that memory allocation is performed as necessary to hold the data.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkPeriodicDataArray< Scalar >, vtkBitArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

void vtkDataArray::InsertTuple1 ( vtkIdType  i,
double  value 
)

These methods are included as convenience for the wrappers. InsertTuple() which takes arrays can not be used from wrapped languages. These methods can be used instead.

void vtkDataArray::InsertTuple2 ( vtkIdType  i,
double  val0,
double  val1 
)

These methods are included as convenience for the wrappers. InsertTuple() which takes arrays can not be used from wrapped languages. These methods can be used instead.

void vtkDataArray::InsertTuple3 ( vtkIdType  i,
double  val0,
double  val1,
double  val2 
)

These methods are included as convenience for the wrappers. InsertTuple() which takes arrays can not be used from wrapped languages. These methods can be used instead.

void vtkDataArray::InsertTuple4 ( vtkIdType  i,
double  val0,
double  val1,
double  val2,
double  val3 
)

These methods are included as convenience for the wrappers. InsertTuple() which takes arrays can not be used from wrapped languages. These methods can be used instead.

void vtkDataArray::InsertTuple9 ( vtkIdType  i,
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. InsertTuple() which takes arrays can not be used from wrapped languages. These methods can be used instead.

virtual vtkIdType vtkDataArray::InsertNextTuple ( const float tuple)
pure virtual

Insert the data tuple at the end of the array and return the location at which the data was inserted. Memory is allocated as necessary to hold the data.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkPeriodicDataArray< Scalar >, vtkBitArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

virtual vtkIdType vtkDataArray::InsertNextTuple ( const double tuple)
pure virtual

Insert the data tuple at the end of the array and return the location at which the data was inserted. Memory is allocated as necessary to hold the data.

Implemented in vtkPeriodicDataArray< Scalar >, vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkBitArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

void vtkDataArray::InsertNextTuple1 ( double  value)

These methods are included as convenience for the wrappers. InsertTuple() which takes arrays can not be used from wrapped languages. These methods can be used instead.

void vtkDataArray::InsertNextTuple2 ( double  val0,
double  val1 
)

These methods are included as convenience for the wrappers. InsertTuple() which takes arrays can not be used from wrapped languages. These methods can be used instead.

void vtkDataArray::InsertNextTuple3 ( double  val0,
double  val1,
double  val2 
)

These methods are included as convenience for the wrappers. InsertTuple() which takes arrays can not be used from wrapped languages. These methods can be used instead.

void vtkDataArray::InsertNextTuple4 ( double  val0,
double  val1,
double  val2,
double  val3 
)

These methods are included as convenience for the wrappers. InsertTuple() which takes arrays can not be used from wrapped languages. These methods can be used instead.

void vtkDataArray::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. InsertTuple() which takes arrays can not be used from wrapped languages. These methods can be used instead.

virtual void vtkDataArray::RemoveTuple ( vtkIdType  id)
pure virtual

These methods remove tuples from the data array. They shift data and resize array, so the data array is still valid after this operation. Note, this operation is fairly slow.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkPeriodicDataArray< Scalar >, vtkBitArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

virtual void vtkDataArray::RemoveFirstTuple ( )
pure virtual

These methods remove tuples from the data array. They shift data and resize array, so the data array is still valid after this operation. Note, this operation is fairly slow.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkPeriodicDataArray< Scalar >, vtkBitArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

virtual void vtkDataArray::RemoveLastTuple ( )
pure virtual

These methods remove tuples from the data array. They shift data and resize array, so the data array is still valid after this operation. Note, this operation is fairly slow.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkPeriodicDataArray< Scalar >, vtkBitArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

virtual double vtkDataArray::GetComponent ( vtkIdType  i,
int  j 
)
virtual

Return the data component at the ith tuple and jth component location. Note that i is less than NumberOfTuples and j is less than NumberOfComponents.

Reimplemented in vtkDataArrayTemplate< T >, and vtkDataArrayTemplate< Scalar >.

virtual void vtkDataArray::SetComponent ( vtkIdType  i,
int  j,
double  c 
)
virtual

Set the data component at the ith tuple and jth component location. 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 in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, and vtkBitArray.

virtual void vtkDataArray::InsertComponent ( vtkIdType  i,
int  j,
double  c 
)
virtual

Insert the data component at ith tuple and jth component location. Note that memory allocation is performed as necessary to hold the data.

Reimplemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, and vtkBitArray.

virtual void vtkDataArray::GetData ( vtkIdType  tupleMin,
vtkIdType  tupleMax,
int  compMin,
int  compMax,
vtkDoubleArray data 
)
virtual

Get the data as a double array in the range (tupleMin,tupleMax) and (compMin, compMax). The resulting double array consists of all data in the tuple range specified and only the component range specified. This process typically requires casting the data from native form into doubleing point values. This method is provided as a convenience for data exchange, and is not very fast.

virtual void vtkDataArray::DeepCopy ( vtkAbstractArray aa)
virtual

Deep copy of data. Copies data from different data arrays even if they are different types (using doubleing-point exchange).

Reimplemented from vtkAbstractArray.

Reimplemented in vtkBitArray, vtkPeriodicDataArray< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, and vtkMappedDataArray< Scalar >.

virtual void vtkDataArray::DeepCopy ( vtkDataArray da)
virtual

Deep copy of data. Copies data from different data arrays even if they are different types (using doubleing-point exchange).

Reimplemented in vtkBitArray, vtkPeriodicDataArray< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, and vtkMappedDataArray< Scalar >.

virtual void vtkDataArray::FillComponent ( int  j,
double  c 
)
virtual

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.

virtual void vtkDataArray::CopyComponent ( int  j,
vtkDataArray from,
int  fromComponent 
)
virtual

Copy a component from one data array into a component on this data array. This method copies the specified component ("fromComponent") from the specified data array ("from") to the specified component ("j") over all the tuples in this data array. This method can be used to extract a component (column) from one data array and paste that data into a component on this data array.

virtual void* vtkDataArray::WriteVoidPointer ( vtkIdType  id,
vtkIdType  number 
)
pure virtual

Get the address of a particular data index. Make sure data is allocated for the number of items requested. Set MaxId according to the number of data values requested.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkBitArray, and vtkMappedDataArray< Scalar >.

virtual unsigned long vtkDataArray::GetActualMemorySize ( )
virtual

Return the memory in kibibytes (1024 bytes) 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.

Implements vtkAbstractArray.

Reimplemented in vtkPeriodicDataArray< Scalar >.

void vtkDataArray::CreateDefaultLookupTable ( )

Create default lookup table. Generally used to create one when none is available.

void vtkDataArray::SetLookupTable ( vtkLookupTable lut)

Set/get the lookup table associated with this scalar data, if any.

virtual vtkLookupTable* vtkDataArray::GetLookupTable ( )
virtual

Set/get the lookup table associated with this scalar data, if any.

void vtkDataArray::GetRange ( double  range[2],
int  comp 
)
inline

The range of the data array values for the given component will be returned in the provided range array argument. If comp is -1, the range of the magnitude (L2 norm) over all components will be provided. The range is computed and then cached, and will not be re-computed on subsequent calls to GetRange() unless the array is modified or the requested component changes. THIS METHOD IS NOT THREAD SAFE.

Definition at line 315 of file vtkDataArray.h.

double* vtkDataArray::GetRange ( int  comp)
inline

Return the range of the data array values for the given component. If comp is -1, return the range of the magnitude (L2 norm) over all components.The range is computed and then cached, and will not be re-computed on subsequent calls to GetRange() unless the array is modified or the requested component changes. THIS METHOD IS NOT THREAD SAFE.

Definition at line 328 of file vtkDataArray.h.

double* vtkDataArray::GetRange ( )
inline

Return the range of the data array. If the array has multiple components, then this will return the range of only the first component (component zero). The range is computed and then cached, and will not be re-computed on subsequent calls to GetRange() unless the array is modified. THIS METHOD IS NOT THREAD SAFE.

Definition at line 341 of file vtkDataArray.h.

void vtkDataArray::GetRange ( double  range[2])
inline

The the range of the data array values will be returned in the provided range array argument. If the data array has multiple components, then this will return the range of only the first component (component zero). The range is computend and then cached, and will not be re-computed on subsequent calls to GetRange() unless the array is modified. THIS METHOD IS NOT THREAD SAFE.

Definition at line 354 of file vtkDataArray.h.

void vtkDataArray::GetDataTypeRange ( double  range[2])

These methods return the Min and Max possible range of the native data type. For example if a vtkScalars consists of unsigned char data these will return (0,255).

double vtkDataArray::GetDataTypeMin ( )

These methods return the Min and Max possible range of the native data type. For example if a vtkScalars consists of unsigned char data these will return (0,255).

double vtkDataArray::GetDataTypeMax ( )

These methods return the Min and Max possible range of the native data type. For example if a vtkScalars consists of unsigned char data these will return (0,255).

static void vtkDataArray::GetDataTypeRange ( int  type,
double  range[2] 
)
static

These methods return the Min and Max possible range of the native data type. For example if a vtkScalars consists of unsigned char data these will return (0,255).

static double vtkDataArray::GetDataTypeMin ( int  type)
static

These methods return the Min and Max possible range of the native data type. For example if a vtkScalars consists of unsigned char data these will return (0,255).

static double vtkDataArray::GetDataTypeMax ( int  type)
static

These methods return the Min and Max possible range of the native data type. For example if a vtkScalars consists of unsigned char data these will return (0,255).

virtual double vtkDataArray::GetMaxNorm ( )
virtual

Return the maximum norm for the tuples. Note that the max. is computed every time GetMaxNorm is called.

static vtkDataArray* vtkDataArray::CreateDataArray ( int  dataType)
static

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. Note that the data array returned has be deleted by the user.

static vtkInformationDoubleVectorKey* vtkDataArray::COMPONENT_RANGE ( )
static

This key is used to hold tight bounds on the range of one component over all tuples of the array. Two values (a minimum and maximum) are stored for each component. When GetRange() is called when no tuples are present in the array this value is set to { VTK_DOUBLE_MAX, VTK_DOUBLE_MIN }.

static vtkInformationDoubleVectorKey* vtkDataArray::L2_NORM_RANGE ( )
static

This key is used to hold tight bounds on the $L_2$ norm of tuples in the array. Two values (a minimum and maximum) are stored for each component. When GetRange() is called when no tuples are present in the array this value is set to { VTK_DOUBLE_MAX, VTK_DOUBLE_MIN }.

virtual int vtkDataArray::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: Up to the implmeneter to make sure that keys not inteneded to be coppied are excluded here.

Reimplemented from vtkAbstractArray.

virtual int vtkDataArray::GetArrayType ( )
inlinevirtual

Method for type-checking in FastDownCast implementations.

Reimplemented from vtkAbstractArray.

Reimplemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkTypedDataArray< Scalar >, vtkTypedDataArray< T >, and vtkMappedDataArray< Scalar >.

Definition at line 403 of file vtkDataArray.h.

virtual void vtkDataArray::ComputeRange ( double  range[2],
int  comp 
)
protectedvirtual

Compute the range for a specific component. If comp is set -1 then L2 norm is computed on all components. Call ClearRange to force a recomputation if it is needed. The range is copied to the range argument. THIS METHOD IS NOT THREAD SAFE.

virtual bool vtkDataArray::ComputeScalarRange ( double ranges)
protectedvirtual

Computes the range for each component of an array, the length of ranges must be two times the number of components. Returns true if the range was computed. Will return false if you try to compute the range of an array of length zero.

Reimplemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, and vtkPeriodicDataArray< Scalar >.

virtual bool vtkDataArray::ComputeVectorRange ( double  range[2])
protectedvirtual

Friends And Related Function Documentation

friend class vtkPoints
friend

Definition at line 407 of file vtkDataArray.h.

Member Data Documentation

vtkLookupTable* vtkDataArray::LookupTable
protected

Definition at line 429 of file vtkDataArray.h.

double vtkDataArray::Range[2]
protected

Definition at line 430 of file vtkDataArray.h.


The documentation for this class was generated from the following file: