source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/CALCULS/floatlevel2depth.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: 3.2 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="div.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 level2depth. It is the invert function of depth2floatlevel
65
66
67   
68
69     
70      <a name="#_floatlevel2depth"></a>
71
72      <h2>floatlevel2depth  <font size="-1" color="#006633">
73 Without loop
74</font></h2>
75
76      <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>
77
78   
79
80
81    <h3>Return value</h3>
82 2d array containing depthes
83
84
85   
86    <h3>Parameters</h3>
87   
88
89    <a name="#_floatlevel2depth_keyword_tab"></a>
90    <h4>tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
91     
92     
93     
94     
95     
96     
97     
98     
99    </h4>
100
101   
102 2d array of sill levels (or a structure respecting litchamp criterions)
103
104   
105   
106
107   
108    <h3>Keywords</h3>
109
110   
111    <a name="#_floatlevel2depth_keyword_NOMASK"></a>
112    <h4>NOMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
113     
114     
115     
116     
117     
118     
119     
120     
121    </h4>
122
123   
124 To do not mask land points
125
126   
127   
128
129    <h3>Examples</h3>
130    IDL> a=gdept[jpk-1]/(1.*jpi*jpj)*findgen(jpi,jpj)
131    IDL> plt, 1e6*(a-floatlevel2depth(depth2floatlevel(a))),/nocontour
132
133  ->null field at 1e-6 pres
134
135    <h3>Version history</h3>
136   
137    <h4>Version</h4>
138 $Id: floatlevel2depth.pro 157 2006-08-21 09:01:50Z navarro $
139
140    <h4>History</h4>
141 Sebastien Masson (smasson@lodyc.jussieu.fr)
142                      15/6/2000
143
144   
145
146   
147   
148   
149   
150   
151
152    <h3>Other attributes</h3>
153   
154   
155    <h4>Uses routines</h4>
156 common.pro
157
158   
159   
160   
161
162    <font size="-3"><p>&nbsp;</p></font>
163    <hr size="1" color="#CCCCCC"/>
164     
165
166   
167
168    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:49:50 2006.</font></p>
169
170  </body>
171</html>
Note: See TracBrowser for help on using the repository browser.