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

Last change on this file since 321 was 321, checked in by smasson, 17 years ago

update documentation
File size: 5.2 KB
RevLine 
[163]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   
[290]64 Define a triangulation array like <a href="/Applications/rsi/idl_6.3/help/online_help/TRIANGULATE.html">TRIANGULATE</a>.
[163]65         But in a VERY SIMPLE CASE:
[321]66 the points are regularly-gridded on nx*ny array.
[163]67 Find a Delaunay triangulation for this set of points is easy:
[234]68 Points define (nx-1)*(ny-1) rectangles which we can cut in 2 triangles.
[187]69 cf. figure above
[163]70
[191]71<pre>
[187]72 fixe
[163]73      ny-1*---*---*. . . . . .*---*---*
[234]74          |  +|  +|           |  +|  +|
[163]75          | + | + |           | + | + |
76          |+  |+  |           |+  |+  |
[234]77      ny-2*---*---*. . . . . .*---*---*
[163]78          .       .           .       .
79          .       .           .       .
80          .       .           .       .
81         1*---*---*. . . . . .*---*---*
82          |  +|  +|           |  +|  +|
83          | + | + |           | + | + |
84          |+  |+  |           |+  |+  |
[234]85         0*---*---*. . . . . .*---*---*
[163]86           0   1   2        nx-3  nx-2 nx-1
87</pre>
88
89  You have 2 ways to cut a rectangle:
90      1) the upward diagonal       2) the downward diagonal
91
[191]92<pre>
[163]93          *---*                        *---*
94          |  +|                        |+  |
95          | + |                        | + |
96          |+  |                        |  +|
[234]97          *---*                        *---*
[163]98</pre>
99
100
101   
102
103     
104      <a name="#_definetri"></a>
105
106      <h2>definetri  <font size="-1" color="#006633">
107 Utilities
[234]108</font></h2>
[163]109
110      <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>
111
112   
113
114
115    <h3>Return value</h3>
[187]116 triangles is a 2d array and its dimensions are 3 and 2*(nx-1)*(ny-1).
117 triangles is defined like in the TRIANGULATE procedure.
[163]118
119
120   
121    <h3>Parameters</h3>
122   
123
124    <a name="#_definetri_keyword_nx"></a>
125    <h4>nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126      <font size="-1" color="#006633">in</font>
127     
128     
129      <font size="-1" color="#006633">required</font>
130     
131     
132     
133     
134    </h4>
135
136   
137 The x dimension array
138
139   
140
141    <a name="#_definetri_keyword_ny"></a>
142    <h4>ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143      <font size="-1" color="#006633">in</font>
144     
145     
146      <font size="-1" color="#006633">required</font>
147     
148     
149     
150     
151    </h4>
152
153   
154 The y dimension array
155
156   
157
158    <a name="#_definetri_keyword_downward"></a>
159    <h4>downward&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
160      <font size="-1" color="#006633">in</font>
161     
162      <font size="-1" color="#006633">optional</font>
163     
164     
165     
166     
167     
168    </h4>
169
170   
[234]171 When DOWNWARD is undefined all rectangles are cut in using the upward
172 diagonal.
173 DOWNWARD is a vector which contains the rectangles numbers which are cut in
[187]174 using the downward diagonal.
[234]175 The rectangle number is defined by the index (in a nx*ny vector) of the
[187]176 lower-left corner of the rectangle.
[163]177
178   
179   
180
181   
182
[234]183    <h3>Examples</h3><pre>
[163]184
[187]185 IDL> triangles=definetri(3,3,[1,3])
186 triangles will be this kind of triangulation:
[163]187
188          *---*---*
[187]189          |+  |  +|
190          | + | + |
191          |  +|+  |
[163]192          *---*---*
[187]193          |  +|+  |
194          | + | + |
195          |+  |  +|
[163]196          *---*---*
197
198
[234]199    </pre><h3>Version history</h3>
[163]200   
201    <h4>Version</h4>
[321]202 $Id: definetri.pro 297 2007-09-25 15:09:12Z pinsard $
[163]203    <h4>History</h4>
204 sebastien Masson (smlod@ipsl.jussieu.fr)
205                       4/3/1999
206
207   
208
209   
210   
211   
212   
213   
214
215   
216   
217   
218   
219   
220   
221   
222
223    <font size="-3"><p>&nbsp;</p></font>
224    <hr size="1" color="#CCCCCC"/>
225     
226
227   
228
[187]229    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
[163]230
231  </body>
[249]232</html>
Note: See TracBrowser for help on using the repository browser.