vtkArrayCalculator Class Reference
#include <vtkArrayCalculator.h>
Inheritance diagram for vtkArrayCalculator:
[legend]Collaboration diagram for vtkArrayCalculator:
[legend]List of all members.
Detailed Description
perform mathematical operations on data in field data arrays
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:
standard operations: + - * / ^ .
access vector components: iHat, jHat, kHat
abs
acos
asin
atan
ceil
cos
cosh
exp
floor
log
mag
min
max
norm
sign
sin
sinh
sqrt
tan
tanh
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.
- See also:
- vtkFunctionParser
- Created by:
-
- CVS contributions (if > 5%):
-
- CVS logs (CVSweb):
/Graphics/vtkArrayCalculator.h)/Graphics/vtkArrayCalculator.cxx)
- Examples:
- vtkArrayCalculator (Examples)
- Tests:
- vtkArrayCalculator (Tests)
Definition at line 87 of file vtkArrayCalculator.h.
|
Public Types |
| typedef vtkDataSetToDataSetFilter | Superclass |
Public Member Functions |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| void | RemoveAllVariables () |
|
| void | SetFunction (const char *function) |
| virtual char * | GetFunction () |
|
| void | AddScalarArrayName (const char *arrayName, int component=0) |
| void | AddVectorArrayName (const char *arrayName, int component0=0, int component1=1, int component2=2) |
|
| void | AddScalarVariable (const char *variableName, const char *arrayName, int component=0) |
| void | AddVectorVariable (const char *variableName, const char *arrayName, int component0=0, int component1=1, int component2=2) |
|
| void | SetResultArrayName (const char *name) |
| virtual char * | GetResultArrayName () |
|
| virtual void | SetAttributeMode (int) |
| virtual int | GetAttributeMode () |
| void | SetAttributeModeToDefault () |
| void | SetAttributeModeToUsePointData () |
| void | SetAttributeModeToUseCellData () |
| const char * | GetAttributeModeAsString () |
|
| char ** | GetScalarArrayNames () |
| char * | GetScalarArrayName (int i) |
| char ** | GetVectorArrayNames () |
| char * | GetVectorArrayName (int i) |
| char ** | GetScalarVariableNames () |
| char * | GetScalarVariableName (int i) |
| char ** | GetVectorVariableNames () |
| char * | GetVectorVariableName (int i) |
| int * | GetSelectedScalarComponents () |
| int | GetSelectedScalarComponent (int i) |
| int ** | GetSelectedVectorComponents () |
| int * | GetSelectedVectorComponents (int i) |
| virtual int | GetNumberOfScalarArrays () |
| virtual int | GetNumberOfVectorArrays () |
Static Public Member Functions |
| int | IsTypeOf (const char *type) |
| vtkArrayCalculator * | SafeDownCast (vtkObject *o) |
| vtkArrayCalculator * | New () |
Protected Member Functions |
| | vtkArrayCalculator () |
| | ~vtkArrayCalculator () |
| void | Execute () |
Protected Attributes |
| char * | Function |
| char * | ResultArrayName |
| char ** | ScalarArrayNames |
| char ** | VectorArrayNames |
| char ** | ScalarVariableNames |
| char ** | VectorVariableNames |
| int | NumberOfScalarArrays |
| int | NumberOfVectorArrays |
| int | AttributeMode |
| int * | SelectedScalarComponents |
| int ** | SelectedVectorComponents |
| vtkFunctionParser * | FunctionParser |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkArrayCalculator::vtkArrayCalculator |
( |
|
) |
[protected] |
|
Member Function Documentation
| virtual const char* vtkArrayCalculator::GetClassName |
( |
|
) |
[virtual] |
|
| int vtkArrayCalculator::IsTypeOf |
( |
const char * |
type |
) |
[static] |
|
|
|
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkDataSetToDataSetFilter. |
| virtual int vtkArrayCalculator::IsA |
( |
const char * |
type |
) |
[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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkDataSetToDataSetFilter. |
| void vtkArrayCalculator::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
[virtual] |
|
|
|
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkDataSetToDataSetFilter. |
|
|
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkAlgorithm. |
| void vtkArrayCalculator::SetFunction |
( |
const char * |
function |
) |
|
|
|
|
Set/Get the function to be evaluated. |
| virtual char* vtkArrayCalculator::GetFunction |
( |
|
) |
[virtual] |
|
|
|
Set/Get the function to be evaluated. |
| void vtkArrayCalculator::AddScalarArrayName |
( |
const char * |
arrayName, |
|
|
int |
component = 0 |
|
) |
|
|
|
|
Add an array name to the list of arrays used in the function and specify which components of the array to use in evaluating the function. The array name must match the name in the function. Use AddScalarVariable or AddVectorVariable to use a variable name different from the array name. |
| void vtkArrayCalculator::AddVectorArrayName |
( |
const char * |
arrayName, |
|
|
int |
component0 = 0, |
|
|
int |
component1 = 1, |
|
|
int |
component2 = 2 |
|
) |
|
|
|
|
Add an array name to the list of arrays used in the function and specify which components of the array to use in evaluating the function. The array name must match the name in the function. Use AddScalarVariable or AddVectorVariable to use a variable name different from the array name. |
| void vtkArrayCalculator::AddScalarVariable |
( |
const char * |
variableName, |
|
|
const char * |
arrayName, |
|
|
int |
component = 0 |
|
) |
|
|
|
|
Add a variable name, a corresponding array name, and which components of the array to use. |
| void vtkArrayCalculator::AddVectorVariable |
( |
const char * |
variableName, |
|
|
const char * |
arrayName, |
|
|
int |
component0 = 0, |
|
|
int |
component1 = 1, |
|
|
int |
component2 = 2 |
|
) |
|
|
|
|
Add a variable name, a corresponding array name, and which components of the array to use. |
| void vtkArrayCalculator::SetResultArrayName |
( |
const char * |
name |
) |
|
|
|
|
Set the name of the array in which to store the result of evaluating this function. If this is the name of an existing array, that array will be overwritten. Otherwise a new array will be created with the specified name. |
| virtual char* vtkArrayCalculator::GetResultArrayName |
( |
|
) |
[virtual] |
|
|
|
Set the name of the array in which to store the result of evaluating this function. If this is the name of an existing array, that array will be overwritten. Otherwise a new array will be created with the specified name. |
| virtual void vtkArrayCalculator::SetAttributeMode |
( |
int |
|
) |
[virtual] |
|
|
|
Control whether the filter operates on point data or cell data. By default (AttributeModeToDefault), the filter uses point data. Alternatively you can explicitly set the filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData). |
| virtual int vtkArrayCalculator::GetAttributeMode |
( |
|
) |
[virtual] |
|
|
|
Control whether the filter operates on point data or cell data. By default (AttributeModeToDefault), the filter uses point data. Alternatively you can explicitly set the filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData). |
| void vtkArrayCalculator::SetAttributeModeToDefault |
( |
|
) |
[inline] |
|
|
|
Control whether the filter operates on point data or cell data. By default (AttributeModeToDefault), the filter uses point data. Alternatively you can explicitly set the filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData).
Definition at line 139 of file vtkArrayCalculator.h.
References VTK_ATTRIBUTE_MODE_DEFAULT. |
| void vtkArrayCalculator::SetAttributeModeToUsePointData |
( |
|
) |
[inline] |
|
|
|
Control whether the filter operates on point data or cell data. By default (AttributeModeToDefault), the filter uses point data. Alternatively you can explicitly set the filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData).
Definition at line 141 of file vtkArrayCalculator.h.
References VTK_ATTRIBUTE_MODE_USE_POINT_DATA. |
| void vtkArrayCalculator::SetAttributeModeToUseCellData |
( |
|
) |
[inline] |
|
|
|
Control whether the filter operates on point data or cell data. By default (AttributeModeToDefault), the filter uses point data. Alternatively you can explicitly set the filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData).
Definition at line 143 of file vtkArrayCalculator.h.
References VTK_ATTRIBUTE_MODE_USE_CELL_DATA. |
| const char* vtkArrayCalculator::GetAttributeModeAsString |
( |
|
) |
|
|
|
|
Control whether the filter operates on point data or cell data. By default (AttributeModeToDefault), the filter uses point data. Alternatively you can explicitly set the filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData). |
| void vtkArrayCalculator::RemoveAllVariables |
( |
|
) |
|
|
|
|
Remove all the variable names and their associated array names. |
| char** vtkArrayCalculator::GetScalarArrayNames |
( |
|
) |
[inline] |
|
| char* vtkArrayCalculator::GetScalarArrayName |
( |
int |
i |
) |
|
|
|
|
Methods to get information about the current variables. |
| char** vtkArrayCalculator::GetVectorArrayNames |
( |
|
) |
[inline] |
|
| char* vtkArrayCalculator::GetVectorArrayName |
( |
int |
i |
) |
|
|
|
|
Methods to get information about the current variables. |
| char** vtkArrayCalculator::GetScalarVariableNames |
( |
|
) |
[inline] |
|
| char* vtkArrayCalculator::GetScalarVariableName |
( |
int |
i |
) |
|
|
|
|
Methods to get information about the current variables. |
| char** vtkArrayCalculator::GetVectorVariableNames |
( |
|
) |
[inline] |
|
| char* vtkArrayCalculator::GetVectorVariableName |
( |
int |
i |
) |
|
|
|
|
Methods to get information about the current variables. |
| int* vtkArrayCalculator::GetSelectedScalarComponents |
( |
|
) |
[inline] |
|
| int vtkArrayCalculator::GetSelectedScalarComponent |
( |
int |
i |
) |
|
|
|
|
Methods to get information about the current variables. |
| int** vtkArrayCalculator::GetSelectedVectorComponents |
( |
|
) |
[inline] |
|
| int* vtkArrayCalculator::GetSelectedVectorComponents |
( |
int |
i |
) |
|
|
|
|
Methods to get information about the current variables. |
| virtual int vtkArrayCalculator::GetNumberOfScalarArrays |
( |
|
) |
[virtual] |
|
|
|
Methods to get information about the current variables. |
| virtual int vtkArrayCalculator::GetNumberOfVectorArrays |
( |
|
) |
[virtual] |
|
|
|
Methods to get information about the current variables. |
| void vtkArrayCalculator::Execute |
( |
|
) |
[protected, virtual] |
|
|
|
This method is the old style execute method
Reimplemented from vtkSource. |
Member Data Documentation
The documentation for this class was generated from the following file: