vtkDataArray Class Reference

#include <vtkDataArray.h>

Inheritance diagram for vtkDataArray:

Inheritance graph
[legend]
Collaboration diagram for vtkDataArray:

Collaboration graph
[legend]

List of all members.


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 53 of file vtkDataArray.h.

void GetRange (double range[2], int comp)
double * GetRange (int comp)
double * GetRange ()
void GetRange (double range[2])
void GetDataTypeRange (double range[2])
double GetDataTypeMin ()
double GetDataTypeMax ()
static void GetDataTypeRange (int type, double range[2])
static double GetDataTypeMin (int type)
static double GetDataTypeMax (int type)

Public Types

typedef vtkAbstractArray Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
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 double * GetTuple (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 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)
double * GetTuple2 (vtkIdType i)
double * GetTuple3 (vtkIdType i)
double * GetTuple4 (vtkIdType i)
double * GetTuple9 (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 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 ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkDataArraySafeDownCast (vtkObject *o)
static vtkDataArrayCreateDataArray (int dataType)
static
vtkInformationInformationVectorKey
PER_COMPONENT ()
static
vtkInformationDoubleVectorKey
COMPONENT_RANGE ()
static
vtkInformationDoubleVectorKey
L2_NORM_RANGE ()

Protected Member Functions

 vtkDataArray (vtkIdType numComp=1)
 ~vtkDataArray ()
virtual void ComputeRange (int comp)
virtual void ComputeScalarRange (int comp)
virtual void ComputeVectorRange ()

Protected Attributes

vtkLookupTableLookupTable
double Range [2]

Member Typedef Documentation


Constructor & Destructor Documentation

vtkDataArray::vtkDataArray ( vtkIdType  numComp = 1  )  [protected]

vtkDataArray::~vtkDataArray (  )  [protected]


Member Function Documentation

virtual const char* vtkDataArray::GetClassName (  )  [virtual]

static int vtkDataArray::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 vtkAbstractArray.

Reimplemented in vtk__Int64Array, vtkBitArray, vtkCharArray, vtkDoubleArray, vtkFloatArray, vtkIdTypeArray, vtkIntArray, vtkLongArray, vtkLongLongArray, vtkShortArray, vtkSignedCharArray, vtkUnsigned__Int64Array, vtkUnsignedCharArray, vtkUnsignedIntArray, vtkUnsignedLongArray, vtkUnsignedLongLongArray, and vtkUnsignedShortArray.

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

Reimplemented in vtk__Int64Array, vtkBitArray, vtkCharArray, vtkDoubleArray, vtkFloatArray, vtkIdTypeArray, vtkIntArray, vtkLongArray, vtkLongLongArray, vtkShortArray, vtkSignedCharArray, vtkUnsigned__Int64Array, vtkUnsignedCharArray, vtkUnsignedIntArray, vtkUnsignedLongArray, vtkUnsignedLongLongArray, and vtkUnsignedShortArray.

static vtkDataArray* vtkDataArray::SafeDownCast ( vtkObject o  )  [static]

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

Reimplemented in vtk__Int64Array, vtkBitArray, vtkCharArray, vtkDataArrayTemplate< T >, vtkDoubleArray, vtkFloatArray, vtkIdTypeArray, vtkIntArray, vtkLongArray, vtkLongLongArray, vtkShortArray, vtkSignedCharArray, vtkUnsigned__Int64Array, vtkUnsignedCharArray, vtkUnsignedIntArray, vtkUnsignedLongArray, vtkUnsignedLongLongArray, and vtkUnsignedShortArray.

virtual int vtkDataArray::IsNumeric (  )  [inline, virtual]

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 64 of file vtkDataArray.h.

virtual int vtkDataArray::GetElementComponentSize (  )  [inline, 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.

Implements vtkAbstractArray.

Definition at line 71 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 vtkBitArray, and vtkDataArrayTemplate< T >.

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 vtkBitArray, and vtkDataArrayTemplate< T >.

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 vtkBitArray, and vtkDataArrayTemplate< T >.

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.

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.

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.

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.

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 vtkBitArray, and vtkDataArrayTemplate< T >.

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 vtkBitArray, and vtkDataArrayTemplate< T >.

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::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 vtkBitArray, and vtkDataArrayTemplate< T >.

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 vtkBitArray, and vtkDataArrayTemplate< T >.

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::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 vtkBitArray, and vtkDataArrayTemplate< T >.

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 vtkBitArray, and vtkDataArrayTemplate< T >.

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 vtkBitArray, and vtkDataArrayTemplate< T >.

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 vtkBitArray, and vtkDataArrayTemplate< T >.

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 vtkBitArray, and vtkDataArrayTemplate< T >.

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 vtkBitArray, and vtkDataArrayTemplate< T >.

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 vtkBitArray, and vtkDataArrayTemplate< T >.

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 >.

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 vtkBitArray, and vtkDataArrayTemplate< T >.

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 vtkBitArray, and vtkDataArrayTemplate< T >.

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, and vtkDataArrayTemplate< T >.

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, and vtkDataArrayTemplate< T >.

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 vtkBitArray, and vtkDataArrayTemplate< T >.

virtual unsigned long vtkDataArray::GetActualMemorySize (  )  [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.

Implements vtkAbstractArray.

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]

Return the range of the array values for the given component. Range is copied into the array provided. If comp is equal to -1, it returns the range of the magnitude (if the number of components is equal to 1 it still returns the range of component 0).

Definition at line 301 of file vtkDataArray.h.

double* vtkDataArray::GetRange ( int  comp  )  [inline]

Return the range of the array values for the given component. Range is copied into the array provided. If comp is equal to -1, it returns the range of the magnitude (if the number of components is equal to 1 it still returns the range of component 0).

Definition at line 306 of file vtkDataArray.h.

double* vtkDataArray::GetRange (  )  [inline]

Return the range of the array values for the given component. Range is copied into the array provided. If comp is equal to -1, it returns the range of the magnitude (if the number of components is equal to 1 it still returns the range of component 0).

Definition at line 314 of file vtkDataArray.h.

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

Return the range of the array values for the given component. Range is copied into the array provided. If comp is equal to -1, it returns the range of the magnitude (if the number of components is equal to 1 it still returns the range of component 0).

Definition at line 319 of file vtkDataArray.h.

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

Return the range of the array values for the given component. Range is copied into the array provided. If comp is equal to -1, it returns the range of the magnitude (if the number of components is equal to 1 it still returns the range of component 0).

double vtkDataArray::GetDataTypeMin (  ) 

Return the range of the array values for the given component. Range is copied into the array provided. If comp is equal to -1, it returns the range of the magnitude (if the number of components is equal to 1 it still returns the range of component 0).

double vtkDataArray::GetDataTypeMax (  ) 

Return the range of the array values for the given component. Range is copied into the array provided. If comp is equal to -1, it returns the range of the magnitude (if the number of components is equal to 1 it still returns the range of component 0).

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

Return the range of the array values for the given component. Range is copied into the array provided. If comp is equal to -1, it returns the range of the magnitude (if the number of components is equal to 1 it still returns the range of component 0).

static double vtkDataArray::GetDataTypeMin ( int  type  )  [static]

Return the range of the array values for the given component. Range is copied into the array provided. If comp is equal to -1, it returns the range of the magnitude (if the number of components is equal to 1 it still returns the range of component 0).

static double vtkDataArray::GetDataTypeMax ( int  type  )  [static]

Return the range of the array values for the given component. Range is copied into the array provided. If comp is equal to -1, it returns the range of the magnitude (if the number of components is equal to 1 it still returns the range of component 0).

virtual double vtkDataArray::GetMaxNorm (  )  [virtual]

Return the maximum norm for the tuples. Note that the max. is computed everytime 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 vtkInformationInformationVectorKey* vtkDataArray::PER_COMPONENT (  )  [static]

This key is used to hold a vector of 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_RANGE to { VTK_DOUBLE_MAX, VTK_DOUBLE_MIN } or (2) call 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 vtkInformationDoubleVectorKey* vtkDataArray::COMPONENT_RANGE (  )  [static]

This key is used to hold a vector of 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_RANGE to { VTK_DOUBLE_MAX, VTK_DOUBLE_MIN } or (2) call 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 vtkInformationDoubleVectorKey* vtkDataArray::L2_NORM_RANGE (  )  [static]

This key is used to hold a vector of 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_RANGE to { VTK_DOUBLE_MAX, VTK_DOUBLE_MIN } or (2) call 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.

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 void vtkDataArray::ComputeRange ( int  comp  )  [protected, virtual]

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.

virtual void vtkDataArray::ComputeScalarRange ( int  comp  )  [protected, virtual]

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.

Reimplemented in vtkDataArrayTemplate< T >.

virtual void vtkDataArray::ComputeVectorRange (  )  [protected, virtual]

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.

Reimplemented in vtkDataArrayTemplate< T >.


Member Data Documentation

Definition at line 397 of file vtkDataArray.h.

double vtkDataArray::Range[2] [protected]

Definition at line 398 of file vtkDataArray.h.


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

Generated on Mon Sep 27 18:21:13 2010 for VTK by  doxygen 1.5.6