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
|
<!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: vtkStructuredGrid</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('vtkfiltering_vtkstructuredgrid.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkStructuredGrid </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkfiltering.html">Visualization Toolkit Filtering Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>vtkStructuredGrid is a data object that is a concrete implementation of vtkDataSet. vtkStructuredGrid represents a geometric structure that is a topologically regular array of points. The topology is that of a cube that has been subdivided into a regular array of smaller cubes. Each point/cell can be addressed with i-j-k indices. Examples include finite difference grids.</p>
<p>The order and number of points must match that specified by the dimensions of the grid. The point order increases in i fastest (from 0<=i<dims[0]), then j (0<=j<dims[1]), then k (0<=k<dims[2]) where dims[] are the dimensions of the grid in the i-j-k topological directions. The number of points is dims[0]*dims[1]*dims[2]. The same is true for the cells of the grid. The order and number of cells must match that specified by the dimensions of the grid. The cell order increases in i fastest (from 0<=i<(dims[0]-1)), then j (0<=j<(dims[1]-1)), then k (0<=k<(dims[2]-1)) The number of cells is (dims[0]-1)*(dims[1]-1)*(dims[2]-1).</p>
<p>A unusual feature of vtkStructuredGrid is the ability to blank, or "turn-off" points and cells in the dataset. This is controlled by defining a "blanking array" whose values (0,1) specify whether a point should be blanked or not.</p>
<p>To create an instance of class vtkStructuredGrid, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkStructuredGrid
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkStructuredGrid 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 vtkStructuredGrid class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkStructuredGrid = obj.NewInstance ()</code> </li>
<li>
<code>vtkStructuredGrid = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>int = obj.GetDataObjectType ()</code> - Copy the geometric and topological structure of an input poly data object. </li>
<li>
<code>obj.CopyStructure (vtkDataSet ds)</code> - Copy the geometric and topological structure of an input poly data object. </li>
<li>
<code>vtkIdType = obj.GetNumberOfPoints ()</code> - Standard vtkDataSet API methods. See vtkDataSet for more information. </li>
<li>
<code>double = obj.GetPoint (vtkIdType ptId)</code> - Standard vtkDataSet API methods. See vtkDataSet for more information. </li>
<li>
<code>obj.GetPoint (vtkIdType ptId, double p[3])</code> - Standard vtkDataSet API methods. See vtkDataSet for more information. </li>
<li>
<code>vtkCell = obj.GetCell (vtkIdType cellId)</code> - Standard vtkDataSet API methods. See vtkDataSet for more information. </li>
<li>
<code>obj.GetCell (vtkIdType cellId, vtkGenericCell cell)</code> - Standard vtkDataSet API methods. See vtkDataSet for more information. </li>
<li>
<code>obj.GetCellBounds (vtkIdType cellId, double bounds[6])</code> - Standard vtkDataSet API methods. See vtkDataSet for more information. </li>
<li>
<code>int = obj.GetCellType (vtkIdType cellId)</code> - Standard vtkDataSet API methods. See vtkDataSet for more information. </li>
<li>
<code>vtkIdType = obj.GetNumberOfCells ()</code> - Standard vtkDataSet API methods. See vtkDataSet for more information. </li>
<li>
<code>obj.GetCellPoints (vtkIdType cellId, vtkIdList ptIds)</code> - Standard vtkDataSet API methods. See vtkDataSet for more information. </li>
<li>
<code>obj.GetPointCells (vtkIdType ptId, vtkIdList cellIds)</code> - Standard vtkDataSet API methods. See vtkDataSet for more information. </li>
<li>
<code>obj.Initialize ()</code> - Standard vtkDataSet API methods. See vtkDataSet for more information. </li>
<li>
<code>int = obj.GetMaxCellSize ()</code> - Standard vtkDataSet API methods. See vtkDataSet for more information. </li>
<li>
<code>obj.GetCellNeighbors (vtkIdType cellId, vtkIdList ptIds, vtkIdList cellIds)</code> - Standard vtkDataSet API methods. See vtkDataSet for more information. </li>
<li>
<code>obj.GetScalarRange (double range[2])</code> - Standard vtkDataSet API methods. See vtkDataSet for more information. </li>
<li>
<code>double = obj.GetScalarRange ()</code> - following methods are specific to structured grid </li>
<li>
<code>obj.SetDimensions (int i, int j, int k)</code> - following methods are specific to structured grid </li>
<li>
<code>obj.SetDimensions (int dim[3])</code> - following methods are specific to structured grid </li>
<li>
<code>int = obj.GetDimensions ()</code> - Get dimensions of this structured points dataset. </li>
<li>
<code>obj.GetDimensions (int dim[3])</code> - Get dimensions of this structured points dataset. </li>
<li>
<code>int = obj.GetDataDimension ()</code> - Return the dimensionality of the data. </li>
<li>
<code>obj.SetExtent (int extent[6])</code> - Different ways to set the extent of the data array. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). </li>
<li>
<code>obj.SetExtent (int x1, int x2, int y1, int y2, int z1, int z2)</code> - Different ways to set the extent of the data array. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). </li>
<li>
<code>int = obj. GetExtent ()</code> - Different ways to set the extent of the data array. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). </li>
<li>
<code>long = obj.GetActualMemorySize ()</code> - Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the return value). THIS METHOD IS THREAD SAFE. </li>
<li>
<code>obj.ShallowCopy (vtkDataObject src)</code> - Shallow and Deep copy. </li>
<li>
<code>obj.DeepCopy (vtkDataObject src)</code> - Shallow and Deep copy. </li>
<li>
<code>int = obj.GetExtentType ()</code> - Methods for supporting blanking of cells. Blanking turns on or off points in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set. </li>
<li>
<code>obj.BlankPoint (vtkIdType ptId)</code> - Methods for supporting blanking of cells. Blanking turns on or off points in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set. </li>
<li>
<code>obj.UnBlankPoint (vtkIdType ptId)</code> - Methods for supporting blanking of cells. Blanking turns on or off points in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set. </li>
<li>
<code>obj.BlankCell (vtkIdType ptId)</code> - Methods for supporting blanking of cells. Blanking turns on or off cells in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set. </li>
<li>
<code>obj.UnBlankCell (vtkIdType ptId)</code> - Methods for supporting blanking of cells. Blanking turns on or off cells in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set. </li>
<li>
<code>vtkUnsignedCharArray = obj.GetPointVisibilityArray ()</code> - Get the array that defines the blanking (visibility) of each point. </li>
<li>
<code>obj.SetPointVisibilityArray (vtkUnsignedCharArray pointVisibility)</code> - Set an array that defines the (blanking) visibility of the points in the grid. Make sure that length of the visibility array matches the number of points in the grid. </li>
<li>
<code>vtkUnsignedCharArray = obj.GetCellVisibilityArray ()</code> - Get the array that defines the blanking (visibility) of each cell. </li>
<li>
<code>obj.SetCellVisibilityArray (vtkUnsignedCharArray pointVisibility)</code> - Set an array that defines the (blanking) visibility of the cells in the grid. Make sure that length of the visibility array matches the number of points in the grid. </li>
<li>
<code>char = obj.IsPointVisible (vtkIdType ptId)</code> - Return non-zero value if specified point is visible. These methods should be called only after the dimensions of the grid are set. </li>
<li>
<code>char = obj.IsCellVisible (vtkIdType cellId)</code> - Return non-zero value if specified point is visible. These methods should be called only after the dimensions of the grid are set. </li>
<li>
<code>char = obj.GetPointBlanking ()</code> - Returns 1 if there is any visibility constraint on the points, 0 otherwise. </li>
<li>
<code>char = obj.GetCellBlanking ()</code> - Returns 1 if there is any visibility constraint on the cells, 0 otherwise. </li>
<li>
<code>obj.Crop ()</code> - Reallocates and copies to set the Extent to the UpdateExtent. This is used internally when the exact extent is requested, and the source generated more than the update extent. </li>
<li>
<code>obj.GetPoint (int i, int j, int k, double p[3], bool adjustForExtenttrue)</code> - Get a point in the grid. If adjustForExtent is true, (i,j,k) is interpreted as a position relative to the beginning of the extent. If adjustForExtent is false, (i,j,k) is interpreted literally and the (i,j,k) point of the grid is returned regardless of the extent beginning. The point coordinate is returned in 'p'. The default adjustForExtent is true. </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_vtkfiltering.html">Visualization Toolkit Filtering 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>
|
