source: trunk/SRC/Documentation/idldoc_html_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: 7.8 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>definetri_e.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="definetri_e.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../ToBeReviewed/TRIANGULATION//definetri_e.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="definetri.html">&lt;&lt;prev file</a> | <a href="dessinetri.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="definetri_e.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/TRIANGULATION/</a></h1>
82      <h2 class="pro_file">definetri_e.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90
91
92 Define a triangulation array like <a href="/Applications/rsi/idl_6.3/help/online_help/TRIANGULATE.html">TRIANGULATE</a> but for a
93 E-grid type
94</div>
95
96     
97
98     
99
100     
101
102     
103      <div id="routine_summary">               
104        <h2>Routine summary</h2>
105       
106        <dl>
107         
108          <dt><p><a href="#_numtri"><span class="result">result = </span>numtri(<span class="result">index, nx, ny</span>)</a></p><dt>
109          <dd> </dd>   
110         
111          <dt><p><a href="#_definetri_e"><span class="result">result = </span>definetri_e(<span class="result">nx, ny[, singular]</span>, SHIFTED=<span class="result">SHIFTED</span>)</a></p><dt>
112          <dd> </dd>   
113               
114        </dl>
115      </div>
116     
117
118      <div id="routine_details">
119       
120
121        <div class="routine_details" id="_numtri">
122
123          <h2><a class="top" href="#container">top</a>numtri <span class="categories">
124</span></h2>
125       
126          <p class="header">
127            <span class="result">result = </span>numtri(<span class="result"><a href="#_numtri_param_index">index</a>, <a href="#_numtri_param_nx">nx</a>, <a href="#_numtri_param_ny">ny</a></span>)</p>
128       
129          <div class="comments">
130</div>
131
132          <h3>Return value</h3><div class="preformat">
133</div>
134
135         
136            <h3>Parameters</h3>
137       
138           
139            <h4 id="_numtri_param_index">index&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
140             
141             
142             
143             
144             
145             
146             
147             
148            </h4>
149       
150          <div class="comments">
151 It is the tick mark index which starts at 0.
152</div>
153           
154            <h4 id="_numtri_param_nx">nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
155              <span class="attr">in</span>
156             
157             
158              <span class="attr">required</span>
159             
160             
161             
162             
163            </h4>
164       
165          <div class="comments">
166 The x dimension array
167</div>
168           
169            <h4 id="_numtri_param_ny">ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
170              <span class="attr">in</span>
171             
172             
173              <span class="attr">required</span>
174             
175             
176             
177             
178            </h4>
179       
180          <div class="comments">
181 The y dimension array
182</div>
183           
184
185         
186
187         
188
189          <h3>Examples</h3><div class="preformat">
190</div>
191          <h3>Version history</h3>
192         
193          <h4>Version</h4><div class="preformat">
194 $Id: definetri_e.pro 262 2007-08-21 14:19:32Z pinsard $</div>
195          <h4>History</h4><div class="preformat">
196</div>
197         
198         
199          <h3>Known issues</h3>
200         
201         
202         
203          <h4>Restrictions</h4><div class="preformat">
204</div>
205       
206         
207         
208         
209         
210         
211         
212         
213       
214          <h3>Statistics</h3>
215          <table class="statistics">
216            <tr><td>McCabe cyclic</td><td>           1</td></tr>
217            <tr><td>McCabe essential</td><td>           1</td></tr>
218            <tr><td>McCabe modular design</td><td>           1</td></tr>
219          </table>
220         
221       
222        </div>
223       
224
225        <div class="routine_details" id="_definetri_e">
226
227          <h2><a class="top" href="#container">top</a>definetri_e <span class="categories">
228 Make contours with E-grid type
229</span></h2>
230       
231          <p class="header">
232            <span class="result">result = </span>definetri_e(<span class="result"><a href="#_definetri_e_param_nx">nx</a>, <a href="#_definetri_e_param_ny">ny</a>[, <a href="#_definetri_e_param_singular">singular</a>]</span>, <a href="#_definetri_e_keyword_SHIFTED">SHIFTED</a>=<span class="result">SHIFTED</span>)</p>
233       
234          <div class="comments">
235</div>
236
237          <h3>Return value</h3><div class="preformat">
238 Triangles is a 2d array and is dimensions are 3 and (nx-1)*(ny-1).
239 Triangles is defined like in the <a href="/Applications/rsi/idl_6.3/help/online_help/TRIANGULATE.html">TRIANGULATE</a> procedure.
240</div>
241
242         
243            <h3>Parameters</h3>
244       
245           
246            <h4 id="_definetri_e_param_nx">nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
247              <span class="attr">in</span>
248             
249             
250              <span class="attr">required</span>
251             
252             
253             
254             
255            </h4>
256       
257          <div class="comments">
258 The x dimension array
259</div>
260           
261            <h4 id="_definetri_e_param_ny">ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
262              <span class="attr">in</span>
263             
264             
265              <span class="attr">required</span>
266             
267             
268             
269             
270            </h4>
271       
272          <div class="comments">
273 The y dimension array
274</div>
275           
276            <h4 id="_definetri_e_param_singular">singular&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
277              <span class="attr">in</span>
278             
279              <span class="attr">optional</span>
280             
281             
282             
283             
284             
285            </h4>
286       
287          <div class="comments">
288 When singular is undefined all rectangles are cut in using the vertical
289 diagonal.
290 Singular is a vector which contains the rectangles numbers which are cut in
291 using the horizontal diagonal.
292 The rectangle number is defined by the index (in a nx*ny vector) of the
293 lower-left corner of the rectangle.
294</div>
295           
296
297         
298
299         
300
301            <h3>Keywords</h3>
302           
303            <h4 id="_definetri_e_keyword_SHIFTED">SHIFTED&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
304             
305             
306             
307             
308             
309             
310             
311             
312            </h4>
313       
314            <div class="comments">
315</div>
316           
317         
318
319         
320          <h3>Version history</h3>
321         
322          <h4>Version</h4><div class="preformat">
323 $Id: definetri_e.pro 262 2007-08-21 14:19:32Z pinsard $
324</div>
325          <h4>History</h4><div class="preformat">
326 Sebastien Masson (smlod@ipsl.jussieu.fr)
327                       June 2001
328</div>
329         
330         
331          <h3>Known issues</h3>
332         
333         
334          <h4>Todo items</h4><div class="preformat">
335 seb: documenter SHIFTED</div>
336         
337       
338         
339         
340         
341         
342         
343         
344         
345       
346          <h3>Statistics</h3>
347          <table class="statistics">
348            <tr><td>McCabe cyclic</td><td>           4</td></tr>
349            <tr><td>McCabe essential</td><td>           1</td></tr>
350            <tr><td>McCabe modular design</td><td>           1</td></tr>
351          </table>
352         
353       
354        </div>
355       
356      </div>
357
358     
359
360      <div id="tagline">Produced by IDLdoc 2.0.</div>
361
362    </div>
363
364  </body>
365</html>
Note: See TracBrowser for help on using the repository browser.