Context Navigation

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

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

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

Download in other formats: