vtkArrayCalculator

Section: Visualization Toolkit Graphics Classes

Usage

vtkArrayCalculator performs operations on vectors or scalars in field data arrays. It uses vtkFunctionParser to do the parsing and to evaluate the function for each entry in the input arrays. The arrays used in a given function must be all in point data or all in cell data. The resulting array will be stored as a field data array. The result array can either be stored in a new array or it can overwrite an existing array.

The functions that this array calculator understands is: <pre> standard operations: + - * / ^ . build unit vectors: iHat, jHat, kHat (ie (1,0,0), (0,1,0), (0,0,1)) abs acos asin atan ceil cos cosh exp floor log mag min max norm sign sin sinh sqrt tan tanh </pre> Note that some of these operations work on scalars, some on vectors, and some on both (e.g., you can multiply a scalar times a vector). The operations are performed tuple-wise (i.e., tuple-by-tuple). The user must specify which arrays to use as vectors and/or scalars, and the name of the output data array.

To create an instance of class vtkArrayCalculator, simply invoke its constructor as follows

  obj = vtkArrayCalculator

Methods

The class vtkArrayCalculator has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, obj is an instance of the vtkArrayCalculator class.