source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/HOPE/read_hope.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 10.1 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>read_hope.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="findlineandpointtype.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="rh_alldomains.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/HOPE/</font></h1>
58    <h2>read_hope.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64
65
66
67 Read the Hope grid file converted in NetCdf by xconv
68
69
70   
71    <h2>Routine summary</h2>
72
73    <dl>
74     
75      <dt><a href="#_read_hope_event">read_hope_event<i>, event</i></a><dt>
76      <dd><font size="-1"></font></dd>
77     
78      <dt><a href="#_read_hope"><i>result = </i>read_hope(<i>typein, varnamein</i>, FILENAME=<i>string</i>, XLIMITS=<i>vector</i>, YLIMITS=<i>vector</i>, ZLIMITS=<i>vector</i>, TLIMITS=<i>vector</i>, ODDPT=<i>ODDPT</i>, ODDEVENPT=<i>ODDEVENPT</i>, EVENPT=<i>EVENPT</i>, _extra=<i>_extra</i>)</a><dt>
79      <dd><font size="-1"> </font></dd>
80     
81    </dl>
82
83    <p>&nbsp;</p>
84   
85
86     
87      <a name="#_read_hope_event"></a>
88
89      <h2>read_hope_event  <font size="-1" color="#006633">
90
91</font></h2>
92
93      <p><font face="Courier">read_hope_event<i>, <a href="#_read_hope_event_keyword_event">event</a></i></font></p>
94
95   
96
97    <h3>Return value</h3>
98
99
100
101   
102    <h3>Parameters</h3>
103   
104
105    <a name="#_read_hope_event_keyword_event"></a>
106    <h4>event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
107     
108     
109     
110     
111     
112     
113     
114     
115    </h4>
116
117   
118 
119
120   
121   
122
123   
124
125    <h3>Examples</h3>
126 
127 
128    <h3>Version history</h3>
129   
130    <h4>Version</h4>
131 $Id: read_hope.pro 157 2006-08-21 09:01:50Z navarro $
132
133    <h4>History</h4>
134
135
136   
137
138    <h3>Known issues</h3>
139   
140   
141   
142    <h4>Restrictions</h4>
143
144
145
146   
147   
148   
149   
150   
151   
152   
153
154    <font size="-3"><p>&nbsp;</p></font>
155    <hr size="1" color="#CCCCCC"/>
156     
157      <a name="#_read_hope"></a>
158
159      <h2>read_hope  <font size="-1" color="#006633">
160 Reading
161</font></h2>
162
163      <p><font face="Courier"><i>result = </i>read_hope(<i><a href="#_read_hope_keyword_typein">typein</a>, <a href="#_read_hope_keyword_varnamein">varnamein</a></i>, <a href="#_read_hope_keyword_FILENAME">FILENAME</a>=<i>string</i>, <a href="#_read_hope_keyword_XLIMITS">XLIMITS</a>=<i>vector</i>, <a href="#_read_hope_keyword_YLIMITS">YLIMITS</a>=<i>vector</i>, <a href="#_read_hope_keyword_ZLIMITS">ZLIMITS</a>=<i>vector</i>, <a href="#_read_hope_keyword_TLIMITS">TLIMITS</a>=<i>vector</i>, <a href="#_read_hope_keyword_ODDPT">ODDPT</a>=<i>ODDPT</i>, <a href="#_read_hope_keyword_ODDEVENPT">ODDEVENPT</a>=<i>ODDEVENPT</i>, <a href="#_read_hope_keyword_EVENPT">EVENPT</a>=<i>EVENPT</i>, <a href="#_read_hope_keyword__extra">_extra</a>=<i>_extra</i>)</font></p>
164
165   
166
167
168    <h3>Return value</h3>
169 -1 if typein and varnamein are undefine (this is the widget
170 version)
171
172 A structure which but be read by litchamp.pro and is
173 necessary to complete the grid associated to the data (see
174 the example).
175
176
177   
178    <h3>Parameters</h3>
179   
180
181    <a name="#_read_hope_keyword_typein"></a>
182    <h4>typein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
183      <font size="-1" color="#006633">in</font>
184     
185     
186      <font size="-1" color="#006633">required</font>
187     
188      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
189     
190     
191    </h4>
192
193   
194 A string specifying from which type of section the 4D
195 array based: 'xy, 'xz', 'yz'
196
197   
198
199    <a name="#_read_hope_keyword_varnamein"></a>
200    <h4>varnamein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
201      <font size="-1" color="#006633">in</font>
202     
203     
204      <font size="-1" color="#006633">required</font>
205     
206      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
207     
208     
209    </h4>
210
211   
212 A string the name of the variable to be read (in
213 lower or upper case)
214
215   
216   
217
218   
219    <h3>Keywords</h3>
220
221   
222    <a name="#_read_hope_keyword_FILENAME"></a>
223    <h4>FILENAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
224     
225     
226     
227     
228     
229      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
230     
231     
232    </h4>
233
234   
235 The name of the file to be read
236
237   
238    <a name="#_read_hope_keyword_XLIMITS"></a>
239    <h4>XLIMITS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
240     
241     
242     
243     
244     
245      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
246     
247     
248    </h4>
249
250   
251 A two elements vector [lonmin, lonmax]]
252 the boundary of the longitudes (from 0 to 360)
253
254   
255    <a name="#_read_hope_keyword_YLIMITS"></a>
256    <h4>YLIMITS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
257     
258     
259     
260     
261     
262      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
263     
264     
265    </h4>
266
267   
268 A two elements vector [latmin, latmax]]
269 the boundary of the latitudes (from -90 to 90)
270
271   
272    <a name="#_read_hope_keyword_ZLIMITS"></a>
273    <h4>ZLIMITS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
274     
275     
276     
277     
278     
279      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
280     
281     
282    </h4>
283
284   
285 A two elements vector [depthmin, depthmax]]
286 the boundary of the depth
287
288   
289    <a name="#_read_hope_keyword_TLIMITS"></a>
290    <h4>TLIMITS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
291     
292     
293     
294     
295     
296      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
297     
298     
299    </h4>
300
301   
302 A two elements vector [date1, date2]]
303 the boundary of the calendar with date1 and date2
304 folowing the syntax yyyymmdd
305
306   
307    <a name="#_read_hope_keyword_ODDPT"></a>
308    <h4>ODDPT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
309     
310     
311     
312     
313     
314     
315     
316     
317    </h4>
318
319   
320 Activate to read only the sections located on ODD
321 points
322
323   
324    <a name="#_read_hope_keyword_ODDEVENPT"></a>
325    <h4>ODDEVENPT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
326     
327     
328     
329     
330     
331     
332     
333     
334    </h4>
335
336   
337 Activate to read only the sections located on
338 both even and odd points (horizontal sections)
339
340   
341    <a name="#_read_hope_keyword_EVENPT"></a>
342    <h4>EVENPT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
343     
344     
345     
346     
347     
348     
349     
350     
351    </h4>
352
353   
354 Activate to read only the sections located on even
355 points
356
357   
358    <a name="#_read_hope_keyword__extra"></a>
359    <h4>_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
360     
361     
362     
363     
364     
365     
366     
367     
368    </h4>
369
370   
371 Used to pass your keywords
372
373   
374   
375
376    <h3>Examples</h3>
377
378     IDL> a=read_hope('xy','ocpt',filename='CLIM_CNT_1993-1998.nc')
379     IDL> help, a,/struct
380     ** Structure <82ec344>, 6 tags, length=1860176, refs=1:
381        ARRAY           FLOAT     Array[128, 242, 15]
382        UNIT            STRING    'deg C'
383        NAME            STRING    'Ocean potential temperature'
384        DATE            FLOAT     Array[1]
385        GRID            STRING    'T'
386        HOPEGRID        STRUCT    -> <Anonymous> Array[1]
387     IDL> help, a.hopegrid,/struct
388     ** Structure <82eb9cc>, 8 tags, length=1588, refs=2:
389        XAXIS           FLOAT     Array[128]
390        YAXIS           FLOAT     Array[242]
391        ZAXIS           FLOAT     Array[15]
392        FIRSTS          LONG      Array[3]
393        LASTS           LONG      Array[3]
394        TYPE            STRING    'xy'
395        LINETYPE        STRING    'odd-even'
396        PTTYPE          STRING    'T'
397     IDL> help, litchamp(a)
398     <Expression>    FLOAT     = Array[128, 242, 15]
399
400    <h3>Version history</h3>
401   
402    <h4>Version</h4>
403 $Id: read_hope.pro 157 2006-08-21 09:01:50Z navarro $
404
405    <h4>History</h4>
406 Sebastien Masson (smasson@lodyc.jussieu.fr)
407                      June 2001
408
409   
410
411    <h3>Known issues</h3>
412   
413   
414   
415    <h4>Restrictions</h4>
416 'x', 'y', 'z', 't', 'xt', 'yt' and 'zt' section not coded, xconv
417 must be able to works with this kind of function.
418 The grid file has no zoom possibilities on horizontal dimensions.
419
420
421
422 When typein and varnamein are defined, the method to find the
423 good variable is:
424  1) find the variables which are available on this type of
425 sections with this name
426  2) if ODDPT, EVENPT or ODDEVENPT are specified, consider only
427 these types of sections
428  3) For an XY section the chosen variable is the one which has
429 the most level in the vertical domain specified by ZLIMITS.
430     For an XZ section the chosen variable is the one which has
431 the most points in the latitude domain specified by YLIMITS.
432     For an YZ section the chosen variable is the one which has
433 the most points in the longitude domain specified by XLIMITS.
434
435
436
437    <h3>Other attributes</h3>
438   
439   
440    <h4>Uses routines</h4>
441 common.pro (useful only for the definition of iodir)
442
443   
444   
445   
446
447    <font size="-3"><p>&nbsp;</p></font>
448    <hr size="1" color="#CCCCCC"/>
449     
450
451   
452
453    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:49:59 2006.</font></p>
454
455  </body>
456</html>
Note: See TracBrowser for help on using the repository browser.