source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/definetri_e.html @ 89

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago

add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 6.7 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 (IDLdoc API 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 (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" 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?format=raw" 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?format=raw">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"></div>
90
91     
92
93     
94
95     
96
97     
98      <div id="routine_summary">               
99        <h2>Routine summary</h2>
100       
101        <dl>
102         
103          <dt><p><a href="#_numtri"><span class="result">result = </span>numtri(<span class="result">index, nx, ny</span>)</a></p><dt>
104          <dd></dd>     
105         
106          <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>
107          <dd>  NAME:definetri   PURPOSE:Define a triangulation array like TRIANGULATE but for a  E-grid type   CATEGORY: make contours with E-grid type   CALLING SEQUENCE:triangles=definetri(nx, ny [,vertical])    INPUTS: nx and ny are the array dimensions    OPTIONAL INPUTS:          vertical: When vertical is undefine all rectangles are cut         in using the horizontal diagonal.</dd>       
108               
109        </dl>
110      </div>
111     
112
113      <div id="routine_details">
114       
115
116        <div class="routine_details" id="_numtri">
117
118          <h2><a class="top" href="#container">top</a>numtri </h2>
119       
120          <p class="header">
121            <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>
122       
123          <div class="comments"></div>
124
125         
126
127         
128            <h3>Parameters</h3>
129       
130           
131            <h4 id="_numtri_param_index">index&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
132             
133             
134             
135             
136             
137             
138             
139             
140            </h4>
141       
142          <div class="comments"></div>
143           
144            <h4 id="_numtri_param_nx">nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
145             
146             
147             
148             
149             
150             
151             
152             
153            </h4>
154       
155          <div class="comments"></div>
156           
157            <h4 id="_numtri_param_ny">ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
158             
159             
160             
161             
162             
163             
164             
165             
166            </h4>
167       
168          <div class="comments"></div>
169           
170
171         
172
173         
174
175         
176         
177         
178         
179         
180         
181         
182         
183         
184         
185         
186         
187       
188         
189         
190         
191         
192         
193         
194         
195       
196         
197       
198        </div>
199       
200
201        <div class="routine_details" id="_definetri_e">
202
203          <h2><a class="top" href="#container">top</a>definetri_e </h2>
204       
205          <p class="header">
206            <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>
207       
208          <div class="comments">
209 NAME:definetri
210
211 PURPOSE:Define a triangulation array like TRIANGULATE but for a
212 E-grid type
213
214 CATEGORY: make contours with E-grid type
215
216 CALLING SEQUENCE:triangles=definetri(nx, ny [,vertical])
217 
218 INPUTS: nx and ny are the array dimensions
219
220 OPTIONAL INPUTS:
221
222        vertical: When vertical is undefine all rectangles are cut
223        in using the horizontal diagonal. Vertical is a vector which
224        contains the rectangles numbers which are cut in using the
225        vertical diagonal.
226        The rectangle number is define by the index (in a nx*ny
227        vector) of the lower-left corner of the rectangle.
228
229 KEYWORD PARAMETERS:
230
231 OUTPUTS:
232        triangles is a 2d array and is dimensions are 3 and
233        2*(nx-1)*(ny-1)
234        triangles is define like in the TRIANGULATE procedure.
235       
236
237 OPTIONAL OUTPUTS:
238
239 COMMON BLOCKS:
240
241 SIDE EFFECTS:
242
243 RESTRICTIONS:
244
245 PROCEDURE:
246
247 EXAMPLE:
248
249</div>
250
251         
252
253         
254            <h3>Parameters</h3>
255       
256           
257            <h4 id="_definetri_e_param_nx">nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
258             
259             
260             
261             
262             
263             
264             
265             
266            </h4>
267       
268          <div class="comments"></div>
269           
270            <h4 id="_definetri_e_param_ny">ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
271             
272             
273             
274             
275             
276             
277             
278             
279            </h4>
280       
281          <div class="comments"></div>
282           
283            <h4 id="_definetri_e_param_singular">singular&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
284             
285             
286             
287             
288             
289             
290             
291             
292            </h4>
293       
294          <div class="comments"></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"></div>
315           
316         
317
318         
319         
320         
321         
322         
323         
324         
325         
326         
327         
328         
329         
330       
331         
332         
333         
334         
335         
336         
337         
338       
339         
340       
341        </div>
342       
343      </div>
344
345     
346
347      <div id="tagline">Produced by IDLdoc 2.0.</div>
348
349    </div>
350
351  </body>
352</html>
Note: See TracBrowser for help on using the repository browser.