source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/CALCULS/floatlevel2depth.html @ 338

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

update documentation

File size: 3.4 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>floatlevel2depth.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="determ3.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="fsfzpt.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>floatlevel2depth.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Rather comparable to <a href="../..//ToBeReviewed/CALCULS/level2depth.html">level2depth</a>.
65 It is the invert function of <a href="../..//ToBeReviewed/CALCULS/depth2floatlevel.html">depth2floatlevel</a>.
66
67
68   
69
70     
71      <a name="#_floatlevel2depth"></a>
72
73      <h2>floatlevel2depth  <font size="-1" color="#006633">
74 Without loop
75</font></h2>
76
77      <p><font face="Courier"><i>result = </i>floatlevel2depth(<i><a href="#_floatlevel2depth_keyword_tab">tab</a></i>, <a href="#_floatlevel2depth_keyword_NOMASK">NOMASK</a>=<i>NOMASK</i>)</font></p>
78
79   
80
81
82    <h3>Return value</h3>
83 2d array containing depths
84
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_floatlevel2depth_keyword_tab"></a>
91    <h4>tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
92     
93     
94     
95     
96     
97     
98     
99     
100    </h4>
101
102   
103 2d array of sill levels (or a structure respecting <a href="../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> criterions)
104
105   
106   
107
108   
109    <h3>Keywords</h3>
110
111   
112    <a name="#_floatlevel2depth_keyword_NOMASK"></a>
113    <h4>NOMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
114     
115     
116     
117     
118     
119     
120     
121     
122    </h4>
123
124   
125 To do not mask land points
126
127   
128   
129
130    <h3>Examples</h3><pre>
131    IDL> a=gdept[jpk-1]/(1.*jpi*jpj)*findgen(jpi,jpj)
132    IDL> plt, 1e6*(a-floatlevel2depth(depth2floatlevel(a))),/nocontour
133
134  ->null field at 1e-6 pres
135
136    </pre><h3>Version history</h3>
137   
138    <h4>Version</h4>
139 $Id: floatlevel2depth.pro 327 2007-12-13 16:22:35Z pinsard $
140
141    <h4>History</h4>
142 Sebastien Masson (smasson@lodyc.jussieu.fr)
143                      15/6/2000
144
145   
146
147   
148   
149   
150   
151   
152
153    <h3>Other attributes</h3>
154   
155   
156    <h4>Uses routines</h4>
157 common.pro
158
159   
160   
161   
162
163    <font size="-3"><p>&nbsp;</p></font>
164    <hr size="1" color="#CCCCCC"/>
165     
166
167   
168
169    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
170
171  </body>
172</html>
Note: See TracBrowser for help on using the repository browser.