source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/TRIANGULATION/triangule.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: 4.4 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>triangule.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="tracemask.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="triangule_c.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>triangule.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64
65
66
67   
68
69     
70      <a name="#_triangule"></a>
71
72      <h2>triangule  <font size="-1" color="#006633">
73
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>triangule(<i>[<a href="#_triangule_keyword_maskentree">maskentree</a>]</i>, <a href="#_triangule_keyword_BASIC">BASIC</a>=<i>BASIC</i>, <a href="#_triangule_keyword_COINMONTE">COINMONTE</a>=<i>array</i>, <a href="#_triangule_keyword_COINDESCEND">COINDESCEND</a>=<i>array</i>, <a href="#_triangule_keyword__extra">_extra</a>=<i>_extra</i>)</font></p>
77
78   
79
80    <h3>Return value</h3>
81
82
83
84   
85    <h3>Parameters</h3>
86   
87
88    <a name="#_triangule_keyword_maskentree"></a>
89    <h4>maskentree&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
90      <font size="-1" color="#006633">in</font>
91     
92      <font size="-1" color="#006633">optional</font>
93     
94     
95      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
96     
97     
98    </h4>
99
100   
101 It is a 2d array which will serve to mask the field we will trace after with CONTOUR,
102 ...TRIANGULATION=triangule(mask)
103 If this argument is not specified, the function use tmask
104
105   
106   
107
108   
109    <h3>Keywords</h3>
110
111   
112    <a name="#_triangule_keyword_BASIC"></a>
113    <h4>BASIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
114     
115     
116     
117     
118     
119     
120     
121     
122    </h4>
123
124   
125 Specify that the mask is on a basic grid (use the triangulation for vertical cuts and hovmoellers)
126
127   
128    <a name="#_triangule_keyword_COINMONTE"></a>
129    <h4>COINMONTE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
130     
131     
132     
133     
134     
135      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>array</i></font>
136     
137     
138    </h4>
139
140   
141 To obtain the array of "ascending land corner" to be treated with
142 completecointerre.pro in the variable array instead of make it pass by the global
143 variable twin_corners_up.
144
145   
146    <a name="#_triangule_keyword_COINDESCEND"></a>
147    <h4>COINDESCEND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
148     
149     
150     
151     
152     
153      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>array</i></font>
154     
155     
156    </h4>
157
158   
159 See COINMONTE
160
161   
162    <a name="#_triangule_keyword__extra"></a>
163    <h4>_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
164     
165     
166     
167     
168     
169     
170     
171     
172    </h4>
173
174   
175 Used to pass your keywords
176
177   
178   
179
180    <h3>Examples</h3>
181
182
183    <h3>Version history</h3>
184   
185    <h4>Version</h4>
186 $Id$
187
188    <h4>History</h4>
189
190
191   
192
193    <h3>Known issues</h3>
194   
195   
196    <h4>Todo items</h4>
197 seb
198
199    <h4>Restrictions</h4>
200
201
202
203    <h3>Other attributes</h3>
204   
205   
206    <h4>Uses routines</h4>
207
208
209   
210   
211   
212
213    <font size="-3"><p>&nbsp;</p></font>
214    <hr size="1" color="#CCCCCC"/>
215     
216
217   
218
219    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:50:39 2006.</font></p>
220
221  </body>
222</html>
Note: See TracBrowser for help on using the repository browser.