#include <vtkFieldData.h>
Inheritance diagram for vtkFieldData:
Public Methods | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) |
void | Initialize () |
int | Allocate (const int sz, const int ext=1000) |
vtkFieldData * | MakeObject () |
void | SetNumberOfArrays (int num) |
void | SetArray (int i, vtkDataArray *) |
int | GetNumberOfArrays () |
vtkDataArray * | GetArray (int i) |
int | AddArray (vtkDataArray *array) |
int | AddArray (vtkDataArray *array, const char *name) |
int | AddReplaceArray (vtkDataArray *array, const char *name) |
int | AddNoReplaceArray (vtkDataArray *array, const char *name) |
int | GetArrayContainingComponent (int i, int &arrayComp) |
vtkDataArray * | GetArray (const char *arrayName) |
vtkDataArray * | GetArray (const char *arrayName, int &index) |
void | SetArrayName (int i, const char *name) |
char * | GetArrayName (int i) |
int | GetNumberOfComponents () |
int | GetNumberOfTuples () |
void | SetNumberOfTuples (const int number) |
float * | GetTuple (const int i) |
void | GetTuple (const int i, float *tuple) |
void | SetTuple (const int i, const float *tuple) |
void | InsertTuple (const int i, const float *tuple) |
int | InsertNextTuple (const float *tuple) |
float | GetComponent (const int i, const int j) |
void | SetComponent (const int i, const int j, const float c) |
void | InsertComponent (const int i, const int j, const float c) |
void | DeepCopy (vtkFieldData *da) |
void | ShallowCopy (vtkFieldData *da) |
void | Squeeze () |
void | Reset () |
void | GetField (vtkIdList *ptId, vtkFieldData *f) |
virtual unsigned long | GetActualMemorySize () |
void | DeepCopy (vtkFieldData &da) |
void | ShallowCopy (vtkFieldData &da) |
void | GetField (vtkIdList &ptId, vtkFieldData &f) |
Static Public Methods | |
vtkFieldData * | New () |
int | IsTypeOf (const char *type) |
vtkFieldData * | SafeDownCast (vtkObject *o) |
Protected Methods | |
vtkFieldData () | |
~vtkFieldData () | |
vtkFieldData (const vtkFieldData &) | |
void | operator= (const vtkFieldData &) |
Protected Attributes | |
int | NumberOfArrays |
vtkDataArray ** | Data |
char ** | ArrayNames |
int | TupleSize |
float * | Tuple |
vtkFieldData represents and manipulates fields of data. The model of a field is a m x n matrix of data values, where m is the number of tuples, and n is the number of components. (A tuple is a row of n components in the matrix.) The field is assumed to be composed of a set of one or more data arrays, where the data in the arrays are of different types (e.g., int, float, char, etc.), and there may be variable numbers of components in each array. Note that each data array is assumed to be "m" in length (i.e., number of tuples), which typically corresponds to the number of points or cells in a dataset.
There are two ways of manipulating and interfacing to fields. You can do it generically by manipulating components/tuples via a float-type data exchange, or you can do it by grabbing the arrays and manipulating them directly. The former is simpler but performs type conversion, which is bad if your data has non-castable types like (void) pointers, or you lose information as a result of the cast. The, more efficient method means managing each array in the field. Using this method you can create faster, more efficient algorithms that do not lose information.
|
Add an array to the end of the array list, and set the name return the new array index |
|
Add an array to the end of the array list, return the new array index |
|
Add an array to the end of the array list, and set the name return the new array index. returns -1 if array with given name already exists and does not overwrite it |
|
Add an array to the end of the array list, and set the name return the new array index. if array with given name already exists - overwrites it |
|
Allocate data for each array. |
|
For legacy compatibility. Do not use. |
|
Copy a field by creating new data arrays (i.e., duplicate storage). |
|
Return the memory in kilobytes consumed by this field data. 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. |
|
Return the array with the name given. Returns NULL is array not found. Also returns index of array if found, -1 otherwise |
|
Return the array with the name given. Returns NULL is array not found. |
|
Return the ith array in the field. A NULL is returned if the index i is out of range. |
|
Return the array containing the ith component of the field. The return value is an integer number n 0<=n<this->NumberOfArrays. Also, an integer value is returned indicating the component in the array is returned. Method returns -1 if specified component is not in the field. |
|
Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject. |
|
Get the component value at the ith tuple (or row) and jth component (or column). |
|
Get a field from a list of ids. Supplied field f should have same types and number of data arrays as this one (i.e., like MakeObject() returns). |
|
Get the number of arrays of data available. |
|
Get the number of components in the field. This is determined by adding up the components in each non-NULL array. |
|
Get the number of tuples in the field. Note: some fields have arrays with different numbers of tuples; this method returns the number of tuples in the first array. Mixed-length arrays may have to be treated specially. |
|
Copy the ith tuple value into a user provided tuple array. Make sure that you've allocated enough space for the copy. |
|
Return a tuple consisting of a concatenation of all data from all the different arrays. Note that everything is converted to and from float values. |
|
Release all data but do not delete object. |
|
Insert the component value at the ith tuple (or row) and jth component (or column). Range checking is performed and memory allocated as necessary o hold data. |
|
Insert the tuple value at the end of the tuple matrix. Range checking is performed and memory is allocated as necessary. |
|
Insert the tuple value at the ith location. Range checking is performed and memory allocates as necessary. |
|
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject. |
|
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject. |
|
Virtual constructor creates a field with the same number of data arrays and types of data arrays, but the arrays contain nothing. |
|
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkObject. |
|
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from vtkObject. |
|
Resets each data array in the field (Reset() does not release memory but it makes the arrays look like they are empty.) |
|
Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject. |
|
Set an array to define the field. |
|
Set/Get the name for an array of data. |
|
Set the component value at the ith tuple (or row) and jth component (or column). Range checking is not performed, so set the object up properly before invoking. |
|
Set the number of arrays used to define the field. |
|
Set the number of tuples for each data array in the field. |
|
Set the tuple value at the ith location. Set operations mean that no range checking is performed, so they're faster. |
|
Copy a field by reference counting the data arrays. |
|
Squeezes each data array in the field (Squeeze() reclaims unused memory.) |