Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ReadWrite/idl-NetCDF/ncdf_quickread/ncdf_quickread_helper.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: 21.8 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	<style type="text/css" media="all">
13
14	/* CSS for all files which appear in the "main" viewing area: overview,
15	directory overviews, warnings, index, search, pro files, source
16	code, help, and etc files. */
17
18	/* Link styles --------------------------------------------------------------- */
19
20	a { text-decoration: none; }
21
22	a:link, a:visited {
23	color: #660000;
24	border-bottom: 1px dotted #C0C0F0;
25	}
26
27	a:hover, a:focus {
28	color: #993333;
29	background: #FFFFCC;
30	border-bottom: 1px dotted #303099;
31	}
32
33
34	/* Main styles --------------------------------------------------------------- */
35	p.preformat {
36	font-family: Courier;
37	}
38
39	body {
40	margin: 0;
41	padding: 0;
42	font-size: 10pt;
43	font-family: Verdana, Helvetica, Arial, sans-serif;
44	background-color: #FFFFFF;
45	}
46
47	p {
48	margin-top: 0.5em;
49	margin-bottom: 0;
50	}
51
52	#container { margin: 1em; }
53
54	code.section { white-space: pre; }
55
56	pre.snippet {
57	margin-left: 5%;
58	background: #F0F0F0;
59	border: 1px dashed #999999;
60	width: 43em;
61	padding: 0.5em 0.5em 0.5em 0.5em;
62	white-space: pre;
63	}
64
65	/* Navbar styles ------------------------------------------------------------- */
66
67	#navbar_title {
68	color: #000033;
69	background-color: #F0F0FF;
70	font-family: Arial, Helvetica, sans-serif;
71	padding: 20px 30px;
72	border-bottom: 1px solid #000033;
73	}
74
75	#navbar_title * {
76	margin: 0;
77	padding: 0;
78	}
79
80	#navbar_title h1 {
81	letter-spacing: 0.1em;
82	font-variant: small-caps;
83	font-size: 250%;
84	text-indent: -1em;
85	padding-left: 1em;
86	}
87
88	#navbar_title h2 {
89	font-size: 110%;
90	font-weight: normal;
91	color: #333399;
92	}
93
94	#main_navbar table {
95	width: 100%;
96	border-bottom: 1px solid #666699;
97	}
98
99	#main_navbar td {
100	background: #CCCCFF;
101	font-size: 80%;
102	font-weight: bold;
103	font-family: Arial, Helvetica, sans-serif;
104	border-top: 3px solid #CCCCFF;
105	border-bottom: 3px solid #CCCCFF;
106	padding-left: 6px;
107	padding-right: 6px;
108	margin: 0;
109	}
110
111	#main_navbar td#selected {
112	background: #CCCCFF;
113	font-size: 80%;
114	font-weight: bold;
115	font-family: Arial, Helvetica, sans-serif;
116	border-top: 3px solid #333399;
117	border-bottom: 3px solid #CCCCFF;
118	padding-left: 6px;
119	padding-right: 6px;
120	margin: 0;
121	}
122
123	#main_navbar td#flexible {
124	width: 100%;
125	text-align: right;
126	padding-right: 1em;
127	background: #CCCCFF;
128	font-size: 70%;
129	font-weight: normal;
130	font-family: Arial, Helvetica, sans-serif;
131	text-transform: uppercase;
132	border-top: 3px solid #CCCCFF;
133	border-bottom: 3px solid #CCCCFF;
134	}
135
136	#main_navbar a:link, #main_navbar a:visited { color: #660000; border: 0; }
137
138	#main_navbar a:hover, #main_navbar a:focus {
139	color: #FFFF66;
140	background: #CCCCFF;
141	border-bottom: 1px none #606099;
142	border: 0;
143	}
144
145	#secondary_navbar {
146	font-size: 80%;
147	font-weight: normal;
148	font-family: Arial, Helvetica, sans-serif;
149	margin-top: 4px;
150	margin-left: 20px;
151	white-space: nowrap;
152	}
153
154
155	/* Tagline and footer styles ------------------------------------------------- */
156
157	div#tagline {
158	margin-top: 6px;
159	border-top: 1px dotted lightsteelblue;
160	padding-top: 6px;
161	font-size: 66%;
162	font-style: italic;
163	}
164
165	div#footer {
166	margin-top: 6px;
167	border-top: 1px dotted lightsteelblue;
168	padding-top: 6px;
169	font-size: 66%;
170	font-style: italic;
171	}
172
173	/* Basic data presenation styles -------------------------------------------- */
174
175	.index_letter {
176	font-size: 300%;
177	font-weight: bold;
178	color: #000066;
179	margin: 0.5em 0 0 -0.1em;
180	}
181
182	h1, h2, h3, h4 {
183	font-weight: normal;
184	color: #3333CC;
185	}
186
187	h1 {
188	padding-top: 0.75em;
189	font-size: 160%;
190	}
191
192	h2 {
193	padding-top: 1em;
194	font-size: 120%;
195	}
196
197	h3 {
198	padding-top: 0.75em;
199	margin-bottom: 0.25em;
200	font-size: 100%;
201	}
202
203	h4 {
204	padding: 0;
205	margin: 0.5em 0 0 0;
206	font-size: 80%;
207	}
208
209	table.basic {
210	empty-cells: show;
211	margin: 1.5em 1em 0 1em;
212	border: 1px dotted #CFCFFF;
213	font-size: 80%;
214	}
215
216	table.basic th {
217	background-color: #F0F0FF;
218	font-weight: bold;
219	text-align: left;
220	padding: 4px 1em 4px 4px;
221	border-bottom: 1px dotted #666699;
222	}
223
224	table.basic td {
225	vertical-align: top;
226	padding: 4px 1em 4px 4px;
227	}
228
229	dd {
230	margin-bottom: 0.25em;
231	font-size: 80%;
232	}
233
234
235	/* Warnings styles ----------------------------------------------------------- */
236
237
238	#todo dl, #bugs dl {
239	margin: 0 0 0 1.5em;
240	font-size: 80%;
241	}
242
243	#todo dd, #bugs dd {
244	margin-left: 3em;
245	font-size: 100%;
246	}
247
248	#undoc table, #obsolete table, #statistics table {
249	width: 80%;
250	margin-left: 2em;
251	}
252
253	#undoc td, #obsolete td, #statistics td {
254	padding: 0 0 0 0;
255	font-size: 80%;
256	white-space: nowrap;
257	}
258
259	#undoc td.docroutine, #obsolete td.obsroutine, #statistics td.statroutine { width: 50%; }
260
261	#undoc td.docstat, #statistics td.stat {
262	width: 50%;
263	text-align: right;
264	}
265
266	#undoc td.partialdoc, #statistics td.caution { color: #CC6600; }
267
268	#undoc td.notdoc, #statistics td.warning { color: #993333; }
269
270	/* File + routine styles ----------------------------------------------------- */
271
272	h1.directory {
273	padding: 1em 0 0 0;
274	margin: 0;
275	font-size: 66%;
276	}
277
278	h1.directory a { border-bottom: 0; }
279
280	h2.pro_file {
281	padding: 0;
282	margin: 0;
283	font-size: 140%;
284	}
285
286	div#file_attr {
287	padding: 0 1em 0 1em;
288	margin: 1em;
289	background: #F6F6F6;
290	border: 1px dotted #999999;
291	}
292
293	div#file_attr dt {
294	font-size: 80%;
295	font-weight: bold;
296	}
297
298	div#file_attr dd {
299	font-size: 80%;
300	}
301
302	div#class_diagram {
303	padding: 1em 0 1em 0;
304	white-space: pre;
305	font-family: 'Courier New';
306	}
307
308	table#sav_attr {
309	font-size: 90%;
310	margin: 1em;
311	padding: 1em 1em 1em 1em;
312	background: #F6F6F6;
313	border: 1px dotted #999999;
314	}
315
316	table#sav_attr th { text-align: left; }
317
318	table#sav_attr td { vertical-align: top; padding-right: 2em; }
319
320	table#sav_attr td.value { width: 20em; padding-right: 0em; font-style: italic; }
321
322	p.sav_warning { margin-left: 4em; font-family: 80%; }
323
324	table.variables {
325	font-family: 'Courier New', monospace;
326	font-size: 80%;
327	text-indent: -2em;
328	padding-left: 2em;
329	}
330
331	table.variables td.image { width: 64px; }
332
333	div#file_comments { white-space: pre;
334	margin: 2em;
335	font-size: 80%;
336	}
337
338
339	div.field_summary {
340	padding: 0 1em 0 1em;
341	margin: 1em;
342	background: #FFFFF0;
343	border: 1px dotted #C0C000;
344	}
345
346	div#routine_summary {
347	padding: 0 1em 0 1em;
348	margin: 1em;
349	background: #F0F0FF;
350	border: 1px dotted #9999FF;
351	}
352
353	div.field_summary h2, div#routine_summary h2 {
354	padding: 0.5em 0 0 0;
355	margin: 0;
356	}
357
358	div.field_summary table, div.field_summary p {
359	margin: 1em 1em;
360	}
361
362	div.field_summary td.name {
363	vertical-align: top;
364	padding-bottom: 0.25em;
365	color: #3333CC;
366	}
367
368	div.field_summary span.field_type {
369	font-weight: normal;
370	font-size: 80%;
371	color: black;
372	}
373
374	div.field_summary td.comments {
375	vertical-align: top;
376	padding-left: 2em;
377	font-size: 80%;
378	}
379
380	p.commaList {
381	margin: 1em 1em 1em 1em;
382	}
383
384	span.warning {
385	color: #CC6633;
386	font-weight: bold;
387	font-size: 66%;
388	text-transform: uppercase;
389	}
390
391	span.categories {
392	color: #006633;
393	font-weight: bold;
394	font-size: 66%;
395	text-transform: uppercase;
396	}
397
398	span.undoc {
399	color: #FF6633;
400	font-weight: bold;
401	font-size: 80%;
402	text-transform: uppercase;
403	}
404
405	span.attr {
406	color: #006633;
407	font-weight: bold;
408	font-size: 80%;
409	text-transform: uppercase;
410	}
411
412	span.value {
413	color: #006633;
414	font-weight: normal;
415	text-transform: none;
416	}
417
418	a.top {
419	font-weight: bold;
420	font-size: 66%;
421	text-transform: uppercase;
422	float: right;
423	}
424
425	span.result {
426	font-family: Verdana, Arial, Helvetica, sans-serif;
427	font-style: italic;
428	font-size: 80%;
429	}
430
431	div#routine_summary p, div.routine_details p.header {
432	padding-top: 0.5em;
433	margin-left: 1.5em;
434	text-indent: -1.5em;
435	font-family: 'Courier New', monospace;
436	}
437
438	div.routine_details {
439	padding: 0.5em 1em 0.5em 1em;
440	margin: 1em;
441	border: 1px dotted #CCCCCC;
442	}
443
444	div.routine_details h2 {
445	padding-top: 0;
446	margin-top: 0;
447	}
448
449	div.routine_details div.value {
450	margin: 0 1em 0 1em;
451	font-size: 80%;
452	}
453
454	div.routine_details div.comments {
455	font-size: 80%;
456	margin: 0.75em 1em 1em 1em;
457	}
458
459	div.routine_details div.preformat {
460	white-space: pre;
461	}
462
463	table.statistics {
464	font-size: 80%;
465	margin-left: 1em;
466	}
467
468	table.statistics td {
469	padding: 0 2em 0 0;
470	}
471
472	/* Overview styles ----------------------------------------------------------- */
473
474	div.overview {
475	width: 100%;
476	margin-top: 1em;
477	clear: both;
478	}
479
480	div.overview table {
481	empty-cells: show;
482	font-size: 90%;
483	margin: 1em 1em 1em 1em;
484	padding: 1em 0.5em 1em 0.5em;
485	background: #F6F6F6;
486	border: 1px dotted #999999;
487	}
488
489	div.overview td {
490	padding: 3px 1em 3px 1em;
491	}
492
493	div.overview td.dir {
494	width: 1%;
495	vertical-align: top;
496	text-align: right;
497	padding-right: 1em;
498	}
499
500
501	/* Navigation list styles for tree structures -------------------------------- */
502
503	#tree {
504	text-align: left;
505	font-size: 90%;
506	margin: 0.75em 0 0.75em 0;
507	padding: 0;
508	}
509
510	#tree ul {
511	text-align: left;
512	margin: 0;
513	padding: 0;
514	}
515
516	#tree li {
517	margin: 0 0 0 15px;
518	padding: 0;
519	list-style-type: none;
520	}
521
522	#tree .symbols {
523	float: left;
524	width: 12px;
525	height: 1em;
526	padding-left: 4px;
527	background-position: 0 100%;
528	background-repeat: no-repeat;
529	}
530
531	/* Search styles ------------------------------------------------------------- */
532
533	input.writein {
534	padding-left: 0.5em;
535	border: 1px solid #CCCCCC;
536	font-family: 'Courier New';
537	background: #FFFFF3;
538	}
539
540	#search form {
541	margin-left: 2em;
542	}
543
544	#search table {
545	margin: 1em 1em 0 2em;
546	padding: 1em 2em 1em 2em;
547	background: #F6F6F6;
548	border: 1px dotted #999999;
549	}
550
551	#search tr {
552	text-align: center;
553	}
554
555	#search td {
556	font-size: 80%;
557	text-align: left;
558	}
559
560	#search td * {
561	vertical-align: middle;
562	}
563
564	#search p {
565	font-size: 66%;
566	margin: 0 3em 2em 3em;
567	}
568
569	/* Help styles --------------------------------------------------------------- */
570
571	div.toc {
572	padding: 0 1em 0 1em;
573	margin: 1em;
574	background: #F0F0FF;
575	border: 1px dotted #9999FF;
576	width: 19em;
577	}
578
579	div.right {
580	float: right;
581	width: 22em;
582	}
583
584	ol.toc {
585	list-style-type: upper-roman;
586	}
587
588	ol.toc ol {
589	padding-left: 3em;
590	margin-left: 0;
591	list-style-type: lower-alpha;
592	}
593
594	dl.variables dt { font-size: 80%; }
595	dl.variables dd { margin-bottom: 0.5em; }
596
597	</style>
598	<style type="text/css" media="print">
599	#navbar_title {
600	background-color: #FFFFFF;
601	}
602
603	#main_navbar td {
604	background: #FFFFFF;
605	border-top: 0.25em solid #FFFFFF;
606	border-bottom: 0.25em solid #FFFFFF;
607	}
608
609	#main_navbar td#selected {
610	background: #FFFFFF;
611	border-top: 0.25em solid #333399;
612	border-bottom: 0.25em solid #FFFFFF;
613	}
614
615	#main_navbar td#flexible {
616	background: #FFFFFF;
617	border-top: 0.25em solid #FFFFFF;
618	border-bottom: 0.25em solid #FFFFFF;
619	}
620
621	#secondary_navbar {
622	display: none;
623	}
624
625	</style>
626
627
628	<script type="text/javascript">
629	function setTitle() {
630	parent.document.title="ncdf_quickread_helper.pro (SAXO Documentation)";
631	}
632	</script>
633	</head>
634
635	<body onload="setTitle();">
636
637	<div id="navbar_title">
638	<h1>SAXO Documentation</h1>
639	</div>
640
641
642	<div id="main_navbar">
643
644	<table cellspacing="0">
645	<tr>
646
647	<td><a href="./../../../overview.html?format=raw" title="Overview of library">Overview</a></td>
648
649
650
651	<td >Directory</td>
652
653
654
655	<td><a href="./../../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
656
657
658
659	<td><a href="./../../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
660
661
662
663	<td><a href="./../../../search-page.html?format=raw" title="Search library">Search</a></td>
664
665
666	<td id="selected">File</td>
667
668
669	<td >Source</td>
670
671
672
673	<td><a href="./../../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
674
675
676	<td >Etc</td>
677
678	<td id="flexible">Developer documentation</td>
679	</tr>
680	</table>
681
682	</div>
683
684	<div id="secondary_navbar">
685
686	<a href="ncdf_quickread.html?format=raw"><<prev file</a> \| next file >>    <a href="ncdf_quickread_helper.html?format=raw" target="_TOP">view single page</a> \| <a href="./../../../index.html?format=raw" target="_TOP">view frames</a>    summary: fields \| <a href="#routine_summary">routine</a>    details: <a href="#routine_details">routine</a>
687
688	</div>
689
690
691	<div id="container">
692
693	<h1 class="directory"><a href="directory-overview.html?format=raw">ReadWrite/idl-NetCDF/ncdf_quickread/</a></h1>
694	<h2 class="pro_file">ncdf_quickread_helper.pro</h2>
695
696	<div id="file_attr">
697	<dl>
698	</dl>
699	</div>
700
701	<div id="file_comments">
702	This function returns the filename name from the full path.
703
704
705	This function returns the directory name from the full path.
706
707
708	This routine ensures that the given name does not start with a number,
709	nor contain a dash. IDL cannot accept a variable starting with a
710	number or containing a dash. If the name starts with a number, an
711	underscore is prepended to the name, and if it contains a dash, the
712	dash is replaced with an underscore.
713
714
715	This procedure creates a script to read the data in a given netCDF
716	file into IDL. The default output file is the name of the netCDF
717	file with idl replacing any existing suffix. The default output is
718	variable data only.
719	</div>
720
721
722
723
724
725
726
727
728	<div id="routine_summary">
729	<h2>Routine summary</h2>
730
731	<dl>
732
733	<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>
734	<dd></dd>
735
736	<dt><p><a href="#_ncdf_quickread_getdir"><span class="result">result = </span>ncdf_quickread_getdir(<span class="result">fullpath</span>)</a></p><dt>
737	<dd></dd>
738
739	<dt><p><a href="#_ncdf_quickread_validatename"><span class="result">result = </span>ncdf_quickread_validatename(<span class="result">varname</span>)</a></p><dt>
740	<dd></dd>
741
742	<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>
743	<dd></dd>
744
745	</dl>
746	</div>
747
748
749	<div id="routine_details">
750
751
752	<div class="routine_details" id="_ncdf_quickread_getfile">
753
754	<h2><a class="top" href="#container">top</a>ncdf_quickread_getfile <span class="categories">
755
756	</span></h2>
757
758	<p class="header">
759	<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>
760
761	<div class="comments"></div>
762
763	<h3>Return value</h3><div class="preformat">
764	file - filename
765	</div>
766
767
768	<h3>Parameters</h3>
769
770
771	<h4 id="_ncdf_quickread_getfile_param_fullpath">fullpath
772
773
774
775
776
777
778
779
780	</h4>
781
782	<div class="comments">
783	full directory+file path
784	</div>
785
786
787
788
789
790
791	<h3>Keywords</h3>
792
793	<h4 id="_ncdf_quickread_getfile_keyword_suffix">suffix
794
795
796
797
798
799
800
801
802	</h4>
803
804	<div class="comments">
805	include input suffix in output file name
806	</div>
807
808
809
810	<h3>Examples</h3><div class="preformat">
811	Call: file = ncdf_quickread_getfile(fullpath)
812	</div>
813	<h3>Version history</h3>
814
815	<h4>Version</h4><div class="preformat">
816	$Id: ncdf_quickread_helper.pro 157 2006-08-21 09:01:50Z navarro $</div>
817	<h4>History</h4><div class="preformat">
818
819	</div>
820
821
822	<h3>Known issues</h3>
823
824
825
826	<h4>Restrictions</h4><div class="preformat">
827
828	</div>
829
830
831
832
833
834
835
836
837
838	<h3>Statistics</h3>
839	<table class="statistics">
840	<tr><td>McCabe cyclic</td><td> 3</td></tr>
841	<tr><td>McCabe essential</td><td> 1</td></tr>
842	<tr><td>McCabe modular design</td><td> 1</td></tr>
843	</table>
844
845
846	</div>
847
848
849	<div class="routine_details" id="_ncdf_quickread_getdir">
850
851	<h2><a class="top" href="#container">top</a>ncdf_quickread_getdir <span class="categories">
852
853	</span></h2>
854
855	<p class="header">
856	<span class="result">result = </span>ncdf_quickread_getdir(<span class="result"><a href="#_ncdf_quickread_getdir_param_fullpath">fullpath</a></span>)</p>
857
858	<div class="comments"></div>
859
860	<h3>Return value</h3><div class="preformat">
861	directory path
862	</div>
863
864
865	<h3>Parameters</h3>
866
867
868	<h4 id="_ncdf_quickread_getdir_param_fullpath">fullpath
869
870
871
872
873
874
875
876
877	</h4>
878
879	<div class="comments">
880	full directory+file path
881	</div>
882
883
884
885
886
887
888	<h3>Examples</h3><div class="preformat">
889	Call: dir = ncdf_quickread_getdir(fullpath)
890	</div>
891	<h3>Version history</h3>
892
893	<h4>Version</h4><div class="preformat">
894	$Id: ncdf_quickread_helper.pro 157 2006-08-21 09:01:50Z navarro $</div>
895	<h4>History</h4><div class="preformat">
896
897	</div>
898
899
900	<h3>Known issues</h3>
901
902
903
904	<h4>Restrictions</h4><div class="preformat">
905
906	</div>
907
908
909
910
911
912
913
914
915
916	<h3>Statistics</h3>
917	<table class="statistics">
918	<tr><td>McCabe cyclic</td><td> 2</td></tr>
919	<tr><td>McCabe essential</td><td> 1</td></tr>
920	<tr><td>McCabe modular design</td><td> 1</td></tr>
921	</table>
922
923
924	</div>
925
926
927	<div class="routine_details" id="_ncdf_quickread_validatename">
928
929	<h2><a class="top" href="#container">top</a>ncdf_quickread_validatename <span class="categories">
930
931	</span></h2>
932
933	<p class="header">
934	<span class="result">result = </span>ncdf_quickread_validatename(<span class="result"><a href="#_ncdf_quickread_validatename_param_varname">varname</a></span>)</p>
935
936	<div class="comments"></div>
937
938	<h3>Return value</h3><div class="preformat">
939
940	</div>
941
942
943	<h3>Parameters</h3>
944
945
946	<h4 id="_ncdf_quickread_validatename_param_varname">varname
947
948
949
950
951
952
953
954
955	</h4>
956
957	<div class="comments">
958	The name of the variable to be read
959
960	</div>
961
962
963
964
965
966
967	<h3>Examples</h3><div class="preformat">
968
969	</div>
970	<h3>Version history</h3>
971
972	<h4>Version</h4><div class="preformat">
973	$Id: ncdf_quickread_helper.pro 157 2006-08-21 09:01:50Z navarro $</div>
974	<h4>History</h4><div class="preformat">
975
976	</div>
977
978
979	<h3>Known issues</h3>
980
981
982
983	<h4>Restrictions</h4><div class="preformat">
984
985	</div>
986
987
988
989
990
991
992
993
994
995	<h3>Statistics</h3>
996	<table class="statistics">
997	<tr><td>McCabe cyclic</td><td> 13</td></tr>
998	<tr><td>McCabe essential</td><td> 1</td></tr>
999	<tr><td>McCabe modular design</td><td> 1</td></tr>
1000	</table>
1001
1002
1003	</div>
1004
1005
1006	<div class="routine_details" id="_ncdf_quickread_helper">
1007
1008	<h2><a class="top" href="#container">top</a>ncdf_quickread_helper <span class="categories">
1009
1010	</span></h2>
1011
1012	<p class="header">
1013	<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>
1014
1015	<div class="comments"></div>
1016
1017	<h3>Return value</h3><div class="preformat">
1018	array of commands to run at top level
1019	</div>
1020
1021
1022	<h3>Parameters</h3>
1023
1024
1025	<h4 id="_ncdf_quickread_helper_param_infile">infile
1026
1027
1028
1029
1030
1031
1032
1033
1034	</h4>
1035
1036	<div class="comments">
1037	full path to netCDF file of interest
1038	</div>
1039
1040
1041
1042
1043
1044
1045	<h3>Keywords</h3>
1046
1047	<h4 id="_ncdf_quickread_helper_keyword_verbose">verbose
1048
1049
1050
1051
1052
1053
1054
1055
1056	</h4>
1057
1058	<div class="comments">
1059	Set this keyword to return an error message in case of an error.
1060	</div>
1061
1062	<h4 id="_ncdf_quickread_helper_keyword_prefix">prefix
1063
1064
1065
1066
1067
1068
1069
1070
1071	</h4>
1072
1073	<div class="comments">
1074	see changelog above.
1075	</div>
1076
1077	<h4 id="_ncdf_quickread_helper_keyword_fields">fields
1078
1079
1080
1081
1082
1083
1084
1085
1086	</h4>
1087
1088	<div class="comments">
1089
1090	</div>
1091
1092	<h4 id="_ncdf_quickread_helper_keyword_reform">reform
1093
1094
1095
1096
1097
1098
1099
1100
1101	</h4>
1102
1103	<div class="comments">
1104	see changelog above.
1105	</div>
1106
1107
1108
1109	<h3>Examples</h3><div class="preformat">
1110
1111	</div>
1112	<h3>Version history</h3>
1113
1114	<h4>Version</h4><div class="preformat">
1115	$Id: ncdf_quickread_helper.pro 157 2006-08-21 09:01:50Z navarro $
1116	</div>
1117	<h4>History</h4><div class="preformat">
1118
1119	</div>
1120
1121
1122	<h3>Known issues</h3>
1123
1124
1125
1126	<h4>Restrictions</h4><div class="preformat">
1127
1128	</div>
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138	<h3>Statistics</h3>
1139	<table class="statistics">
1140	<tr><td>McCabe cyclic</td><td> 17</td></tr>
1141	<tr><td>McCabe essential</td><td> 1</td></tr>
1142	<tr><td>McCabe modular design</td><td> 1</td></tr>
1143	</table>
1144
1145
1146	</div>
1147
1148	</div>
1149
1150
1151
1152	<div id="tagline">Produced by IDLdoc 2.0.</div>
1153
1154	</div>
1155
1156	</body>
1157	</html>

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

Download in other formats: