Context Navigation

read_hope.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago
update documentation
File size: 12.3 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>read_hope.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="read_hope.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/HOPE//read_hope.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 documentation</td>
67	</tr>
68	</table>
69
70	</div>
71
72	<div id="secondary_navbar">
73
74	<a href="findlineandpointtype.html"><<prev file</a> \| <a href="rh_alldomains.html">next file >></a>    <a href="read_hope.html" target="_TOP">view single page</a> \| <a href="./../../index.html" target="_TOP">view frames</a>    summary: fields \| <a href="#routine_summary">routine</a>    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/HOPE/</a></h1>
82	<h2 class="pro_file">read_hope.pro</h2>
83
84	<div id="file_attr">
85	<dl>
86	</dl>
87	</div>
88
89	<div id="file_comments">
90
91
92	Read the Hope grid file converted in NetCdf by xconv
93	</div>
94
95
96
97
98
99
100
101
102	<div id="routine_summary">
103	<h2>Routine summary</h2>
104
105	<dl>
106
107	<dt><p><a href="#_read_hope_event">read_hope_event<span class="result">, event</span></a></p><dt>
108	<dd> </dd>
109
110	<dt><p><a href="#_read_hope"><span class="result">result = </span>read_hope(<span class="result">typein, varnamein</span>, FILENAME=<span class="result">string</span>, XLIMITS=<span class="result">vector</span>, YLIMITS=<span class="result">vector</span>, ZLIMITS=<span class="result">vector</span>, TLIMITS=<span class="result">vector</span>, ODDPT=<span class="result">ODDPT</span>, ODDEVENPT=<span class="result">ODDEVENPT</span>, EVENPT=<span class="result">EVENPT</span>, _EXTRA=<span class="result">_EXTRA</span>)</a></p><dt>
111	<dd> </dd>
112
113	</dl>
114	</div>
115
116
117	<div id="routine_details">
118
119
120	<div class="routine_details" id="_read_hope_event">
121
122	<h2><a class="top" href="#container">top</a>read_hope_event <span class="categories">
123	</span></h2>
124
125	<p class="header">
126	read_hope_event<span class="result">, <a href="#_read_hope_event_param_event">event</a></span></p>
127
128	<div class="comments">
129	</div>
130
131	<h3>Return value</h3><div class="preformat">
132	</div>
133
134
135	<h3>Parameters</h3>
136
137
138	<h4 id="_read_hope_event_param_event">event
139
140
141
142
143
144
145
146
147	</h4>
148
149	<div class="comments">
150	</div>
151
152
153
154
155
156
157	<h3>Examples</h3><div class="preformat">
158	</div>
159	<h3>Version history</h3>
160
161	<h4>Version</h4><div class="preformat">
162	$Id: read_hope.pro 371 2008-08-07 09:32:02Z pinsard $
163	</div>
164	<h4>History</h4><div class="preformat">
165	</div>
166
167
168	<h3>Known issues</h3>
169
170
171
172	<h4>Restrictions</h4><div class="preformat">
173	</div>
174
175
176
177
178
179
180
181
182
183	<h3>Statistics</h3>
184	<table class="statistics">
185	<tr><td>McCabe cyclic</td><td> 39</td></tr>
186	<tr><td>McCabe essential</td><td> 1</td></tr>
187	<tr><td>McCabe modular design</td><td> 1</td></tr>
188	</table>
189
190
191	</div>
192
193
194	<div class="routine_details" id="_read_hope">
195
196	<h2><a class="top" href="#container">top</a>read_hope <span class="categories">
197	Reading
198	</span></h2>
199
200	<p class="header">
201	<span class="result">result = </span>read_hope(<span class="result"><a href="#_read_hope_param_typein">typein</a>, <a href="#_read_hope_param_varnamein">varnamein</a></span>, <a href="#_read_hope_keyword_FILENAME">FILENAME</a>=<span class="result">string</span>, <a href="#_read_hope_keyword_XLIMITS">XLIMITS</a>=<span class="result">vector</span>, <a href="#_read_hope_keyword_YLIMITS">YLIMITS</a>=<span class="result">vector</span>, <a href="#_read_hope_keyword_ZLIMITS">ZLIMITS</a>=<span class="result">vector</span>, <a href="#_read_hope_keyword_TLIMITS">TLIMITS</a>=<span class="result">vector</span>, <a href="#_read_hope_keyword_ODDPT">ODDPT</a>=<span class="result">ODDPT</span>, <a href="#_read_hope_keyword_ODDEVENPT">ODDEVENPT</a>=<span class="result">ODDEVENPT</span>, <a href="#_read_hope_keyword_EVENPT">EVENPT</a>=<span class="result">EVENPT</span>, <a href="#_read_hope_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
202
203	<div class="comments">
204	</div>
205
206	<h3>Return value</h3><div class="preformat">
207	-1 if typein and varnamein are undefined (this is the widget
208	version)
209
210	A structure which but be read by <a href="../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and is
211	necessary to complete the grid associated to the data (see
212	the example).
213	</div>
214
215
216	<h3>Parameters</h3>
217
218
219	<h4 id="_read_hope_param_typein">typein
220	<span class="attr">in</span>
221
222
223	<span class="attr">required</span>
224
225	<span class="attr">type:</span> <span class="value">string</span>
226
227
228	</h4>
229
230	<div class="comments">
231	A string specifying from which type of section the 4D
232	array based: 'xy, 'xz', 'yz'
233	</div>
234
235	<h4 id="_read_hope_param_varnamein">varnamein
236	<span class="attr">in</span>
237
238
239	<span class="attr">required</span>
240
241	<span class="attr">type:</span> <span class="value">string</span>
242
243
244	</h4>
245
246	<div class="comments">
247	A string the name of the variable to be read (in
248	lower or upper case)
249	</div>
250
251
252
253
254
255
256	<h3>Keywords</h3>
257
258	<h4 id="_read_hope_keyword_FILENAME">FILENAME
259
260
261
262
263
264	<span class="attr">type:</span> <span class="value">string</span>
265
266
267	</h4>
268
269	<div class="comments">
270	The name of the file to be read
271	</div>
272
273	<h4 id="_read_hope_keyword_XLIMITS">XLIMITS
274
275
276
277
278
279	<span class="attr">type:</span> <span class="value">vector</span>
280
281
282	</h4>
283
284	<div class="comments">
285	A two elements vector [lonmin, lonmax]]
286	the boundary of the longitudes (from 0 to 360)
287	</div>
288
289	<h4 id="_read_hope_keyword_YLIMITS">YLIMITS
290
291
292
293
294
295	<span class="attr">type:</span> <span class="value">vector</span>
296
297
298	</h4>
299
300	<div class="comments">
301	A two elements vector [latmin, latmax]]
302	the boundary of the latitudes (from -90 to 90)
303	</div>
304
305	<h4 id="_read_hope_keyword_ZLIMITS">ZLIMITS
306
307
308
309
310
311	<span class="attr">type:</span> <span class="value">vector</span>
312
313
314	</h4>
315
316	<div class="comments">
317	A two elements vector [depthmin, depthmax]]
318	the boundary of the depth
319	</div>
320
321	<h4 id="_read_hope_keyword_TLIMITS">TLIMITS
322
323
324
325
326
327	<span class="attr">type:</span> <span class="value">vector</span>
328
329
330	</h4>
331
332	<div class="comments">
333	A two elements vector [date1, date2]]
334	the boundary of the calendar with date1 and date2
335	following the syntax yyyymmdd
336	</div>
337
338	<h4 id="_read_hope_keyword_ODDPT">ODDPT
339
340
341
342
343
344
345
346
347	</h4>
348
349	<div class="comments">
350	Activate to read only the sections located on ODD
351	points
352	</div>
353
354	<h4 id="_read_hope_keyword_ODDEVENPT">ODDEVENPT
355
356
357
358
359
360
361
362
363	</h4>
364
365	<div class="comments">
366	Activate to read only the sections located on
367	both even and odd points (horizontal sections)
368	</div>
369
370	<h4 id="_read_hope_keyword_EVENPT">EVENPT
371
372
373
374
375
376
377
378
379	</h4>
380
381	<div class="comments">
382	Activate to read only the sections located on even
383	points
384	</div>
385
386	<h4 id="_read_hope_keyword__EXTRA">_EXTRA
387
388
389
390
391
392
393
394
395	</h4>
396
397	<div class="comments">
398	Used to pass keywords
399	</div>
400
401
402
403	<h3>Examples</h3><div class="preformat">
404
405	IDL> a=read_hope('xy','ocpt',filename='CLIM_CNT_1993-1998.nc')
406	IDL> help, a,/struct
407	** Structure <82ec344>, 6 tags, length=1860176, refs=1:
408	ARRAY FLOAT Array[128, 242, 15]
409	UNIT STRING 'deg C'
410	NAME STRING 'Ocean potential temperature'
411	DATE FLOAT Array[1]
412	GRID STRING 'T'
413	HOPEGRID STRUCT -> <Anonymous> Array[1]
414	IDL> help, a.hopegrid,/struct
415	** Structure <82eb9cc>, 8 tags, length=1588, refs=2:
416	XAXIS FLOAT Array[128]
417	YAXIS FLOAT Array[242]
418	ZAXIS FLOAT Array[15]
419	FIRSTS LONG Array[3]
420	LASTS LONG Array[3]
421	TYPE STRING 'xy'
422	LINETYPE STRING 'odd-even'
423	PTTYPE STRING 'T'
424	IDL> help, litchamp(a)
425	<Expression> FLOAT = Array[128, 242, 15]
426	</div>
427	<h3>Version history</h3>
428
429	<h4>Version</h4><div class="preformat">
430	$Id: read_hope.pro 371 2008-08-07 09:32:02Z pinsard $
431	</div>
432	<h4>History</h4><div class="preformat">
433	Sebastien Masson (smasson@lodyc.jussieu.fr)
434	June 2001
435	</div>
436
437
438	<h3>Known issues</h3>
439
440
441
442	<h4>Restrictions</h4><div class="preformat">
443	'x', 'y', 'z', 't', 'xt', 'yt' and 'zt' section not coded, xconv
444	must be able to works with this kind of function.
445	The grid file has no zoom possibilities on horizontal dimensions.
446
447
448
449	When typein and varnamein are defined, the method to find the
450	good variable is:
451	1) find the variables which are available on this type of
452	sections with this name
453	2) if ODDPT, EVENPT or ODDEVENPT are specified, consider only
454	these types of sections
455	3) For an XY section the chosen variable is the one which has
456	the most level in the vertical domain specified by ZLIMITS.
457	For an XZ section the chosen variable is the one which has
458	the most points in the latitude domain specified by YLIMITS.
459	For an YZ section the chosen variable is the one which has
460	the most points in the longitude domain specified by XLIMITS.
461
462	</div>
463
464	<h3>Other attributes</h3>
465
466
467	<h4>Uses routines</h4><div class="preformat">
468	<a href="../..//Obsolete/common.html">common</a>
469	(useful only for the definition of iodir)
470	</div>
471
472
473
474
475	<h3>Statistics</h3>
476	<table class="statistics">
477	<tr><td>McCabe cyclic</td><td> 41</td></tr>
478	<tr><td>McCabe essential</td><td> 1</td></tr>
479	<tr><td>McCabe modular design</td><td> 1</td></tr>
480	</table>
481
482
483	</div>
484
485	</div>
486
487
488
489	<div id="tagline">Produced by IDLdoc 2.0.</div>
490
491	</div>
492
493	</body>
494	</html>

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

Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/HOPE/read_hope.html @ 402

Download in other formats: