source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/TRIANGULATION/definetri.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 5.2 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>definetri.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="completecointerre.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="definetri_e.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/TRIANGULATION/</font></h1>
58    <h2>definetri.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Define a triangulation array like <a href="/Applications/itt/idl64/help/online_help/TRIANGULATE.html">TRIANGULATE</a>.
65
66 But in a VERY SIMPLE CASE:
67 the points are regularly-gridded on nx*ny array.
68 Find a Delaunay triangulation for this set of points is easy:
69 Points define (nx-1)*(ny-1) rectangles which we can cut in 2 triangles.
70
71 cf. figure above
72
73<pre>
74      ny-1*---*---*. . . . . .*---*---*
75          |  +|  +|           |  +|  +|
76          | + | + |           | + | + |
77          |+  |+  |           |+  |+  |
78      ny-2*---*---*. . . . . .*---*---*
79          .       .           .       .
80          .       .           .       .
81          .       .           .       .
82         1*---*---*. . . . . .*---*---*
83          |  +|  +|           |  +|  +|
84          | + | + |           | + | + |
85          |+  |+  |           |+  |+  |
86         0*---*---*. . . . . .*---*---*
87           0   1   2        nx-3  nx-2 nx-1
88</pre>
89
90  You have 2 ways to cut a rectangle:
91      1) the upward diagonal       2) the downward diagonal
92
93<pre>
94          *---*                        *---*
95          |  +|                        |+  |
96          | + |                        | + |
97          |+  |                        |  +|
98          *---*                        *---*
99</pre>
100
101
102   
103
104     
105      <a name="#_definetri"></a>
106
107      <h2>definetri  <font size="-1" color="#006633">
108 Utilities
109</font></h2>
110
111      <p><font face="Courier"><i>result = </i>definetri(<i><a href="#_definetri_keyword_nx">nx</a>, <a href="#_definetri_keyword_ny">ny</a>[, <a href="#_definetri_keyword_downward">downward</a>]</i>)</font></p>
112
113   
114
115
116    <h3>Return value</h3>
117 triangles is a 2d array and its dimensions are 3 and 2*(nx-1)*(ny-1).
118 triangles is defined like in the TRIANGULATE procedure.
119
120
121   
122    <h3>Parameters</h3>
123   
124
125    <a name="#_definetri_keyword_nx"></a>
126    <h4>nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
127      <font size="-1" color="#006633">in</font>
128     
129     
130      <font size="-1" color="#006633">required</font>
131     
132     
133     
134     
135    </h4>
136
137   
138 The x dimension array
139
140   
141
142    <a name="#_definetri_keyword_ny"></a>
143    <h4>ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
144      <font size="-1" color="#006633">in</font>
145     
146     
147      <font size="-1" color="#006633">required</font>
148     
149     
150     
151     
152    </h4>
153
154   
155 The y dimension array
156
157   
158
159    <a name="#_definetri_keyword_downward"></a>
160    <h4>downward&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
161      <font size="-1" color="#006633">in</font>
162     
163      <font size="-1" color="#006633">optional</font>
164     
165     
166     
167     
168     
169    </h4>
170
171   
172 When downward is undefined all rectangles are cut in using the upward
173 diagonal.
174 downward is a vector which contains the rectangles numbers which are cut in
175 using the downward diagonal.
176 The rectangle number is defined by the index (in a nx*ny vector) of the
177 lower-left corner of the rectangle.
178
179   
180   
181
182   
183
184    <h3>Examples</h3><pre>
185
186 IDL> triangles=definetri(3,3,[1,3])
187
188 triangles will be this kind of triangulation:
189
190<pre>
191          *---*---*
192          |+  |  +|
193          | + | + |
194          |  +|+  |
195          *---*---*
196          |  +|+  |
197          | + | + |
198          |+  |  +|
199          *---*---*
200
201<pre>
202
203    </pre><h3>Version history</h3>
204   
205    <h4>Version</h4>
206 $Id: definetri.pro 325 2007-12-06 10:04:53Z pinsard $
207    <h4>History</h4>
208 sebastien Masson (smlod@ipsl.jussieu.fr)
209                       4/3/1999
210
211   
212
213   
214   
215   
216   
217   
218
219   
220   
221   
222   
223   
224   
225   
226
227    <font size="-3"><p>&nbsp;</p></font>
228    <hr size="1" color="#CCCCCC"/>
229     
230
231   
232
233    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
234
235  </body>
236</html>
Note: See TracBrowser for help on using the repository browser.