1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>FreeMat: vtkArrayCalculator</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FreeMat
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('vtkgraphics_vtkarraycalculator.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkArrayCalculator </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkgraphics.html">Visualization Toolkit Graphics Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>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.</p>
<p>The functions that this array calculator understands is: </p>
<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><p> 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.</p>
<p>To create an instance of class vtkArrayCalculator, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkArrayCalculator
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>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, <code>obj</code> is an instance of the vtkArrayCalculator class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkArrayCalculator = obj.NewInstance ()</code> </li>
<li>
<code>vtkArrayCalculator = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>obj.SetFunction (string function)</code> - Set/Get the function to be evaluated. </li>
<li>
<code>string = obj.GetFunction ()</code> - Set/Get the function to be evaluated. </li>
<li>
<code>obj.AddScalarArrayName (string arrayName, int component)</code> - 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. </li>
<li>
<code>obj.AddVectorArrayName (string arrayName, int component0, int component1, int component2)</code> - 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. </li>
<li>
<code>obj.AddScalarVariable (string variableName, string arrayName, int component)</code> - Add a variable name, a corresponding array name, and which components of the array to use. </li>
<li>
<code>obj.AddVectorVariable (string variableName, string arrayName, int component0, int component1, int component2)</code> - Add a variable name, a corresponding array name, and which components of the array to use. </li>
<li>
<code>obj.AddCoordinateScalarVariable (string variableName, int component)</code> - Add a variable name, a corresponding array name, and which components of the array to use. </li>
<li>
<code>obj.AddCoordinateVectorVariable (string variableName, int component0, int component1, int component2)</code> - Add a variable name, a corresponding array name, and which components of the array to use. </li>
<li>
<code>obj.SetResultArrayName (string name)</code> - 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. </li>
<li>
<code>string = obj.GetResultArrayName ()</code> - 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. </li>
<li>
<code>int = obj.GetResultArrayType ()</code> - Type of the result array. It is ignored if CoordinateResults is true. Initial value is VTK_DOUBLE. </li>
<li>
<code>obj.SetResultArrayType (int )</code> - Type of the result array. It is ignored if CoordinateResults is true. Initial value is VTK_DOUBLE. </li>
<li>
<code>int = obj.GetCoordinateResults ()</code> - Set whether to output results as coordinates. ResultArrayName will be ignored. Outputing as coordinates is only valid with vector results and if the AttributeMode is AttributeModeToUsePointData. If a valid output can't be made, an error will occur. </li>
<li>
<code>obj.SetCoordinateResults (int )</code> - Set whether to output results as coordinates. ResultArrayName will be ignored. Outputing as coordinates is only valid with vector results and if the AttributeMode is AttributeModeToUsePointData. If a valid output can't be made, an error will occur. </li>
<li>
<code>obj.CoordinateResultsOn ()</code> - Set whether to output results as coordinates. ResultArrayName will be ignored. Outputing as coordinates is only valid with vector results and if the AttributeMode is AttributeModeToUsePointData. If a valid output can't be made, an error will occur. </li>
<li>
<code>obj.CoordinateResultsOff ()</code> - Set whether to output results as coordinates. ResultArrayName will be ignored. Outputing as coordinates is only valid with vector results and if the AttributeMode is AttributeModeToUsePointData. If a valid output can't be made, an error will occur. </li>
<li>
<code>obj.SetAttributeMode (int )</code> - 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). For graphs you can set the filter to use vertex data (AttributeModeToUseVertexData) or edge data (AttributeModeToUseEdgeData). </li>
<li>
<code>int = obj.GetAttributeMode ()</code> - 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). For graphs you can set the filter to use vertex data (AttributeModeToUseVertexData) or edge data (AttributeModeToUseEdgeData). </li>
<li>
<code>obj.SetAttributeModeToDefault ()</code> - 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). For graphs you can set the filter to use vertex data (AttributeModeToUseVertexData) or edge data (AttributeModeToUseEdgeData). </li>
<li>
<code>obj.SetAttributeModeToUsePointData ()</code> - 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). For graphs you can set the filter to use vertex data (AttributeModeToUseVertexData) or edge data (AttributeModeToUseEdgeData). </li>
<li>
<code>obj.SetAttributeModeToUseCellData ()</code> - 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). For graphs you can set the filter to use vertex data (AttributeModeToUseVertexData) or edge data (AttributeModeToUseEdgeData). </li>
<li>
<code>obj.SetAttributeModeToUseVertexData ()</code> - 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). For graphs you can set the filter to use vertex data (AttributeModeToUseVertexData) or edge data (AttributeModeToUseEdgeData). </li>
<li>
<code>obj.SetAttributeModeToUseEdgeData ()</code> - 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). For graphs you can set the filter to use vertex data (AttributeModeToUseVertexData) or edge data (AttributeModeToUseEdgeData). </li>
<li>
<code>string = obj.GetAttributeModeAsString ()</code> - 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). For graphs you can set the filter to use vertex data (AttributeModeToUseVertexData) or edge data (AttributeModeToUseEdgeData). </li>
<li>
<code>obj.RemoveAllVariables ()</code> - Remove all the variable names and their associated array names. </li>
<li>
<code>obj.RemoveScalarVariables ()</code> - Remove all the scalar variable names and their associated array names. </li>
<li>
<code>obj.RemoveVectorVariables ()</code> - Remove all the scalar variable names and their associated array names. </li>
<li>
<code>obj.RemoveCoordinateScalarVariables ()</code> - Remove all the coordinate variables. </li>
<li>
<code>obj.RemoveCoordinateVectorVariables ()</code> - Remove all the coordinate variables. </li>
<li>
<code>string = obj.GetScalarArrayName (int i)</code> - Methods to get information about the current variables. </li>
<li>
<code>string = obj.GetVectorArrayName (int i)</code> - Methods to get information about the current variables. </li>
<li>
<code>string = obj.GetScalarVariableName (int i)</code> - Methods to get information about the current variables. </li>
<li>
<code>string = obj.GetVectorVariableName (int i)</code> - Methods to get information about the current variables. </li>
<li>
<code>int = obj.GetSelectedScalarComponent (int i)</code> - Methods to get information about the current variables. </li>
<li>
<code>int = obj.GetNumberOfScalarArrays ()</code> - Methods to get information about the current variables. </li>
<li>
<code>int = obj.GetNumberOfVectorArrays ()</code> - Methods to get information about the current variables. </li>
<li>
<code>obj.SetReplaceInvalidValues (int )</code> - When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported </li>
<li>
<code>int = obj.GetReplaceInvalidValues ()</code> - When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported </li>
<li>
<code>obj.ReplaceInvalidValuesOn ()</code> - When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported </li>
<li>
<code>obj.ReplaceInvalidValuesOff ()</code> - When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported </li>
<li>
<code>obj.SetReplacementValue (double )</code> - When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported </li>
<li>
<code>double = obj.GetReplacementValue ()</code> - When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported </li>
</ul>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="index.html">FreeMat Documentation</a></li><li class="navelem"><a class="el" href="sec_vtkgraphics.html">Visualization Toolkit Graphics Classes</a></li>
<li class="footer">Generated on Thu Jul 25 2013 17:18:31 for FreeMat by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
</ul>
</div>
</body>
</html>
|
