source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/CALCULS/depth2level.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 4.6 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>depth2level.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="depth2floatlevel.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="depth2mask.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/CALCULS/</font></h1>
58    <h2>depth2level.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Allows to pass from a 2d depth array to a corresponding 2d level array.
65
66
67   
68
69     
70      <a name="#_depth2level"></a>
71
72      <h2>depth2level  <font size="-1" color="#006633">
73 Without loop
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>depth2level(<i><a href="#_depth2level_keyword_tab">tab</a></i>, <a href="#_depth2level_keyword_LOWER">LOWER</a>=<i>LOWER</i>, <a href="#_depth2level_keyword_UPPER">UPPER</a>=<i>UPPER</i>, <a href="#_depth2level_keyword_CLOSER">CLOSER</a>=<i>CLOSER</i>, <a href="#_depth2level_keyword_NOMASK">NOMASK</a>=<i>NOMASK</i>, <a href="#_depth2level_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
77
78   
79
80
81    <h3>Return value</h3>
82 It is a 2d array containing level's values.
83
84
85   
86    <h3>Parameters</h3>
87   
88
89    <a name="#_depth2level_keyword_tab"></a>
90    <h4>tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
91     
92     
93     
94     
95     
96      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
97     
98     
99    </h4>
100
101   
102 2d depth array (or a structure respecting <a href="../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> criterions)
103
104   
105   
106
107   
108    <h3>Keywords</h3>
109
110   
111    <a name="#_depth2level_keyword_LOWER"></a>
112    <h4>LOWER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
113     
114     
115     
116     
117     
118     
119     
120     
121    </h4>
122
123   
124 We select the level just below the depth
125
126   
127    <a name="#_depth2level_keyword_UPPER"></a>
128    <h4>UPPER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
129     
130     
131     
132     
133     
134     
135     
136     
137    </h4>
138
139   
140 (activated by default) We select the level just above the depth
141
142   
143    <a name="#_depth2level_keyword_CLOSER"></a>
144    <h4>CLOSER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
145     
146     
147     
148     
149     
150     
151     
152     
153    </h4>
154
155   
156 We select the depth's closer level
157
158   
159    <a name="#_depth2level_keyword_NOMASK"></a>
160    <h4>NOMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
161     
162     
163     
164     
165     
166     
167     
168     
169    </h4>
170
171   
172 To do not mask land points
173
174   
175    <a name="#_depth2level_keyword__EXTRA"></a>
176    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177     
178     
179     
180     
181     
182     
183     
184     
185    </h4>
186
187   
188   
189   
190
191   
192    </pre><h3>Version history</h3>
193   
194    <h4>Version</h4>
195 $Id: depth2level.pro 370 2008-08-07 07:59:15Z pinsard $
196    <h4>History</h4>
197 Sebastien Masson (smasson@lodyc.jussieu.fr)
198                       17/6/1999
199                       15/6/2000 accepte !values.f_nan
200
201   
202
203    <h3>Known issues</h3>
204   
205   
206   
207    <h4>Restrictions</h4>
208 For depths out of gdep's values, the value !values.f_nan is sent back.
209 if the depth is superior to this one of the bottom, we send back jpk-1 in
210 the upper case, and !values.f_nan in the lower case.
211
212
213    <h3>Other attributes</h3>
214   
215   
216    <h4>Uses routines</h4>
217 <a href="../..//Obsolete/common.html">common</a>
218
219   
220   
221   
222
223    <font size="-3"><p>&nbsp;</p></font>
224    <hr size="1" color="#CCCCCC"/>
225     
226
227   
228
229    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
230
231  </body>
232</html>
Note: See TracBrowser for help on using the repository browser.