source: trunk/SRC/Documentation/idldoc_html_output/ReadWrite/idl-NetCDF/ncdf_quickread/ncdf_quickread_helper.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 11.6 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>ncdf_quickread_helper.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="ncdf_quickread_helper.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="../../../../../ReadWrite/idl-NetCDF/ncdf_quickread//ncdf_quickread_helper.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&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="ncdf_quickread.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="ncdf_quickread_helper.html" target="_TOP">view single page</a> | <a href="./../../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&nbsp;&nbsp;&nbsp;&nbsp;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">ReadWrite/idl-NetCDF/ncdf_quickread/</a></h1>
82      <h2 class="pro_file">ncdf_quickread_helper.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 This function returns the filename name from the full path.
91
92
93 This function returns the directory name from the full path.
94
95
96 This routine ensures that the given name does not start with a number,
97 nor contain a dash.  IDL cannot accept a variable starting with a
98 number or containing a dash.  If the name starts with a number, an
99 underscore is prepended to the name, and if it contains a dash, the
100 dash is replaced with an underscore.
101
102
103 This procedure creates a script to read the data in a given netCDF
104 file into IDL.  The default output file is the name of the netCDF
105 file with idl replacing any existing suffix.  The default output is
106 variable data only.
107</div>
108
109     
110
111     
112
113     
114
115     
116      <div id="routine_summary">               
117        <h2>Routine summary</h2>
118       
119        <dl>
120         
121          <dt><p><a href="#_ncdf_quickread_getfile"><span class="result">result = </span>ncdf_quickread_getfile(<span class="result">fullpath</span>, suffix=<span class="result">suffix</span>)</a></p><dt>
122          <dd></dd>     
123         
124          <dt><p><a href="#_ncdf_quickread_getdir"><span class="result">result = </span>ncdf_quickread_getdir(<span class="result">fullpath</span>)</a></p><dt>
125          <dd></dd>     
126         
127          <dt><p><a href="#_ncdf_quickread_validatename"><span class="result">result = </span>ncdf_quickread_validatename(<span class="result">varname</span>)</a></p><dt>
128          <dd></dd>     
129         
130          <dt><p><a href="#_ncdf_quickread_helper"><span class="result">result = </span>ncdf_quickread_helper(<span class="result">infile</span>, verbose=<span class="result">verbose</span>, prefix=<span class="result">prefix</span>, fields=<span class="result">fields</span>, reform=<span class="result">reform</span>)</a></p><dt>
131          <dd></dd>     
132               
133        </dl>
134      </div>
135     
136
137      <div id="routine_details">
138       
139
140        <div class="routine_details" id="_ncdf_quickread_getfile">
141
142          <h2><a class="top" href="#container">top</a>ncdf_quickread_getfile <span class="categories">
143
144</span></h2>
145       
146          <p class="header">
147            <span class="result">result = </span>ncdf_quickread_getfile(<span class="result"><a href="#_ncdf_quickread_getfile_param_fullpath">fullpath</a></span>, <a href="#_ncdf_quickread_getfile_keyword_suffix">suffix</a>=<span class="result">suffix</span>)</p>
148       
149          <div class="comments"></div>
150
151          <h3>Return value</h3><div class="preformat">
152 file - filename
153</div>
154
155         
156            <h3>Parameters</h3>
157       
158           
159            <h4 id="_ncdf_quickread_getfile_param_fullpath">fullpath&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
160             
161             
162             
163             
164             
165             
166             
167             
168            </h4>
169       
170          <div class="comments">
171 full directory+file path
172</div>
173           
174
175         
176
177         
178
179            <h3>Keywords</h3>
180           
181            <h4 id="_ncdf_quickread_getfile_keyword_suffix">suffix&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
182             
183             
184             
185             
186             
187             
188             
189             
190            </h4>
191       
192            <div class="comments">
193 include input suffix in output file name
194</div>
195           
196         
197
198          <h3>Examples</h3><div class="preformat">
199 Call: file = ncdf_quickread_getfile(fullpath)
200</div>
201          <h3>Version history</h3>
202         
203          <h4>Version</h4><div class="preformat">
204 $Id: ncdf_quickread_helper.pro 325 2007-12-06 10:04:53Z pinsard $</div>
205          <h4>History</h4><div class="preformat">
206
207</div>
208         
209         
210          <h3>Known issues</h3>
211         
212         
213         
214          <h4>Restrictions</h4><div class="preformat">
215
216</div>
217       
218         
219         
220         
221         
222         
223         
224         
225       
226          <h3>Statistics</h3>
227          <table class="statistics">
228            <tr><td>McCabe cyclic</td><td>           3</td></tr>
229            <tr><td>McCabe essential</td><td>           1</td></tr>
230            <tr><td>McCabe modular design</td><td>           1</td></tr>
231          </table>
232         
233       
234        </div>
235       
236
237        <div class="routine_details" id="_ncdf_quickread_getdir">
238
239          <h2><a class="top" href="#container">top</a>ncdf_quickread_getdir <span class="categories">
240
241</span></h2>
242       
243          <p class="header">
244            <span class="result">result = </span>ncdf_quickread_getdir(<span class="result"><a href="#_ncdf_quickread_getdir_param_fullpath">fullpath</a></span>)</p>
245       
246          <div class="comments"></div>
247
248          <h3>Return value</h3><div class="preformat">
249 directory path
250</div>
251
252         
253            <h3>Parameters</h3>
254       
255           
256            <h4 id="_ncdf_quickread_getdir_param_fullpath">fullpath&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
257             
258             
259             
260             
261             
262             
263             
264             
265            </h4>
266       
267          <div class="comments">
268 full directory+file path
269</div>
270           
271
272         
273
274         
275
276          <h3>Examples</h3><div class="preformat">
277 Call: dir = ncdf_quickread_getdir(fullpath)
278</div>
279          <h3>Version history</h3>
280         
281          <h4>Version</h4><div class="preformat">
282 $Id: ncdf_quickread_helper.pro 325 2007-12-06 10:04:53Z pinsard $</div>
283          <h4>History</h4><div class="preformat">
284
285</div>
286         
287         
288          <h3>Known issues</h3>
289         
290         
291         
292          <h4>Restrictions</h4><div class="preformat">
293
294</div>
295       
296         
297         
298         
299         
300         
301         
302         
303       
304          <h3>Statistics</h3>
305          <table class="statistics">
306            <tr><td>McCabe cyclic</td><td>           2</td></tr>
307            <tr><td>McCabe essential</td><td>           1</td></tr>
308            <tr><td>McCabe modular design</td><td>           1</td></tr>
309          </table>
310         
311       
312        </div>
313       
314
315        <div class="routine_details" id="_ncdf_quickread_validatename">
316
317          <h2><a class="top" href="#container">top</a>ncdf_quickread_validatename <span class="categories">
318
319</span></h2>
320       
321          <p class="header">
322            <span class="result">result = </span>ncdf_quickread_validatename(<span class="result"><a href="#_ncdf_quickread_validatename_param_varname">varname</a></span>)</p>
323       
324          <div class="comments"></div>
325
326          <h3>Return value</h3><div class="preformat">
327
328</div>
329
330         
331            <h3>Parameters</h3>
332       
333           
334            <h4 id="_ncdf_quickread_validatename_param_varname">varname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
335             
336             
337             
338             
339             
340             
341             
342             
343            </h4>
344       
345          <div class="comments">
346 The name of the variable to be read
347
348</div>
349           
350
351         
352
353         
354
355          <h3>Examples</h3><div class="preformat">
356
357</div>
358          <h3>Version history</h3>
359         
360          <h4>Version</h4><div class="preformat">
361 $Id: ncdf_quickread_helper.pro 325 2007-12-06 10:04:53Z pinsard $</div>
362          <h4>History</h4><div class="preformat">
363
364</div>
365         
366         
367          <h3>Known issues</h3>
368         
369         
370         
371          <h4>Restrictions</h4><div class="preformat">
372
373</div>
374       
375         
376         
377         
378         
379         
380         
381         
382       
383          <h3>Statistics</h3>
384          <table class="statistics">
385            <tr><td>McCabe cyclic</td><td>          13</td></tr>
386            <tr><td>McCabe essential</td><td>           1</td></tr>
387            <tr><td>McCabe modular design</td><td>           1</td></tr>
388          </table>
389         
390       
391        </div>
392       
393
394        <div class="routine_details" id="_ncdf_quickread_helper">
395
396          <h2><a class="top" href="#container">top</a>ncdf_quickread_helper <span class="categories">
397
398</span></h2>
399       
400          <p class="header">
401            <span class="result">result = </span>ncdf_quickread_helper(<span class="result"><a href="#_ncdf_quickread_helper_param_infile">infile</a></span>, <a href="#_ncdf_quickread_helper_keyword_verbose">verbose</a>=<span class="result">verbose</span>, <a href="#_ncdf_quickread_helper_keyword_prefix">prefix</a>=<span class="result">prefix</span>, <a href="#_ncdf_quickread_helper_keyword_fields">fields</a>=<span class="result">fields</span>, <a href="#_ncdf_quickread_helper_keyword_reform">reform</a>=<span class="result">reform</span>)</p>
402       
403          <div class="comments"></div>
404
405          <h3>Return value</h3><div class="preformat">
406 array of commands to run at top level
407</div>
408
409         
410            <h3>Parameters</h3>
411       
412           
413            <h4 id="_ncdf_quickread_helper_param_infile">infile&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
414             
415             
416             
417             
418             
419             
420             
421             
422            </h4>
423       
424          <div class="comments">
425 full path to netCDF file of interest
426</div>
427           
428
429         
430
431         
432
433            <h3>Keywords</h3>
434           
435            <h4 id="_ncdf_quickread_helper_keyword_verbose">verbose&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
436             
437             
438             
439             
440             
441             
442             
443             
444            </h4>
445       
446            <div class="comments">
447 Set this keyword to return an error message in case of an error.
448</div>
449           
450            <h4 id="_ncdf_quickread_helper_keyword_prefix">prefix&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
451             
452             
453             
454             
455             
456             
457             
458             
459            </h4>
460       
461            <div class="comments">
462 see changelog above.
463</div>
464           
465            <h4 id="_ncdf_quickread_helper_keyword_fields">fields&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
466             
467             
468             
469             
470             
471             
472             
473             
474            </h4>
475       
476            <div class="comments">
477
478</div>
479           
480            <h4 id="_ncdf_quickread_helper_keyword_reform">reform&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
481             
482             
483             
484             
485             
486             
487             
488             
489            </h4>
490       
491            <div class="comments">
492 see changelog above
493</div>
494           
495         
496
497          <h3>Examples</h3><div class="preformat">
498
499</div>
500          <h3>Version history</h3>
501         
502          <h4>Version</h4><div class="preformat">
503 $Id: ncdf_quickread_helper.pro 325 2007-12-06 10:04:53Z pinsard $
504</div>
505          <h4>History</h4><div class="preformat">
506
507</div>
508         
509         
510          <h3>Known issues</h3>
511         
512         
513         
514          <h4>Restrictions</h4><div class="preformat">
515
516</div>
517       
518         
519         
520         
521         
522         
523         
524         
525       
526          <h3>Statistics</h3>
527          <table class="statistics">
528            <tr><td>McCabe cyclic</td><td>          17</td></tr>
529            <tr><td>McCabe essential</td><td>           1</td></tr>
530            <tr><td>McCabe modular design</td><td>           1</td></tr>
531          </table>
532         
533       
534        </div>
535       
536      </div>
537
538     
539
540      <div id="tagline">Produced by IDLdoc 2.0.</div>
541
542    </div>
543
544  </body>
545</html>
Note: See TracBrowser for help on using the repository browser.