source: trunk/SRC/Documentation/idldoc_html_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: 5.0 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>depth2floatlevel.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="depth2floatlevel.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//depth2floatlevel.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&lt;&lt; prev file | <a href="depth2level.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="depth2floatlevel.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">depth2floatlevel.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/depth2level.html">depth2level</a> but here, the calculated level
91 is in float.
92 For example, the level 5.4 correspond to a depth equal
93 to gdep[5]+.4*(gdep[6]-gdep[5])
94</div>
95
96     
97
98     
99
100     
101
102     
103
104      <div id="routine_details">
105       
106
107        <div class="routine_details" id="_depth2floatlevel">
108
109          <h2><a class="top" href="#container">top</a>depth2floatlevel <span class="categories">
110 Without loop
111</span></h2>
112       
113          <p class="header">
114            <span class="result">result = </span>depth2floatlevel(<span class="result"><a href="#_depth2floatlevel_param_tab">tab</a></span>, <a href="#_depth2floatlevel_keyword_NOMASK">NOMASK</a>=<span class="result">NOMASK</span>)</p>
115       
116          <div class="comments">
117</div>
118
119          <h3>Return value</h3><div class="preformat">
120 An 2d array of float containing levels's values.
121</div>
122
123         
124            <h3>Parameters</h3>
125       
126           
127            <h4 id="_depth2floatlevel_param_tab">tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
128              <span class="attr">in</span>
129             
130             
131              <span class="attr">required</span>
132             
133             
134             
135             
136            </h4>
137       
138          <div class="comments">
139 2d depth array (or a structure respecting <a href="../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> criterion)
140</div>
141           
142
143         
144
145         
146
147            <h3>Keywords</h3>
148           
149            <h4 id="_depth2floatlevel_keyword_NOMASK">NOMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
150             
151             
152             
153             
154             
155             
156             
157             
158            </h4>
159       
160            <div class="comments">
161 To do not mask land points
162</div>
163           
164         
165
166          <h3>Examples</h3><div class="preformat">
167
168   IDL> a=(jpk-1)/(1.*jpi*jpj)*findgen(jpi,jpj)
169   IDL> plt, 1e6*(a-floatlevel2depth(depth2floatlevel(a))),/nocontour
170
171  ->champ nul a 1e-6 pres
172</div>
173          <h3>Version history</h3>
174         
175          <h4>Version</h4><div class="preformat">
176 $Id: depth2floatlevel.pro 371 2008-08-07 09:32:02Z pinsard $
177</div>
178          <h4>History</h4><div class="preformat">
179 Sebastien Masson (smasson@lodyc.jussieu.fr)
180                      15/06/2000
181</div>
182         
183         
184          <h3>Known issues</h3>
185         
186         
187         
188          <h4>Restrictions</h4><div class="preformat">
189 Accept values at !values.f_nan and mask land points at valmask.
190</div>
191       
192          <h3>Other attributes</h3>
193         
194         
195          <h4>Uses routines</h4><div class="preformat">
196 <a href="../..//Obsolete/common.html">common</a>
197</div>
198         
199         
200         
201       
202          <h3>Statistics</h3>
203          <table class="statistics">
204            <tr><td>McCabe cyclic</td><td>           7</td></tr>
205            <tr><td>McCabe essential</td><td>           1</td></tr>
206            <tr><td>McCabe modular design</td><td>           1</td></tr>
207          </table>
208         
209       
210        </div>
211       
212      </div>
213
214     
215
216      <div id="tagline">Produced by IDLdoc 2.0.</div>
217
218    </div>
219
220  </body>
221</html>
Note: See TracBrowser for help on using the repository browser.