source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/triangule.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 5.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>triangule.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="triangule.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//triangule.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="tracemask.html">&lt;&lt;prev file</a> | <a href="triangule_c.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="triangule.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&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">triangule.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_triangule">
105
106          <h2><a class="top" href="#container">top</a>triangule <span class="categories">
107
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>triangule(<span class="result">[<a href="#_triangule_param_maskentree">maskentree</a>]</span>, <a href="#_triangule_keyword_BASIC">BASIC</a>=<span class="result">BASIC</span>, <a href="#_triangule_keyword_COINMONTE">COINMONTE</a>=<span class="result">array</span>, <a href="#_triangule_keyword_COINDESCEND">COINDESCEND</a>=<span class="result">array</span>, <a href="#_triangule_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
112       
113          <div class="comments"></div>
114
115          <h3>Return value</h3><div class="preformat">
116</div>
117
118         
119            <h3>Parameters</h3>
120       
121           
122            <h4 id="_triangule_param_maskentree">maskentree&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123              <span class="attr">in</span>
124             
125              <span class="attr">optional</span>
126             
127             
128              <span class="attr">type:</span> <span class="value">2d array</span>
129             
130             
131            </h4>
132       
133          <div class="comments">
134 It is a 2d array which will serve to mask the field we will trace after with CONTOUR,
135 ...TRIANGULATION=triangule(mask)
136 If this argument is not specified, the function use tmask
137</div>
138           
139
140         
141
142         
143
144            <h3>Keywords</h3>
145           
146            <h4 id="_triangule_keyword_BASIC">BASIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147             
148             
149             
150             
151             
152             
153             
154             
155            </h4>
156       
157            <div class="comments">
158 Specify that the mask is on a basic grid (use the triangulation for vertical cuts and hovmoellers)
159</div>
160           
161            <h4 id="_triangule_keyword_COINMONTE">COINMONTE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
162             
163             
164             
165             
166             
167              <span class="attr">type:</span> <span class="value">array</span>
168             
169             
170            </h4>
171       
172            <div class="comments">
173 To obtain the array of "ascending land corner" to be treated with
174 completecointerre.pro in the variable array instead of make it pass by the global
175 variable twin_corners_up.
176</div>
177           
178            <h4 id="_triangule_keyword_COINDESCEND">COINDESCEND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
179             
180             
181             
182             
183             
184              <span class="attr">type:</span> <span class="value">array</span>
185             
186             
187            </h4>
188       
189            <div class="comments">
190 See COINMONTE
191</div>
192           
193            <h4 id="_triangule_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
194             
195             
196             
197             
198             
199             
200             
201             
202            </h4>
203       
204            <div class="comments">
205 Used to pass keywords
206</div>
207           
208         
209
210          <h3>Examples</h3><div class="preformat">
211</div>
212          <h3>Version history</h3>
213         
214          <h4>Version</h4><div class="preformat">
215 $Id: triangule.pro 327 2007-12-13 16:22:35Z pinsard $
216</div>
217          <h4>History</h4><div class="preformat">
218</div>
219         
220         
221          <h3>Known issues</h3>
222         
223         
224          <h4>Todo items</h4><div class="preformat">
225 seb
226</div>
227          <h4>Restrictions</h4><div class="preformat">
228</div>
229       
230          <h3>Other attributes</h3>
231         
232         
233          <h4>Uses routines</h4><div class="preformat">
234</div>
235         
236         
237         
238       
239          <h3>Statistics</h3>
240          <table class="statistics">
241            <tr><td>McCabe cyclic</td><td>          10</td></tr>
242            <tr><td>McCabe essential</td><td>           1</td></tr>
243            <tr><td>McCabe modular design</td><td>           1</td></tr>
244          </table>
245         
246       
247        </div>
248       
249      </div>
250
251     
252
253      <div id="tagline">Produced by IDLdoc 2.0.</div>
254
255    </div>
256
257  </body>
258</html>
Note: See TracBrowser for help on using the repository browser.