source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/depth2level.html @ 338

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

update documentation
File size: 6.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>depth2level.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="depth2level.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//depth2level.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="depth2floatlevel.html">&lt;&lt;prev file</a> | <a href="depth2mask.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="depth2level.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">depth2level.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Allows to pass from a 2d depth array to a corresponding 2d level array.
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_depth2level">
105
106          <h2><a class="top" href="#container">top</a>depth2level <span class="categories">
107 Without loop
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>depth2level(<span class="result"><a href="#_depth2level_param_tab">tab</a></span>, <a href="#_depth2level_keyword_LOWER">LOWER</a>=<span class="result">LOWER</span>, <a href="#_depth2level_keyword_UPPER">UPPER</a>=<span class="result">UPPER</span>, <a href="#_depth2level_keyword_CLOSER">CLOSER</a>=<span class="result">CLOSER</span>, <a href="#_depth2level_keyword_NOMASK">NOMASK</a>=<span class="result">NOMASK</span>, <a href="#_depth2level_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="preformat">
117 It is a 2d array containing level's values.
118</div>
119
120         
121            <h3>Parameters</h3>
122       
123           
124            <h4 id="_depth2level_param_tab">tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125             
126             
127             
128             
129             
130              <span class="attr">type:</span> <span class="value">2d array</span>
131             
132             
133            </h4>
134       
135          <div class="comments">
136 2d depth array (or a structure respecting <a href="../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> criterions)
137</div>
138           
139
140         
141
142         
143
144            <h3>Keywords</h3>
145           
146            <h4 id="_depth2level_keyword_LOWER">LOWER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147             
148             
149             
150             
151             
152             
153             
154             
155            </h4>
156       
157            <div class="comments">
158 We select the level just below the depth
159</div>
160           
161            <h4 id="_depth2level_keyword_UPPER">UPPER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
162             
163             
164             
165             
166             
167             
168             
169             
170            </h4>
171       
172            <div class="comments">
173 (activated by default) We select the level just above the depth
174</div>
175           
176            <h4 id="_depth2level_keyword_CLOSER">CLOSER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177             
178             
179             
180             
181             
182             
183             
184             
185            </h4>
186       
187            <div class="comments">
188 We select the depth's closer level
189</div>
190           
191            <h4 id="_depth2level_keyword_NOMASK">NOMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
192             
193             
194             
195             
196             
197             
198             
199             
200            </h4>
201       
202            <div class="comments">
203 To do not mask land points
204</div>
205           
206            <h4 id="_depth2level_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
207             
208             
209             
210             
211             
212             
213             
214             
215            </h4>
216       
217            <div class="comments"></div>
218           
219         
220
221         
222          <h3>Version history</h3>
223         
224          <h4>Version</h4><div class="preformat">
225 $Id: depth2level.pro 327 2007-12-13 16:22:35Z pinsard $</div>
226          <h4>History</h4><div class="preformat">
227 Sebastien Masson (smasson@lodyc.jussieu.fr)
228                       17/6/1999
229                       15/6/2000 accepte !values.f_nan
230</div>
231         
232         
233          <h3>Known issues</h3>
234         
235         
236         
237          <h4>Restrictions</h4><div class="preformat">
238 For depths out of gdep's values, the value !values.f_nan is sent back.
239 if the depth is superior to this one of the bottom, we send back jpk-1 in
240 the upper case, and !values.f_nan in the lower case.
241</div>
242       
243          <h3>Other attributes</h3>
244         
245         
246          <h4>Uses routines</h4><div class="preformat">
247 common.pro
248</div>
249         
250         
251         
252       
253          <h3>Statistics</h3>
254          <table class="statistics">
255            <tr><td>McCabe cyclic</td><td>          17</td></tr>
256            <tr><td>McCabe essential</td><td>           1</td></tr>
257            <tr><td>McCabe modular design</td><td>           1</td></tr>
258          </table>
259         
260       
261        </div>
262       
263      </div>
264
265     
266
267      <div id="tagline">Produced by IDLdoc 2.0.</div>
268
269    </div>
270
271  </body>
272</html>
Note: See TracBrowser for help on using the repository browser.