source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/floatlevel2depth.html @ 200

Last change on this file since 200 was 200, checked in by smasson, 18 years ago

update idldoc documentation
File size: 4.5 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 level2depth. It is the invert function of depth2floatlevel
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_floatlevel2depth">
105
106          <h2><a class="top" href="#container">top</a>floatlevel2depth <span class="categories">
107 Without loop
108</span></h2>
109       
110          <p class="header">
111            <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>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="preformat">
117 2d array containing depthes
118</div>
119
120         
121            <h3>Parameters</h3>
122       
123           
124            <h4 id="_floatlevel2depth_param_tab">tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125             
126             
127             
128             
129             
130             
131             
132             
133            </h4>
134       
135          <div class="comments">
136 2d array of sill levels (or a structure respecting litchamp criterions)
137</div>
138           
139
140         
141
142         
143
144            <h3>Keywords</h3>
145           
146            <h4 id="_floatlevel2depth_keyword_NOMASK">NOMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147             
148             
149             
150             
151             
152             
153             
154             
155            </h4>
156       
157            <div class="comments">
158 To do not mask land points
159</div>
160           
161         
162
163          <h3>Examples</h3><div class="preformat">
164    IDL> a=gdept[jpk-1]/(1.*jpi*jpj)*findgen(jpi,jpj)
165    IDL> plt, 1e6*(a-floatlevel2depth(depth2floatlevel(a))),/nocontour
166
167  ->null field at 1e-6 pres
168</div>
169          <h3>Version history</h3>
170         
171          <h4>Version</h4><div class="preformat">
172 $Id: floatlevel2depth.pro 163 2006-08-29 12:59:46Z navarro $
173</div>
174          <h4>History</h4><div class="preformat">
175 Sebastien Masson (smasson@lodyc.jussieu.fr)
176                      15/6/2000
177</div>
178         
179         
180         
181         
182         
183         
184         
185       
186          <h3>Other attributes</h3>
187         
188         
189          <h4>Uses routines</h4><div class="preformat">
190 common.pro
191</div>
192         
193         
194         
195       
196          <h3>Statistics</h3>
197          <table class="statistics">
198            <tr><td>McCabe cyclic</td><td>           7</td></tr>
199            <tr><td>McCabe essential</td><td>           1</td></tr>
200            <tr><td>McCabe modular design</td><td>           1</td></tr>
201          </table>
202         
203       
204        </div>
205       
206      </div>
207
208     
209
210      <div id="tagline">Produced by IDLdoc 2.0.</div>
211
212    </div>
213
214  </body>
215</html>
Note: See TracBrowser for help on using the repository browser.