abstract superclass for arrays of numeric data More...

#include <vtkDataArray.h>

Inheritance diagram for vtkDataArray:

Collaboration diagram for vtkDataArray:

Public Types
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 , ScaleSoADataArrayTemplate , DataArrayTemplate = AoSDataArrayTemplate }

typedef vtkObject	Superclass

Public Member Functions
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 () const override
	This method is here to make backward compatibility easier. More...

int	GetElementComponentSize () const override
	Return the size, in bytes, of the lowest-level element of an array. 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...

vtkIdType	InsertNextTuple (vtkIdType srcTupleIdx, vtkAbstractArray *source) override
	Insert the tuple from srcTupleIdx in the source array at the end of this array. 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	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...

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

virtual double *	GetTuple (vtkIdType tupleIdx)=0
	Get the data tuple at tupleIdx. More...

virtual void	GetTuple (vtkIdType tupleIdx, double *tuple)=0
	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	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...

virtual double	GetComponent (vtkIdType tupleIdx, int compIdx)
	Return the data component at the location specified by tupleIdx and compIdx. More...

virtual void	SetComponent (vtkIdType tupleIdx, int compIdx, double value)
	Set the data component at the location specified by tupleIdx and compIdx to value. More...

virtual void	InsertComponent (vtkIdType tupleIdx, int compIdx, double value)
	Insert value at the location specified by tupleIdx and compIdx. 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	FillComponent (int compIdx, double value)
	Fill a component of a data array with a specified value. 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...

virtual void *	WriteVoidPointer (vtkIdType valueIdx, vtkIdType numValues)=0
	Get the address of a particular data index. More...

unsigned long	GetActualMemorySize () const 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 () const 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...


virtual void	SetTuple (vtkIdType tupleIdx, const float *tuple)
	Set the data tuple at tupleIdx. More...

virtual void	SetTuple (vtkIdType tupleIdx, const double *tuple)
	Set the data tuple at tupleIdx. 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...


virtual void	InsertTuple (vtkIdType tupleIdx, const float *tuple)=0
	Insert the data tuple at tupleIdx. More...

virtual void	InsertTuple (vtkIdType tupleIdx, const double *tuple)=0
	Insert the data tuple at tupleIdx. 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...


virtual vtkIdType	InsertNextTuple (const float *tuple)=0
	Insert the data tuple at the end of the array and return the tuple index at which the data was inserted. More...

virtual vtkIdType	InsertNextTuple (const double *tuple)=0
	Insert the data tuple at the end of the array and return the tuple index at which the data was inserted. 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	RemoveTuple (vtkIdType tupleIdx)=0
	These methods remove tuples from the data array. 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...

Public Member Functions inherited from vtkAbstractArray
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkAbstractArray *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual vtkTypeBool	Allocate (vtkIdType numValues, vtkIdType ext=1000)=0
	Allocate memory for this array. More...

virtual void	Initialize ()=0
	Release storage and reset array to initial state. More...

virtual int	GetDataType () const =0
	Return the underlying data type. More...

virtual int	GetElementComponentSize () const =0
	Return the size, in bytes, of the lowest-level element of an array. More...

void	SetComponentName (vtkIdType component, const char *name)
	Set the name for a component. More...

const char *	GetComponentName (vtkIdType component) const
	Get the component name for a given component. More...

bool	HasAComponentName () const
	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	SetNumberOfTuples (vtkIdType numTuples)=0
	Set the number of tuples (a component group) in the array. More...

virtual bool	SetNumberOfValues (vtkIdType numValues)
	Specify the number of values (tuples * components) for this object to hold. More...

vtkIdType	GetNumberOfTuples () const
	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...

virtual void	SetTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
	Set the tuple at dstTupleIdx in this array to the tuple at srcTupleIdx in the source array. More...

virtual void	InsertTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
	Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx. More...

virtual void	InsertTuples (vtkIdList dstIds, vtkIdList srcIds, vtkAbstractArray *source)=0
	Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in this array. More...

virtual void	InsertTuples (vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray *source)=0
	Copy n consecutive tuples starting at srcStart from the source array to this array, starting at the dstStart location. More...

virtual vtkIdType	InsertNextTuple (vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
	Insert the tuple from srcTupleIdx in the source array at the end of this array. More...

virtual void	GetTuples (vtkIdList tupleIds, vtkAbstractArray output)
	Given a list of tuple ids, return an array of tuples. More...

virtual void	GetTuples (vtkIdType p1, vtkIdType p2, vtkAbstractArray *output)
	Get the tuples for the range of tuple ids specified (i.e., p1->p2 inclusive). More...

virtual bool	HasStandardMemoryLayout () const
	Returns true if this array uses the standard memory layout defined in the VTK user guide, e.g. More...

virtual void *	GetVoidPointer (vtkIdType valueIdx)=0
	Return a void pointer. More...

virtual void	DeepCopy (vtkAbstractArray *da)
	Deep copy of data. More...

virtual void	InterpolateTuple (vtkIdType dstTupleIdx, vtkIdList ptIndices, vtkAbstractArray source, double *weights)=0
	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...

virtual void	InterpolateTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx1, vtkAbstractArray source1, vtkIdType srcTupleIdx2, vtkAbstractArray source2, double t)=0
	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...

virtual void	Squeeze ()=0
	Free any unnecessary memory. More...

virtual vtkTypeBool	Resize (vtkIdType numTuples)=0
	Resize the array to the requested number of tuples and preserve data. More...

vtkIdType	GetSize () const
	Return the size of the data. More...

vtkIdType	GetMaxId () const
	What is the maximum id currently in the array. More...

virtual void	SetArrayFreeFunction (void(callback)(void ))=0
	This method allows the user to specify a custom free function to be called when the array is deallocated. More...

virtual void	ExportToVoidPointer (void *out_ptr)
	This method copies the array data to the void pointer specified by the user. More...

virtual unsigned long	GetActualMemorySize () const =0
	Return the memory in kibibytes (1024 bytes) consumed by this data array. More...

virtual const char *	GetDataTypeAsString (void) const
	Get the name of a data type as a string. More...

virtual int	IsNumeric () const =0
	This method is here to make backward compatibility easier. More...

virtual vtkArrayIterator *	NewIterator ()=0
	Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate. More...

virtual vtkIdType	GetDataSize () const
	Returns the size of the data in DataTypeSize units. More...

virtual vtkVariant	GetVariantValue (vtkIdType valueIdx)
	Retrieve value from the array as a variant. More...

virtual void	InsertVariantValue (vtkIdType valueIdx, vtkVariant value)=0
	Insert a value into the array from a variant. More...

virtual void	SetVariantValue (vtkIdType valueIdx, vtkVariant value)=0
	Set a value in the array from a variant. More...

virtual void	DataChanged ()=0
	Tell the array explicitly that the data has changed. More...

virtual void	ClearLookup ()=0
	Delete the associated fast lookup data structure on this array, if it exists. 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 () const
	Inquire if this array has an instance of vtkInformation already associated with it. More...

virtual int	CopyInformation (vtkInformation *infoFrom, int deep=1)
	Copy information instance. More...

void	Modified () override
	Removes out-of-date PER_COMPONENT() and PER_FINITE_COMPONENT() values. More...

virtual int	GetArrayType () const
	Method for type-checking in FastDownCast implementations. More...

virtual void	SetNumberOfComponents (int)
	Set/Get the dimension (n) of the components. More...

int	GetNumberOfComponents () const
	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 vtkIdType	LookupValue (vtkVariant value)=0
	Return the value indices where a specific value appears. More...

virtual void	LookupValue (vtkVariant value, vtkIdList *valueIds)=0
	Return the value indices where a specific value appears. 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...

virtual int	GetDataTypeSize () const =0
	Return the size of the underlying data type. 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 void	Modified ()
	Update the modification time for this object. 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 vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. 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...

Static Public Member Functions
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_FLOAT, 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 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 vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
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])
	Returns true if the range was computed. More...

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])
	Returns true if the range was computed. More...

	vtkDataArray ()

	~vtkDataArray () override

Protected Member Functions inherited from vtkAbstractArray
virtual vtkObjectBase *	NewInstanceInternal () const

	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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
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
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkPoints

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

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

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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 vtkGenericDataArray

Online Examples:

VectorFieldNonZeroExtraction

Definition at line 158 of file vtkDataArray.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAbstractArray vtkDataArray::Superclass

Definition at line 161 of file vtkDataArray.h.

Constructor & Destructor Documentation

◆ vtkDataArray()

vtkDataArray::vtkDataArray ( )

protected

◆ ~vtkDataArray()

vtkDataArray::~vtkDataArray ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkDataArray::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool 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 vtkBitArray, vtkCharArray, vtkDoubleArray, vtkFloatArray, vtkIdTypeArray, vtkIntArray, vtkLongArray, vtkLongLongArray, vtkShortArray, vtkSignedCharArray, vtkUnsignedCharArray, vtkUnsignedIntArray, vtkUnsignedLongArray, vtkUnsignedLongLongArray, and vtkUnsignedShortArray.

◆ SafeDownCast()

static vtkDataArray * vtkDataArray::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDataArray::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractArray.

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

◆ NewInstance()

vtkDataArray * vtkDataArray::NewInstance ( ) const

◆ PrintSelf()

void vtkDataArray::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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 vtkDoubleArray, vtkFloatArray, vtkIdTypeArray, vtkIntArray, vtkLongArray, vtkLongLongArray, vtkMappedDataArray< Scalar >, vtkShortArray, vtkSignedCharArray, vtkTestDataArray< ArrayT >, vtkUnsignedCharArray, vtkUnsignedIntArray, vtkUnsignedLongArray, vtkUnsignedLongLongArray, vtkUnsignedShortArray, vtkAngularPeriodicDataArray< Scalar >, vtkPeriodicDataArray< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, and vtkCPExodusIIResultsArrayTemplate< Scalar >.

◆ FastDownCast()

vtkDataArray * vtkDataArray::FastDownCast ( vtkAbstractArray * source )

inlinestatic

Perform a fast, safe cast from a vtkAbstractArray to a vtkDataArray.

This method checks if source->GetArrayType() returns DataArray or a more derived type, and performs a static_cast to return source as a vtkDataArray pointer. Otherwise, nullptr is returned.

Definition at line 686 of file vtkDataArray.h.

◆ IsNumeric()

int vtkDataArray::IsNumeric ( ) const

inlineoverridevirtual

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

◆ GetElementComponentSize()

int vtkDataArray::GetElementComponentSize ( ) const

inlineoverridevirtual

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

◆ InsertTuple() [1/3]

void vtkDataArray::InsertTuple	(	vtkIdType	dstTupleIdx,
		vtkIdType	srcTupleIdx,
		vtkAbstractArray *	source
	)

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.

Implements vtkAbstractArray.

◆ InsertNextTuple() [1/3]

vtkIdType vtkDataArray::InsertNextTuple	(	vtkIdType	srcTupleIdx,
		vtkAbstractArray *	source
	)

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.

Implements vtkAbstractArray.

◆ InsertTuples() [1/2]

void vtkDataArray::InsertTuples	(	vtkIdList *	dstIds,
		vtkIdList *	srcIds,
		vtkAbstractArray *	source
	)

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.

Implements vtkAbstractArray.

◆ InsertTuples() [2/2]

void vtkDataArray::InsertTuples	(	vtkIdType	dstStart,
		vtkIdType	n,
		vtkIdType	srcStart,
		vtkAbstractArray *	source
	)

overridevirtual

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.

Implements vtkAbstractArray.

◆ GetTuples() [1/2]

void vtkDataArray::GetTuples	(	vtkIdList *	tupleIds,
		vtkAbstractArray *	output
	)

overridevirtual

Given a list of tuple ids, return an array of tuples.

You must ensure that the output array has been previously allocated with enough space to hold the data.

Reimplemented from vtkAbstractArray.

◆ GetTuples() [2/2]

void vtkDataArray::GetTuples	(	vtkIdType	p1,
		vtkIdType	p2,
		vtkAbstractArray *	output
	)

overridevirtual

Get the tuples for the range of tuple ids specified (i.e., p1->p2 inclusive).

You must ensure that the output array has been previously allocated with enough space to hold the data.

Reimplemented from vtkAbstractArray.

◆ InterpolateTuple() [1/2]

void vtkDataArray::InterpolateTuple	(	vtkIdType	dstTupleIdx,
		vtkIdList *	ptIndices,
		vtkAbstractArray *	source,
		double *	weights
	)

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.

Implements vtkAbstractArray.

◆ InterpolateTuple() [2/2]

void vtkDataArray::InterpolateTuple	(	vtkIdType	dstTupleIdx,
		vtkIdType	srcTupleIdx1,
		vtkAbstractArray *	source1,
		vtkIdType	srcTupleIdx2,
		vtkAbstractArray *	source2,
		double	t
	)

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.

Implements vtkAbstractArray.

◆ GetTuple() [1/2]

virtual double * vtkDataArray::GetTuple ( vtkIdType tupleIdx )

pure virtual

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.

◆ GetTuple() [2/2]

virtual void vtkDataArray::GetTuple	(	vtkIdType	tupleIdx,
		double *	tuple
	)

pure virtual

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.

◆ GetTuple1()

double vtkDataArray::GetTuple1 ( vtkIdType tupleIdx )

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.

◆ GetTuple2()

double * vtkDataArray::GetTuple2 ( vtkIdType tupleIdx )

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.

◆ GetTuple3()

double * vtkDataArray::GetTuple3 ( vtkIdType tupleIdx )

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.

◆ GetTuple4()

double * vtkDataArray::GetTuple4 ( vtkIdType tupleIdx )

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.

◆ GetTuple6()

double * vtkDataArray::GetTuple6 ( vtkIdType tupleIdx )

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.

◆ GetTuple9()

double * vtkDataArray::GetTuple9 ( vtkIdType tupleIdx )

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.

◆ SetTuple() [1/3]

void vtkDataArray::SetTuple	(	vtkIdType	dstTupleIdx,
		vtkIdType	srcTupleIdx,
		vtkAbstractArray *	source
	)

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.

Implements vtkAbstractArray.

◆ SetTuple() [2/3]

virtual void vtkDataArray::SetTuple	(	vtkIdType	tupleIdx,
		const float *	tuple
	)

virtual

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.

◆ SetTuple() [3/3]

virtual void vtkDataArray::SetTuple	(	vtkIdType	tupleIdx,
		const double *	tuple
	)

virtual

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.

◆ SetTuple1()

void vtkDataArray::SetTuple1	(	vtkIdType	tupleIdx,
		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.

◆ SetTuple2()

void vtkDataArray::SetTuple2	(	vtkIdType	tupleIdx,
		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.

◆ SetTuple3()

void vtkDataArray::SetTuple3	(	vtkIdType	tupleIdx,
		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.

◆ SetTuple4()

void vtkDataArray::SetTuple4	(	vtkIdType	tupleIdx,
		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.

◆ SetTuple6()

void vtkDataArray::SetTuple6	(	vtkIdType	tupleIdx,
		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.

◆ SetTuple9()

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

GetTuple() and SetTuple() which return/take arrays can not be used from wrapped languages. These methods can be used instead.

◆ InsertTuple() [2/3]

virtual void vtkDataArray::InsertTuple	(	vtkIdType	tupleIdx,
		const float *	tuple
	)

pure virtual

Insert the data tuple at tupleIdx.

Note that memory allocation is performed as necessary to hold the data.

◆ InsertTuple() [3/3]

virtual void vtkDataArray::InsertTuple	(	vtkIdType	tupleIdx,
		const double *	tuple
	)

pure virtual

Insert the data tuple at tupleIdx.

Note that memory allocation is performed as necessary to hold the data.

◆ InsertTuple1()

void vtkDataArray::InsertTuple1	(	vtkIdType	tupleIdx,
		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.

◆ InsertTuple2()

void vtkDataArray::InsertTuple2	(	vtkIdType	tupleIdx,
		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.

◆ InsertTuple3()

void vtkDataArray::InsertTuple3	(	vtkIdType	tupleIdx,
		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.

◆ InsertTuple4()

void vtkDataArray::InsertTuple4	(	vtkIdType	tupleIdx,
		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.

◆ InsertTuple6()

void vtkDataArray::InsertTuple6	(	vtkIdType	tupleIdx,
		double	val0,
		double	val1,
		double	val2,
		double	val3,
		double	val4,
		double	val5
	)

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.

◆ InsertTuple9()

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

InsertTuple() which takes arrays can not be used from wrapped languages. These methods can be used instead.

◆ InsertNextTuple() [2/3]

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

pure virtual

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.

◆ InsertNextTuple() [3/3]

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

pure virtual

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.

◆ InsertNextTuple1()

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.

◆ InsertNextTuple2()

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.

◆ InsertNextTuple3()

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.

◆ InsertNextTuple4()

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.

◆ InsertNextTuple6()

void vtkDataArray::InsertNextTuple6	(	double	val0,
		double	val1,
		double	val2,
		double	val3,
		double	val4,
		double	val5
	)

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.

◆ InsertNextTuple9()

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.

◆ RemoveTuple()

virtual void vtkDataArray::RemoveTuple ( vtkIdType tupleIdx )

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.

◆ RemoveFirstTuple()

virtual void vtkDataArray::RemoveFirstTuple ( )

inlinevirtual

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.

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

Definition at line 331 of file vtkDataArray.h.

◆ RemoveLastTuple()

virtual void vtkDataArray::RemoveLastTuple ( )

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.

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

◆ GetComponent()

virtual double vtkDataArray::GetComponent	(	vtkIdType	tupleIdx,
		int	compIdx
	)

virtual

Return the data component at the location specified by tupleIdx and compIdx.

◆ SetComponent()

virtual void vtkDataArray::SetComponent	(	vtkIdType	tupleIdx,
		int	compIdx,
		double	value
	)

virtual

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

◆ InsertComponent()

virtual void vtkDataArray::InsertComponent	(	vtkIdType	tupleIdx,
		int	compIdx,
		double	value
	)

virtual

Insert value at the location specified by tupleIdx and compIdx.

Note that memory allocation is performed as necessary to hold the data.

◆ GetData()

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.

◆ DeepCopy() [1/2]

void vtkDataArray::DeepCopy ( vtkAbstractArray * aa )

overridevirtual

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 vtkPeriodicDataArray< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkMappedDataArray< Scalar >.

◆ DeepCopy() [2/2]

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 >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkMappedDataArray< Scalar >.

◆ ShallowCopy()

virtual void vtkDataArray::ShallowCopy ( vtkDataArray * other )

virtual

Create a shallow copy of other into this, if possible.

Shallow copies are only possible: (a) if both arrays are the same data type (b) if both arrays are the same array type (e.g. AOS vs. SOA) (c) if both arrays support shallow copies (e.g. vtkBitArray currently does not.) If a shallow copy is not possible, a deep copy will be performed instead.

◆ FillComponent()

virtual void vtkDataArray::FillComponent	(	int	compIdx,
		double	value
	)

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.

◆ Fill()

virtual void vtkDataArray::Fill ( double value )

virtual

Fill all values of a data array with a specified value.

◆ CopyComponent()

virtual void vtkDataArray::CopyComponent	(	int	dstComponent,
		vtkDataArray *	src,
		int	srcComponent
	)

virtual

Copy a component from one data array into a component on this data array.

This method copies the specified component ("srcComponent") from the specified data array ("src") to the specified component ("dstComponent") 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.

◆ WriteVoidPointer()

virtual void * vtkDataArray::WriteVoidPointer	(	vtkIdType	valueIdx,
		vtkIdType	numValues
	)

pure virtual

Get the address of a particular data index.

Make sure data is allocated for the number of items requested. If needed, increase MaxId to mark any new value ranges as in-use.

◆ GetActualMemorySize()

unsigned long vtkDataArray::GetActualMemorySize ( ) const

overridevirtual

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

◆ CreateDefaultLookupTable()

void vtkDataArray::CreateDefaultLookupTable ( )

Create default lookup table.

Generally used to create one when none is available.

◆ SetLookupTable()

void vtkDataArray::SetLookupTable ( vtkLookupTable * lut )

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

◆ GetLookupTable()

virtual vtkLookupTable * vtkDataArray::GetLookupTable ( )

virtual

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

◆ GetRange() [1/4]

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

◆ GetRange() [2/4]

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

◆ GetRange() [3/4]

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

◆ GetRange() [4/4]

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

inline

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

◆ GetFiniteRange() [1/4]

void vtkDataArray::GetFiniteRange	(	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 501 of file vtkDataArray.h.

◆ GetFiniteRange() [2/4]

double * vtkDataArray::GetFiniteRange ( 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 512 of file vtkDataArray.h.

◆ GetFiniteRange() [3/4]

double * vtkDataArray::GetFiniteRange ( )

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

◆ GetFiniteRange() [4/4]

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

inline

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

◆ GetDataTypeRange() [1/2]

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

◆ GetDataTypeMin() [1/2]

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

◆ GetDataTypeMax() [1/2]

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

◆ GetDataTypeRange() [2/2]

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

◆ GetDataTypeMin() [2/2]

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

◆ GetDataTypeMax() [2/2]

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

◆ GetMaxNorm()

virtual double vtkDataArray::GetMaxNorm ( )

virtual

Return the maximum norm for the tuples.

Note that the max. is computed every time GetMaxNorm is called.

◆ CreateDataArray()

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_FLOAT, VTK_DOUBLE, VTK_ID_TYPE.

Note that the data array returned has be deleted by the user.

◆ COMPONENT_RANGE()

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

◆ L2_NORM_RANGE()

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

◆ L2_NORM_FINITE_RANGE()

static vtkInformationDoubleVectorKey * vtkDataArray::L2_NORM_FINITE_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 GetFiniteRange() is called when no tuples are present in the array this value is set to { VTK_DOUBLE_MAX, VTK_DOUBLE_MIN }.

◆ Modified()

void vtkDataArray::Modified ( )

overridevirtual

Removes out-of-date L2_NORM_RANGE() and L2_NORM_FINITE_RANGE() values.

Reimplemented from vtkAbstractArray.

Reimplemented in vtkMappedDataArray< Scalar >.

◆ UNITS_LABEL()

static vtkInformationStringKey * vtkDataArray::UNITS_LABEL ( )

static

A human-readable string indicating the units for the array data.

◆ CopyInformation()

int vtkDataArray::CopyInformation	(	vtkInformation *	infoFrom,
		int	deep = `1`
	)

overridevirtual

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 copied, while others must be. NOTE: Up to the implmenter to make sure that keys not intended to be copied are excluded here.

Reimplemented from vtkAbstractArray.

◆ GetArrayType()

int vtkDataArray::GetArrayType ( ) const

inlineoverridevirtual

Method for type-checking in FastDownCast implementations.

Reimplemented from vtkAbstractArray.

Definition at line 618 of file vtkDataArray.h.

◆ ComputeRange()

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.

◆ ComputeFiniteRange()

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

◆ ComputeScalarRange()

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

◆ ComputeVectorRange()

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

protectedvirtual

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

◆ ComputeFiniteScalarRange()

virtual bool vtkDataArray::ComputeFiniteScalarRange ( 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.

◆ ComputeFiniteVectorRange()

virtual bool vtkDataArray::ComputeFiniteVectorRange ( double range[2] )

protectedvirtual

Returns true if the range was computed.

Will return false if you try to compute the range of an array of length zero.

Friends And Related Function Documentation

◆ vtkPoints

friend class vtkPoints

friend

Definition at line 621 of file vtkDataArray.h.

Member Data Documentation

◆ LookupTable

vtkLookupTable* vtkDataArray::LookupTable

protected

Definition at line 673 of file vtkDataArray.h.

◆ Range

double vtkDataArray::Range[2]

protected

Definition at line 674 of file vtkDataArray.h.

◆ FiniteRange

double vtkDataArray::FiniteRange[2]

protected

Definition at line 675 of file vtkDataArray.h.

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

Common/Core/vtkDataArray.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkDataArray()

◆ ~vtkDataArray()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ FastDownCast()

◆ IsNumeric()

◆ GetElementComponentSize()

◆ InsertTuple() [1/3]

◆ InsertNextTuple() [1/3]

◆ InsertTuples() [1/2]

◆ InsertTuples() [2/2]

◆ GetTuples() [1/2]

◆ GetTuples() [2/2]

◆ InterpolateTuple() [1/2]

◆ InterpolateTuple() [2/2]

◆ GetTuple() [1/2]

◆ GetTuple() [2/2]

◆ GetTuple1()

◆ GetTuple2()

◆ GetTuple3()

◆ GetTuple4()

◆ GetTuple6()

◆ GetTuple9()

◆ SetTuple() [1/3]

◆ SetTuple() [2/3]

◆ SetTuple() [3/3]

◆ SetTuple1()

◆ SetTuple2()

◆ SetTuple3()

◆ SetTuple4()

◆ SetTuple6()

◆ SetTuple9()

◆ InsertTuple() [2/3]

◆ InsertTuple() [3/3]

◆ InsertTuple1()

◆ InsertTuple2()

◆ InsertTuple3()

◆ InsertTuple4()

◆ InsertTuple6()

◆ InsertTuple9()

◆ InsertNextTuple() [2/3]

◆ InsertNextTuple() [3/3]

◆ InsertNextTuple1()

◆ InsertNextTuple2()

◆ InsertNextTuple3()

◆ InsertNextTuple4()

◆ InsertNextTuple6()

◆ InsertNextTuple9()

◆ RemoveTuple()

◆ RemoveFirstTuple()

◆ RemoveLastTuple()

◆ GetComponent()

◆ SetComponent()

◆ InsertComponent()

◆ GetData()

◆ DeepCopy() [1/2]

◆ DeepCopy() [2/2]

◆ ShallowCopy()

◆ FillComponent()

◆ Fill()

◆ CopyComponent()

◆ WriteVoidPointer()

◆ GetActualMemorySize()

◆ CreateDefaultLookupTable()