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

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

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