#include <vtkFieldData.h>
Inheritance diagram for vtkFieldData:
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, double, 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. Also, each data array must have a character-string name. (This is used to manipulate data.)
There are two ways of manipulating and interfacing to fields. You can do it generically by manipulating components/tuples via a double-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.
Definition at line 54 of file vtkFieldData.h.
Public Types | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | Initialize () |
| int | Allocate (const vtkIdType sz, const vtkIdType ext=1000) |
| void | CopyStructure (vtkFieldData *) |
| vtkDataArray * | GetArray (int i) |
| virtual void | CopyAllOn () |
| virtual void | CopyAllOff () |
| virtual void | DeepCopy (vtkFieldData *da) |
| virtual void | ShallowCopy (vtkFieldData *da) |
| void | Squeeze () |
| void | Reset () |
| virtual unsigned long | GetActualMemorySize () |
| unsigned long int | GetMTime () |
| void | GetField (vtkIdList *ptId, vtkFieldData *f) |
| int | GetArrayContainingComponent (int i, int &arrayComp) |
| int | GetNumberOfComponents () |
| vtkIdType | GetNumberOfTuples () |
| void | SetNumberOfTuples (const vtkIdType number) |
| double * | GetTuple (const vtkIdType i) |
| void | GetTuple (const vtkIdType i, double *tuple) |
| void | SetTuple (const vtkIdType i, const double *tuple) |
| void | InsertTuple (const vtkIdType i, const double *tuple) |
| vtkIdType | InsertNextTuple (const double *tuple) |
| double | GetComponent (const vtkIdType i, const int j) |
| void | SetComponent (const vtkIdType i, const int j, const double c) |
| void | InsertComponent (const vtkIdType i, const int j, const double c) |
| void | AllocateArrays (int num) |
| int | GetNumberOfArrays () |
| int | AddArray (vtkDataArray *array) |
| virtual void | RemoveArray (const char *name) |
| vtkDataArray * | GetArray (const char *arrayName, int &index) |
| vtkDataArray * | GetArray (const char *arrayName) |
| int | HasArray (const char *name) |
| const char * | GetArrayName (int i) |
| virtual void | PassData (vtkFieldData *fd) |
| void | CopyFieldOn (const char *name) |
| void | CopyFieldOff (const char *name) |
Static Public Member Functions | |
| static vtkFieldData * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkFieldData * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkFieldData () | |
| ~vtkFieldData () | |
| void | SetArray (int i, vtkDataArray *array) |
| virtual void | RemoveArray (int index) |
| virtual void | InitializeFields () |
| void | CopyFieldOnOff (const char *name, int onOff) |
| void | ClearFieldFlags () |
| int | FindFlag (const char *field) |
| int | GetFlag (const char *field) |
| void | CopyFlags (const vtkFieldData *source) |
Protected Attributes | |
| int | NumberOfArrays |
| int | NumberOfActiveArrays |
| vtkDataArray ** | Data |
| int | TupleSize |
| double * | Tuple |
| CopyFieldFlag * | CopyFieldFlags |
| int | NumberOfFieldFlags |
| int | DoCopyAllOn |
| int | DoCopyAllOff |
Classes | |
| class | BasicIterator |
| struct | CopyFieldFlag |
| class | Iterator |
|
|
Reimplemented from vtkObject. Reimplemented in vtkCellData, vtkDataSetAttributes, and vtkPointData. Definition at line 59 of file vtkFieldData.h. |
|
|
|
|
|
|
|
|
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkObject. Reimplemented in vtkCellData, vtkDataSetAttributes, and vtkPointData. |
|
|
Reimplemented from vtkObject. Reimplemented in vtkCellData, vtkDataSetAttributes, and vtkPointData. |
|
|
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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkCellData, vtkDataSetAttributes, and vtkPointData. |
|
|
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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkCellData, vtkDataSetAttributes, and vtkPointData. |
|
|
Reimplemented from vtkObject. Reimplemented in vtkCellData, vtkDataSetAttributes, and vtkPointData. |
|
||||||||||||
|
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. Reimplemented in vtkCellData, vtkDataSetAttributes, and vtkPointData. |
|
|
Release all data but do not delete object. Also, clear the copy flags. Reimplemented in vtkDataSetAttributes. |
|
||||||||||||
|
Allocate data for each array. Note that ext is no longer used. |
|
|
Copy data array structure from a given field. The same arrays will exist with the same types, but will contain nothing in the copy. |
|
|
AllocateOfArrays actually sets the number of vtkDataArray pointers in the vtkFieldData object, not the number of used pointers (arrays). Adding more arrays will cause the object to dynamically adjust the number of pointers if it needs to extend. Although AllocateArrays can be used if the number of arrays which will be added is known, it can be omitted with a small computation cost. |
|
|
Get the number of arrays of data available. This does not include NULL array pointers therefore after fd->AllocateArray(n); nArrays = GetNumberOfArrays() nArrays is not necessarily equal to n. Definition at line 85 of file vtkFieldData.h. |
|
|
Add an array to the array list. If an array with the same name already exists - then the added array will replace it. |
|
|
Remove an array (with the given name) from the list of arrays. Reimplemented in vtkDataSetAttributes. Definition at line 97 of file vtkFieldData.h. |
|
|
Return the ith array in the field. A NULL is returned if the index i is out of range. |
|
||||||||||||
|
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. Definition at line 116 of file vtkFieldData.h. |
|
|
Return 1 if an array with the given name could be found. 0 otherwise. Definition at line 125 of file vtkFieldData.h. |
|
|
Get the name of ith array. Note that this is equivalent to: GetArray(i)->GetName() if ith array pointer is not NULL Definition at line 137 of file vtkFieldData.h. References vtkDataArray::GetName(). |
|
|
Pass entire arrays of input data through to output. Obey the "copy" flags. Reimplemented in vtkDataSetAttributes. |
|
|
Turn on/off the copying of the field specified by name. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array Definition at line 154 of file vtkFieldData.h. |
|
|
Pass entire arrays of input data through to output. Obey the "copy" flags. Definition at line 155 of file vtkFieldData.h. |
|
|
Turn on copying of all data. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array Reimplemented in vtkDataSetAttributes. |
|
|
Turn off copying of all data. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array Reimplemented in vtkDataSetAttributes. |
|
|
Copy a field by creating new data arrays (i.e., duplicate storage). Reimplemented in vtkDataSetAttributes. |
|
|
Copy a field by reference counting the data arrays. Reimplemented in vtkDataSetAttributes. |
|
|
Squeezes each data array in the field (Squeeze() reclaims unused memory.) |
|
|
Resets each data array in the field (Reset() does not release memory but it makes the arrays look like they are empty.) |
|
|
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. |
|
|
Check object's components for modified times. Reimplemented from vtkObject. |
|
||||||||||||
|
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 CopyStructure() creates). This method should not be used if the instance is from a subclass of vtkFieldData (vtkPointData or vtkCellData). This is because in those cases, the attribute data is stored with the other fields and will cause the method to behave in an unexpected way. |
|
||||||||||||
|
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. This method should not be used if the instance is from a subclass of vtkFieldData (vtkPointData or vtkCellData). This is because in those cases, the attribute data is stored with the other fields and will cause the method to behave in an unexpected way. |
|
|
Get the number of components in the field. This is determined by adding up the components in each non-NULL array. This method should not be used if the instance is from a subclass of vtkFieldData (vtkPointData or vtkCellData). This is because in those cases, the attribute data is stored with the other fields and will cause the method to behave in an unexpected way. |
|
|
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. This method should not be used if the instance is from a subclass of vtkFieldData (vtkPointData or vtkCellData). This is because in those cases, the attribute data is stored with the other fields and will cause the method to behave in an unexpected way. |
|
|
Set the number of tuples for each data array in the field. This method should not be used if the instance is from a subclass of vtkFieldData (vtkPointData or vtkCellData). This is because in those cases, the attribute data is stored with the other fields and will cause the method to behave in an unexpected way. |
|
|
Return a tuple consisting of a concatenation of all data from all the different arrays. Note that everything is converted to and from double values. This method should not be used if the instance is from a subclass of vtkFieldData (vtkPointData or vtkCellData). This is because in those cases, the attribute data is stored with the other fields and will cause the method to behave in an unexpected way. |
|
||||||||||||
|
Copy the ith tuple value into a user provided tuple array. Make sure that you've allocated enough space for the copy. This method should not be used if the instance is from a subclass of vtkFieldData (vtkPointData or vtkCellData). This is because in those cases, the attribute data is stored with the other fields and will cause the method to behave in an unexpected way. |
|
||||||||||||
|
Set the tuple value at the ith location. Set operations mean that no range checking is performed, so they're faster. This method should not be used if the instance is from a subclass of vtkFieldData (vtkPointData or vtkCellData). This is because in those cases, the attribute data is stored with the other fields and will cause the method to behave in an unexpected way. |
|
||||||||||||
|
Insert the tuple value at the ith location. Range checking is performed and memory allocates as necessary. This method should not be used if the instance is from a subclass of vtkFieldData (vtkPointData or vtkCellData). This is because in those cases, the attribute data is stored with the other fields and will cause the method to behave in an unexpected way. |
|
|
Insert the tuple value at the end of the tuple matrix. Range checking is performed and memory is allocated as necessary. This method should not be used if the instance is from a subclass of vtkFieldData (vtkPointData or vtkCellData). This is because in those cases, the attribute data is stored with the other fields and will cause the method to behave in an unexpected way. |
|
||||||||||||
|
Get the component value at the ith tuple (or row) and jth component (or column). This method should not be used if the instance is from a subclass of vtkFieldData (vtkPointData or vtkCellData). This is because in those cases, the attribute data is stored with the other fields and will cause the method to behave in an unexpected way. |
|
||||||||||||||||
|
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. This method should not be used if the instance is from a subclass of vtkFieldData (vtkPointData or vtkCellData). This is because in those cases, the attribute data is stored with the other fields and will cause the method to behave in an unexpected way. |
|
||||||||||||||||
|
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. This method should not be used if the instance is from a subclass of vtkFieldData (vtkPointData or vtkCellData). This is because in those cases, the attribute data is stored with the other fields and will cause the method to behave in an unexpected way. |
|
||||||||||||
|
Set an array to define the field. |
|
|
Reimplemented in vtkDataSetAttributes. |
|
|
Release all data but do not delete object. Reimplemented in vtkDataSetAttributes. |
|
||||||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Definition at line 308 of file vtkFieldData.h. |
|
|
Definition at line 309 of file vtkFieldData.h. |
|
|
Definition at line 310 of file vtkFieldData.h. |
|
|
Definition at line 312 of file vtkFieldData.h. |
|
|
Definition at line 313 of file vtkFieldData.h. |
|
|
Definition at line 331 of file vtkFieldData.h. |
|
|
Definition at line 332 of file vtkFieldData.h. |
|
|
Definition at line 338 of file vtkFieldData.h. |
|
|
Definition at line 339 of file vtkFieldData.h. |
1.4.3-20050530