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

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago

add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 4.1 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 (IDLdoc API 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 (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" 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="div.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?format=raw" 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?format=raw">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"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_floatlevel2depth">
103
104          <h2><a class="top" href="#container">top</a>floatlevel2depth </h2>
105       
106          <p class="header">
107            <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>
108       
109          <div class="comments">
110 NAME:floatlevel2depth
111
112 PURPOSE: assez comparable a level2depth. C'est la fonction inverse
113 de depth2floatlevel
114
115 CATEGORY:SANS BOUCLE
116
117 CALLING SEQUENCE:res=floatlevel2depth(niveau)
118 
119 INPUTS: tableau 2d de niveaux seuil (ou une structure repondant aux
120 criteres de litchamp)
121
122 KEYWORD PARAMETERS:
123       /NOMASK: pour ne pas masquer les points terres
124
125 OUTPUTS: un tableau 2d contenant des profondeurs
126
127 COMMON BLOCKS:common.pro
128
129 SIDE EFFECTS:
130
131 RESTRICTIONS:
132
133 EXAMPLE:
134
135    IDL> a=gdept[jpk-1]/(1.*jpi*jpj)*findgen(jpi,jpj)
136    IDL> plt, 1e6*(a-floatlevel2depth(depth2floatlevel(a))),/nocontour
137
138  ->champ nul a 1e-6 pres
139</div>
140
141         
142
143         
144            <h3>Parameters</h3>
145       
146           
147            <h4 id="_floatlevel2depth_param_tab">tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
148             
149             
150             
151             
152             
153             
154             
155             
156            </h4>
157       
158          <div class="comments"></div>
159           
160
161         
162
163         
164
165            <h3>Keywords</h3>
166           
167            <h4 id="_floatlevel2depth_keyword_NOMASK">NOMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
168             
169             
170             
171             
172             
173             
174             
175             
176            </h4>
177       
178            <div class="comments"></div>
179           
180         
181
182         
183         
184         
185         
186         
187         
188         
189         
190         
191         
192         
193         
194       
195         
196         
197         
198         
199         
200         
201         
202       
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.