source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/TRIANGULATION/definetri_e.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 6.0 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>definetri_e.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="definetri.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="dessinetri.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_e.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64
65
66
67 Define a triangulation array like TRIANGULATE but for a
68 E-grid type
69
70
71   
72    <h2>Routine summary</h2>
73
74    <dl>
75     
76      <dt><a href="#_numtri"><i>result = </i>numtri(<i>index, nx, ny</i>)</a><dt>
77      <dd><font size="-1"></font></dd>
78     
79      <dt><a href="#_definetri_e"><i>result = </i>definetri_e(<i>nx, ny[, singular]</i>, SHIFTED=<i>SHIFTED</i>)</a><dt>
80      <dd><font size="-1"> </font></dd>
81     
82    </dl>
83
84    <p>&nbsp;</p>
85   
86
87     
88      <a name="#_numtri"></a>
89
90      <h2>numtri  <font size="-1" color="#006633">
91
92</font></h2>
93
94      <p><font face="Courier"><i>result = </i>numtri(<i><a href="#_numtri_keyword_index">index</a>, <a href="#_numtri_keyword_nx">nx</a>, <a href="#_numtri_keyword_ny">ny</a></i>)</font></p>
95
96   
97
98    <h3>Return value</h3>
99
100
101
102   
103    <h3>Parameters</h3>
104   
105
106    <a name="#_numtri_keyword_index"></a>
107    <h4>index&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
108     
109     
110     
111     
112     
113     
114     
115     
116    </h4>
117
118   
119 It is the tick mark index which starts at 0.
120
121   
122
123    <a name="#_numtri_keyword_nx"></a>
124    <h4>nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125      <font size="-1" color="#006633">in</font>
126     
127     
128      <font size="-1" color="#006633">required</font>
129     
130     
131     
132     
133    </h4>
134
135   
136 The x dimension array
137
138   
139
140    <a name="#_numtri_keyword_ny"></a>
141    <h4>ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
142      <font size="-1" color="#006633">in</font>
143     
144     
145      <font size="-1" color="#006633">required</font>
146     
147     
148     
149     
150    </h4>
151
152   
153 The y dimension array
154
155
156   
157   
158
159   
160
161    <h3>Examples</h3>
162 
163 
164    <h3>Version history</h3>
165   
166    <h4>Version</h4>
167 $Id: definetri_e.pro 157 2006-08-21 09:01:50Z navarro $
168    <h4>History</h4>
169
170
171   
172
173    <h3>Known issues</h3>
174   
175   
176   
177    <h4>Restrictions</h4>
178 
179 
180
181   
182   
183   
184   
185   
186   
187   
188
189    <font size="-3"><p>&nbsp;</p></font>
190    <hr size="1" color="#CCCCCC"/>
191     
192      <a name="#_definetri_e"></a>
193
194      <h2>definetri_e  <font size="-1" color="#006633">
195 Make contours with E-grid type
196 </font></h2>
197
198      <p><font face="Courier"><i>result = </i>definetri_e(<i><a href="#_definetri_e_keyword_nx">nx</a>, <a href="#_definetri_e_keyword_ny">ny</a>[, <a href="#_definetri_e_keyword_singular">singular</a>]</i>, <a href="#_definetri_e_keyword_SHIFTED">SHIFTED</a>=<i>SHIFTED</i>)</font></p>
199
200   
201
202
203    <h3>Return value</h3>
204 Triangles is a 2d array and is dimensions are 3 and
205 (nx-1)*(ny-1)
206 Triangles is defined like in the TRIANGULATE procedure.
207       
208
209   
210    <h3>Parameters</h3>
211   
212
213    <a name="#_definetri_e_keyword_nx"></a>
214    <h4>nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
215      <font size="-1" color="#006633">in</font>
216     
217     
218      <font size="-1" color="#006633">required</font>
219     
220     
221     
222     
223    </h4>
224
225   
226 The x dimension array
227
228   
229
230    <a name="#_definetri_e_keyword_ny"></a>
231    <h4>ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
232      <font size="-1" color="#006633">in</font>
233     
234     
235      <font size="-1" color="#006633">required</font>
236     
237     
238     
239     
240    </h4>
241
242   
243 The y dimension array
244
245   
246
247    <a name="#_definetri_e_keyword_singular"></a>
248    <h4>singular&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
249      <font size="-1" color="#006633">in</font>
250     
251      <font size="-1" color="#006633">optional</font>
252     
253     
254     
255     
256     
257    </h4>
258
259   
260 When singular is undefined all rectangles are cut
261 in using the vertical diagonal. Singular is a vector which
262 contains the rectangles numbers which are cut in using the
263 horizontal diagonal.
264 The rectangle number is define by the index (in a nx*ny
265 vector) of the lower-left corner of the rectangle.
266
267   
268   
269
270   
271    <h3>Keywords</h3>
272
273   
274    <a name="#_definetri_e_keyword_SHIFTED"></a>
275    <h4>SHIFTED&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
276     
277     
278     
279     
280     
281     
282     
283     
284    </h4>
285
286   
287
288
289   
290   
291
292   
293    <h3>Version history</h3>
294   
295    <h4>Version</h4>
296 $Id: definetri_e.pro 157 2006-08-21 09:01:50Z navarro $
297
298    <h4>History</h4>
299 Sebastien Masson (smlod@ipsl.jussieu.fr)
300                       June 2001
301
302   
303
304    <h3>Known issues</h3>
305   
306   
307    <h4>Todo items</h4> 
308 seb: documenter SHIFTED
309   
310
311   
312   
313   
314   
315   
316   
317   
318
319    <font size="-3"><p>&nbsp;</p></font>
320    <hr size="1" color="#CCCCCC"/>
321     
322
323   
324
325    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:50:35 2006.</font></p>
326
327  </body>
328</html>
Note: See TracBrowser for help on using the repository browser.