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

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

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