Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/read_ncdf.html @ 177

Last change on this file since 177 was 177, checked in by smasson, 18 years ago
updates of html files...
File size: 23.4 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_ncdf.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="read_ncdf.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><a href="../../../../ToBeReviewed/LECTURE//read_ncdf.pro?format=raw" title="Source code of a file">Source</a></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="read_ftp.html?format=raw"><<prev file</a> \| <a href="read_ncdf_varget.html?format=raw">next file >></a>    <a href="read_ncdf.html?format=raw" target="_TOP">view single page</a> \| <a href="./../../index.html?format=raw" target="_TOP">view frames</a>    summary: fields \| routine    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">ToBeReviewed/LECTURE/</a></h1>
694	<h2 class="pro_file">read_ncdf.pro</h2>
695
696	<div id="file_attr">
697	<dl>
698	</dl>
699	</div>
700
701	<div id="file_comments">
702	Reading function for the file net_cdf.
703	This program is less universal than ncdf_lec (it appeal to declared
704	variables in common.pro) but it is very easier to be used. It considerate
705	the declaration of the different zooms which have been defined
706	(ixminmesh...premierx...), the declaration of the variable key_shift...
707	To put it in a nutshell, the result of read_ncdf can be directly used in plt...
708	This is also this program which is used by default in our reading widgets.
709	</div>
710
711
712
713
714
715
716
717
718
719	<div id="routine_details">
720
721
722	<div class="routine_details" id="_read_ncdf">
723
724	<h2><a class="top" href="#container">top</a>read_ncdf <span class="categories">
725	Reading
726	</span></h2>
727
728	<p class="header">
729	<span class="result">result = </span>read_ncdf(<span class="result"><a href="#_read_ncdf_param_name">name</a>, <a href="#_read_ncdf_param_beginning">beginning</a>, <a href="#_read_ncdf_param_ending">ending</a>[, <a href="#_read_ncdf_param_compatibility">compatibility</a>]</span>, <a href="#_read_ncdf_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_read_ncdf_keyword_FILENAME">FILENAME</a>=<span class="result">string</span>, <a href="#_read_ncdf_keyword_PARENTIN">PARENTIN</a>=<span class="result">PARENTIN</span>, <a href="#_read_ncdf_keyword_TIMESTEP">TIMESTEP</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_TIMEVAR">TIMEVAR</a>=<span class="result">string</span>, <a href="#_read_ncdf_keyword_TOUT">TOUT</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_NOSTRUCT">NOSTRUCT</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL</a>=<span class="result">CONT_NOFILL</span>, <a href="#_read_ncdf_keyword_INIT">INIT</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_GRID">GRID</a>=<span class="result">GRID</span>, <a href="#_read_ncdf_keyword_FBASE2TBASE">FBASE2TBASE</a>=<span class="result">FBASE2TBASE</span>, <a href="#_read_ncdf_keyword_CALLITSELF">CALLITSELF</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_HFILENAME">HFILENAME</a>=<span class="result">string</span>, <a href="#_read_ncdf_keyword_ZETAFILENAME">ZETAFILENAME</a>=<span class="result">string</span>, <a href="#_read_ncdf_keyword_ZETAZERO">ZETAZERO</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
730
731	<div class="comments"></div>
732
733	<h3>Return value</h3><div class="preformat">
734	Structure readable by litchamp.pro or an array if NOSTRUCT is activated.
735	</div>
736
737
738	<h3>Parameters</h3>
739
740
741	<h4 id="_read_ncdf_param_name">name
742	<span class="attr">in</span>
743
744
745	<span class="attr">required</span>
746
747	<span class="attr">type:</span> <span class="value">string</span>
748
749
750	</h4>
751
752	<div class="comments">
753	It define the field to be read.
754	</div>
755
756	<h4 id="_read_ncdf_param_beginning">beginning
757	<span class="attr">in</span>
758
759
760	<span class="attr">required</span>
761
762
763
764
765	</h4>
766
767	<div class="comments">
768	Relative with the time axis.
769	These can be
770	- 2 date of the type yyyymmdd and in this case, we select dates
771	which are included between these two dates.
772	- 2 indexes which define between which and which time step we have
773	to extract the temporal dimension.
774	</div>
775
776	<h4 id="_read_ncdf_param_ending">ending
777	<span class="attr">in</span>
778
779
780	<span class="attr">required</span>
781
782
783
784
785	</h4>
786
787	<div class="comments">
788	Relative with the time axis.
789	See BEGINNING.
790	</div>
791
792	<h4 id="_read_ncdf_param_compatibility">compatibility
793	<span class="attr">in</span>
794
795	<span class="attr">optional</span>
796
797
798
799
800
801	</h4>
802
803	<div class="comments">
804	Useless, defined for compatibility
805	</div>
806
807
808
809
810
811
812	<h3>Keywords</h3>
813
814	<h4 id="_read_ncdf_keyword_BOXZOOM">BOXZOOM
815
816
817
818
819
820
821
822
823	</h4>
824
825	<div class="comments">
826	Contain the boxzoom on which we have to do the reading
827	</div>
828
829	<h4 id="_read_ncdf_keyword_FILENAME">FILENAME
830
831
832
833	<span class="attr">required</span>
834
835	<span class="attr">type:</span> <span class="value">string</span>
836
837
838	</h4>
839
840	<div class="comments">
841	It contains he file's name.
842	</div>
843
844	<h4 id="_read_ncdf_keyword_PARENTIN">PARENTIN
845
846
847
848
849
850
851
852
853	</h4>
854
855	<div class="comments"></div>
856
857	<h4 id="_read_ncdf_keyword_TIMESTEP">TIMESTEP
858
859
860
861
862
863	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
864	<span class="attr">default:</span> <span class="value">0</span>
865
866	</h4>
867
868	<div class="comments">
869	Specify that BEGINNING and ENDING refer to indexes of the time axis and not to dates
870	</div>
871
872	<h4 id="_read_ncdf_keyword_TIMEVAR">TIMEVAR
873
874
875
876
877
878	<span class="attr">type:</span> <span class="value">string</span>
879
880
881	</h4>
882
883	<div class="comments">
884	It define the name of the variable that
885	contains the time axis. This keyword can be useful if there
886	is no unlimited dimension or if the time axis selected by default
887	(the first 1D array with unlimited dimension) is not the good one.
888	</div>
889
890	<h4 id="_read_ncdf_keyword_TOUT">TOUT
891
892
893
894
895
896	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
897	<span class="attr">default:</span> <span class="value">0</span>
898
899	</h4>
900
901	<div class="comments">
902	We activate it if we want to read the file on the whole domain without
903	considerate the sub-domain defined by the boxzoom or
904	lon1,lon2,lat1,lat2,vert1,vert2.
905	</div>
906
907	<h4 id="_read_ncdf_keyword_NOSTRUCT">NOSTRUCT
908
909
910
911
912
913	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
914	<span class="attr">default:</span> <span class="value">0</span>
915
916	</h4>
917
918	<div class="comments">
919	We activate it if we do not want that read_ncdf send back a structure
920	but only the array referring to the field.
921	</div>
922
923	<h4 id="_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL
924
925
926
927
928
929
930
931
932	</h4>
933
934	<div class="comments"></div>
935
936	<h4 id="_read_ncdf_keyword_INIT">INIT
937
938
939
940
941
942	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
943	<span class="attr">default:</span> <span class="value">0</span>
944
945	</h4>
946
947	<div class="comments">
948	To call automatically initncdf, filename and thus
949	redefine all the grid parameters
950	</div>
951
952	<h4 id="_read_ncdf_keyword_GRID">GRID
953
954
955
956
957
958
959
960
961	</h4>
962
963	<div class="comments">
964	='[UTVWF]' to specify the type of grid. Default is (1)
965	based on the name of the file if the file ends by
966	GRID[._][TUVFW].NC (not case sensible) or (2) T if case (1)
967	is not found.
968	</div>
969
970	<h4 id="_read_ncdf_keyword_FBASE2TBASE">FBASE2TBASE
971
972
973
974
975
976
977
978
979	</h4>
980
981	<div class="comments"></div>
982
983	<h4 id="_read_ncdf_keyword_CALLITSELF">CALLITSELF
984
985
986
987
988
989	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
990	<span class="attr">default:</span> <span class="value">0</span>
991
992	</h4>
993
994	<div class="comments">
995	For ROMS outputs. Use by read_ncdf itself to access auxilliary data (h and zeta).
996	</div>
997
998	<h4 id="_read_ncdf_keyword_HFILENAME">HFILENAME
999
1000
1001
1002
1003
1004	<span class="attr">type:</span> <span class="value">string</span>
1005	<span class="attr">default:</span> <span class="value">FILENAME</span>
1006
1007	</h4>
1008
1009	<div class="comments">
1010	For ROMS outputs. The filename of the file where h vriable should be read
1011	</div>
1012
1013	<h4 id="_read_ncdf_keyword_ZETAFILENAME">ZETAFILENAME
1014
1015
1016
1017
1018
1019	<span class="attr">type:</span> <span class="value">string</span>
1020	<span class="attr">default:</span> <span class="value">FILENAME</span>
1021
1022	</h4>
1023
1024	<div class="comments">
1025	For ROMS outputs. The filename of the file where zeta vriable should be read
1026	</div>
1027
1028	<h4 id="_read_ncdf_keyword_ZETAZERO">ZETAZERO
1029
1030
1031
1032
1033
1034	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
1035	<span class="attr">default:</span> <span class="value">0</span>
1036
1037	</h4>
1038
1039	<div class="comments">
1040	For ROMS outputs. To define zeta to 0. instead of reading it
1041	</div>
1042
1043	<h4 id="_read_ncdf_keyword__EXTRA">_EXTRA
1044
1045
1046
1047
1048
1049
1050
1051
1052	</h4>
1053
1054	<div class="comments">
1055	Used to pass your keywords
1056	</div>
1057
1058
1059
1060
1061	<h3>Version history</h3>
1062
1063	<h4>Version</h4><div class="preformat">
1064	$Id: read_ncdf.pro 174 2006-09-12 07:07:57Z smasson $ </div>
1065	<h4>History</h4><div class="preformat">
1066	Sebastien Masson (smasson@lodyc.jussieu.fr)
1067	15/10/1999
1068	</div>
1069
1070
1071	<h3>Known issues</h3>
1072
1073
1074
1075	<h4>Restrictions</h4><div class="preformat">
1076	The field must have a temporal dimension.
1077	</div>
1078
1079	<h3>Other attributes</h3>
1080
1081
1082	<h4>Uses routines</h4><div class="preformat">
1083	common.pro
1084	</div>
1085
1086
1087
1088
1089	<h3>Statistics</h3>
1090	<table class="statistics">
1091	<tr><td>McCabe cyclic</td><td> 144</td></tr>
1092	<tr><td>McCabe essential</td><td> 1</td></tr>
1093	<tr><td>McCabe modular design</td><td> 1</td></tr>
1094	</table>
1095
1096
1097	</div>
1098
1099	</div>
1100
1101
1102
1103	<div id="tagline">Produced by IDLdoc 2.0.</div>
1104
1105	</div>
1106
1107	</body>
1108	</html>

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

Download in other formats: