source: trunk/SRC/Documentation/idldoc_assistant_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: 4.4 KB
RevLine 
[163]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
[234]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>
[163]77
78   
79
80    <h3>Return value</h3>
81
82
83   
84    <h3>Parameters</h3>
85   
86
87    <a name="#_triangule_keyword_maskentree"></a>
88    <h4>maskentree&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
89      <font size="-1" color="#006633">in</font>
90     
91      <font size="-1" color="#006633">optional</font>
92     
93     
94      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
95     
96     
97    </h4>
98
99   
[234]100 It is a 2d array which will serve to mask the field we will trace after with CONTOUR,
[163]101 ...TRIANGULATION=triangule(mask)
102 If this argument is not specified, the function use tmask
103
104   
105   
106
107   
108    <h3>Keywords</h3>
109
110   
111    <a name="#_triangule_keyword_BASIC"></a>
112    <h4>BASIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
113     
114     
115     
116     
117     
118     
119     
120     
121    </h4>
122
123   
124 Specify that the mask is on a basic grid (use the triangulation for vertical cuts and hovmoellers)
125
126   
127    <a name="#_triangule_keyword_COINMONTE"></a>
128    <h4>COINMONTE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
129     
130     
131     
132     
133     
134      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>array</i></font>
135     
136     
137    </h4>
138
139   
[234]140 To obtain the array of "ascending land corner" to be treated with
141 completecointerre.pro in the variable array instead of make it pass by the global
[163]142 variable twin_corners_up.
143
144   
145    <a name="#_triangule_keyword_COINDESCEND"></a>
146    <h4>COINDESCEND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147     
148     
149     
150     
151     
152      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>array</i></font>
153     
154     
155    </h4>
156
157   
158 See COINMONTE
159
160   
[234]161    <a name="#_triangule_keyword__EXTRA"></a>
162    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[163]163     
164     
165     
166     
167     
168     
169     
170     
171    </h4>
172
173   
[234]174 Used to pass keywords
[163]175
176   
177   
178
[234]179    <h3>Examples</h3><pre>
[163]180
[234]181    </pre><h3>Version history</h3>
[163]182   
183    <h4>Version</h4>
[338]184 $Id: triangule.pro 327 2007-12-13 16:22:35Z pinsard $
[163]185
186    <h4>History</h4>
187
188   
189
190    <h3>Known issues</h3>
191   
192   
193    <h4>Todo items</h4>
194 seb
195
196    <h4>Restrictions</h4>
197
198
199    <h3>Other attributes</h3>
200   
201   
202    <h4>Uses routines</h4>
203
204   
205   
206   
207
208    <font size="-3"><p>&nbsp;</p></font>
209    <hr size="1" color="#CCCCCC"/>
210     
211
212   
213
[187]214    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
[163]215
216  </body>
[249]217</html>
Note: See TracBrowser for help on using the repository browser.