source: trunk/SRC/Documentation/idldoc_html_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: 4.7 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>floatlevel2depth.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="floatlevel2depth.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../ToBeReviewed/CALCULS//floatlevel2depth.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="determ3.html">&lt;&lt;prev file</a> | <a href="fsfzpt.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="floatlevel2depth.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/CALCULS/</a></h1>
82      <h2 class="pro_file">floatlevel2depth.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Rather comparable to <a href="../..//ToBeReviewed/CALCULS/level2depth.html">level2depth</a>.
91 It is the invert function of <a href="../..//ToBeReviewed/CALCULS/depth2floatlevel.html">depth2floatlevel</a>.
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_floatlevel2depth">
106
107          <h2><a class="top" href="#container">top</a>floatlevel2depth <span class="categories">
108 Without loop
109</span></h2>
110       
111          <p class="header">
112            <span class="result">result = </span>floatlevel2depth(<span class="result"><a href="#_floatlevel2depth_param_tab">tab</a></span>, <a href="#_floatlevel2depth_keyword_NOMASK">NOMASK</a>=<span class="result">NOMASK</span>)</p>
113       
114          <div class="comments">
115</div>
116
117          <h3>Return value</h3><div class="preformat">
118 2d array containing depths
119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_floatlevel2depth_param_tab">tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126             
127             
128             
129             
130             
131             
132             
133             
134            </h4>
135       
136          <div class="comments">
137 2d array of sill levels (or a structure respecting <a href="../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> criterions)
138</div>
139           
140
141         
142
143         
144
145            <h3>Keywords</h3>
146           
147            <h4 id="_floatlevel2depth_keyword_NOMASK">NOMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
148             
149             
150             
151             
152             
153             
154             
155             
156            </h4>
157       
158            <div class="comments">
159 To do not mask land points
160</div>
161           
162         
163
164          <h3>Examples</h3><div class="preformat">
165    IDL> a=gdept[jpk-1]/(1.*jpi*jpj)*findgen(jpi,jpj)
166    IDL> plt, 1e6*(a-floatlevel2depth(depth2floatlevel(a))),/nocontour
167
168  ->null field at 1e-6 pres
169</div>
170          <h3>Version history</h3>
171         
172          <h4>Version</h4><div class="preformat">
173 $Id: floatlevel2depth.pro 327 2007-12-13 16:22:35Z pinsard $
174</div>
175          <h4>History</h4><div class="preformat">
176 Sebastien Masson (smasson@lodyc.jussieu.fr)
177                      15/6/2000
178</div>
179         
180         
181         
182         
183         
184         
185         
186       
187          <h3>Other attributes</h3>
188         
189         
190          <h4>Uses routines</h4><div class="preformat">
191 common.pro
192</div>
193         
194         
195         
196       
197          <h3>Statistics</h3>
198          <table class="statistics">
199            <tr><td>McCabe cyclic</td><td>           7</td></tr>
200            <tr><td>McCabe essential</td><td>           1</td></tr>
201            <tr><td>McCabe modular design</td><td>           1</td></tr>
202          </table>
203         
204       
205        </div>
206       
207      </div>
208
209     
210
211      <div id="tagline">Produced by IDLdoc 2.0.</div>
212
213    </div>
214
215  </body>
216</html>
Note: See TracBrowser for help on using the repository browser.