Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/depth2level.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: 5.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>depth2level.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="depth2level.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 documentation</td>
67	</tr>
68	</table>
69
70	</div>
71
72	<div id="secondary_navbar">
73
74	<a href="depth2floatlevel.html"><<prev file</a> \| <a href="depth2mask.html">next file >></a>    <a href="depth2level.html" target="_TOP">view single page</a> \| <a href="./../../index.html?format=raw" target="_TOP">view frames</a>    summary: fields \| routine    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">depth2level.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="_depth2level">
103
104	<h2><a class="top" href="#container">top</a>depth2level </h2>
105
106	<p class="header">
107	<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>
108
109	<div class="comments">
110	NAME: depth2level
111
112	PURPOSE: permet de passer d''un tableau 2d de profondeur au tableau
113	2d correspondant de niveaux.
114
115	CATEGORY: SANS BOUCLE
116
117	CALLING SEQUENCE: res=depth2level(depth2d)
118
119	INPUTS: depth2d tableau 2d de profondeur (ou une structure repondant
120	aux criteres de litchamp)
121
122	KEYWORD PARAMETERS:
123
124	/UPPER: (active par defaut) on selectionne le niveau
125	directement au dessus de la profondeur
126
127	/LOWER: on selectionne le niveau directement au dessous de la
128	profondeur
129
130	/CLOSER: on selectionne le niveau le plus proche de la
131	profondeur
132
133	/NOMASK: pour ne pas masquer les points terres
134
135	OUTPUTS: un tableau 2d contenant les valeurs des niveaux.
136
137	COMMON BLOCKS:common.pro
138
139	SIDE EFFECTS:pour les profondeurs hors des valeurs de gdep, la
140	valeur !values.f_nan est retournee.
141	Si la profondeur est superieur a celle du fond, on retourne
142	jpk-1dans le cas upper, et !values.f_nan ds le cas lower.
143
144	RESTRICTIONS:
145
146	EXAMPLE:
147	</div>
148
149
150
151
152	<h3>Parameters</h3>
153
154
155	<h4 id="_depth2level_param_tab">tab
156
157
158
159
160
161
162
163
164	</h4>
165
166	<div class="comments"></div>
167
168
169
170
171
172
173	<h3>Keywords</h3>
174
175	<h4 id="_depth2level_keyword_LOWER">LOWER
176
177
178
179
180
181
182
183
184	</h4>
185
186	<div class="comments"></div>
187
188	<h4 id="_depth2level_keyword_UPPER">UPPER
189
190
191
192
193
194
195
196
197	</h4>
198
199	<div class="comments"></div>
200
201	<h4 id="_depth2level_keyword_CLOSER">CLOSER
202
203
204
205
206
207
208
209
210	</h4>
211
212	<div class="comments"></div>
213
214	<h4 id="_depth2level_keyword_NOMASK">NOMASK
215
216
217
218
219
220
221
222
223	</h4>
224
225	<div class="comments"></div>
226
227	<h4 id="_depth2level_keyword__extra">_extra
228
229
230
231
232
233
234
235
236	</h4>
237
238	<div class="comments"></div>
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265	</div>
266
267	</div>
268
269
270
271	<div id="tagline">Produced by IDLdoc 2.0.</div>
272
273	</div>
274
275	</body>
276	</html>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: