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

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

update documentation

File size: 3.6 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>depth2floatlevel.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=""><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="depth2level.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>depth2floatlevel.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Rather comparable to <a href="../..//ToBeReviewed/CALCULS/depth2level.html">depth2level</a> but here, the calculated level
65 is in float.
66 For example, the level 5.4 correspond to a depth equal
67 to gdep[5]+.4*(gdep[6]-gdep[5])
68
69
70   
71
72     
73      <a name="#_depth2floatlevel"></a>
74
75      <h2>depth2floatlevel  <font size="-1" color="#006633">
76 Without loop
77</font></h2>
78
79      <p><font face="Courier"><i>result = </i>depth2floatlevel(<i><a href="#_depth2floatlevel_keyword_tab">tab</a></i>, <a href="#_depth2floatlevel_keyword_NOMASK">NOMASK</a>=<i>NOMASK</i>)</font></p>
80
81   
82
83
84    <h3>Return value</h3>
85 An 2d array of float containing levels's values.
86
87
88   
89    <h3>Parameters</h3>
90   
91
92    <a name="#_depth2floatlevel_keyword_tab"></a>
93    <h4>tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
94      <font size="-1" color="#006633">in</font>
95     
96     
97      <font size="-1" color="#006633">required</font>
98     
99     
100     
101     
102    </h4>
103
104   
105 2d depth array (or a structure respecting <a href="../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> criterion)
106
107   
108   
109
110   
111    <h3>Keywords</h3>
112
113   
114    <a name="#_depth2floatlevel_keyword_NOMASK"></a>
115    <h4>NOMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
116     
117     
118     
119     
120     
121     
122     
123     
124    </h4>
125
126   
127 To do not mask land points
128
129   
130   
131
132    <h3>Examples</h3><pre>
133
134   IDL> a=(jpk-1)/(1.*jpi*jpj)*findgen(jpi,jpj)
135   IDL> plt, 1e6*(a-floatlevel2depth(depth2floatlevel(a))),/nocontour
136
137  ->champ nul a 1e-6 pres
138
139    </pre><h3>Version history</h3>
140   
141    <h4>Version</h4>
142 $Id: depth2floatlevel.pro 371 2008-08-07 09:32:02Z pinsard $
143
144    <h4>History</h4>
145 Sebastien Masson (smasson@lodyc.jussieu.fr)
146                      15/06/2000
147
148   
149
150    <h3>Known issues</h3>
151   
152   
153   
154    <h4>Restrictions</h4>
155 Accept values at !values.f_nan and mask land points at valmask.
156
157
158    <h3>Other attributes</h3>
159   
160   
161    <h4>Uses routines</h4>
162 <a href="../..//Obsolete/common.html">common</a>
163
164   
165   
166   
167
168    <font size="-3"><p>&nbsp;</p></font>
169    <hr size="1" color="#CCCCCC"/>
170     
171
172   
173
174    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
175
176  </body>
177</html>
Note: See TracBrowser for help on using the repository browser.