Context Navigation

source: trunk/SRC/Documentation/idldoc_html_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: 22.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_hope.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_hope.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="findlineandpointtype.html?format=raw"><<prev file</a> \| <a href="rh_alldomains.html?format=raw">next file >></a>    <a href="read_hope.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">ToBeReviewed/HOPE/</a></h1>
694	<h2 class="pro_file">read_hope.pro</h2>
695
696	<div id="file_attr">
697	<dl>
698	</dl>
699	</div>
700
701	<div id="file_comments">
702
703
704
705	Read the Hope grid file converted in NetCdf by xconv
706	</div>
707
708
709
710
711
712
713
714
715	<div id="routine_summary">
716	<h2>Routine summary</h2>
717
718	<dl>
719
720	<dt><p><a href="#_read_hope_event">read_hope_event<span class="result">, event</span></a></p><dt>
721	<dd></dd>
722
723	<dt><p><a href="#_read_hope"><span class="result">result = </span>read_hope(<span class="result">typein, varnamein</span>, FILENAME=<span class="result">string</span>, XLIMITS=<span class="result">vector</span>, YLIMITS=<span class="result">vector</span>, ZLIMITS=<span class="result">vector</span>, TLIMITS=<span class="result">vector</span>, ODDPT=<span class="result">ODDPT</span>, ODDEVENPT=<span class="result">ODDEVENPT</span>, EVENPT=<span class="result">EVENPT</span>, _extra=<span class="result">_extra</span>)</a></p><dt>
724	<dd> </dd>
725
726	</dl>
727	</div>
728
729
730	<div id="routine_details">
731
732
733	<div class="routine_details" id="_read_hope_event">
734
735	<h2><a class="top" href="#container">top</a>read_hope_event <span class="categories">
736
737	</span></h2>
738
739	<p class="header">
740	read_hope_event<span class="result">, <a href="#_read_hope_event_param_event">event</a></span></p>
741
742	<div class="comments"></div>
743
744	<h3>Return value</h3><div class="preformat">
745
746	</div>
747
748
749	<h3>Parameters</h3>
750
751
752	<h4 id="_read_hope_event_param_event">event
753
754
755
756
757
758
759
760
761	</h4>
762
763	<div class="comments">
764
765	</div>
766
767
768
769
770
771
772	<h3>Examples</h3><div class="preformat">
773
774	</div>
775	<h3>Version history</h3>
776
777	<h4>Version</h4><div class="preformat">
778	$Id: read_hope.pro 157 2006-08-21 09:01:50Z navarro $
779	</div>
780	<h4>History</h4><div class="preformat">
781
782	</div>
783
784
785	<h3>Known issues</h3>
786
787
788
789	<h4>Restrictions</h4><div class="preformat">
790
791	</div>
792
793
794
795
796
797
798
799
800
801	<h3>Statistics</h3>
802	<table class="statistics">
803	<tr><td>McCabe cyclic</td><td> 39</td></tr>
804	<tr><td>McCabe essential</td><td> 1</td></tr>
805	<tr><td>McCabe modular design</td><td> 1</td></tr>
806	</table>
807
808
809	</div>
810
811
812	<div class="routine_details" id="_read_hope">
813
814	<h2><a class="top" href="#container">top</a>read_hope <span class="categories">
815	Reading
816	</span></h2>
817
818	<p class="header">
819	<span class="result">result = </span>read_hope(<span class="result"><a href="#_read_hope_param_typein">typein</a>, <a href="#_read_hope_param_varnamein">varnamein</a></span>, <a href="#_read_hope_keyword_FILENAME">FILENAME</a>=<span class="result">string</span>, <a href="#_read_hope_keyword_XLIMITS">XLIMITS</a>=<span class="result">vector</span>, <a href="#_read_hope_keyword_YLIMITS">YLIMITS</a>=<span class="result">vector</span>, <a href="#_read_hope_keyword_ZLIMITS">ZLIMITS</a>=<span class="result">vector</span>, <a href="#_read_hope_keyword_TLIMITS">TLIMITS</a>=<span class="result">vector</span>, <a href="#_read_hope_keyword_ODDPT">ODDPT</a>=<span class="result">ODDPT</span>, <a href="#_read_hope_keyword_ODDEVENPT">ODDEVENPT</a>=<span class="result">ODDEVENPT</span>, <a href="#_read_hope_keyword_EVENPT">EVENPT</a>=<span class="result">EVENPT</span>, <a href="#_read_hope_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p>
820
821	<div class="comments">
822	</div>
823
824	<h3>Return value</h3><div class="preformat">
825	-1 if typein and varnamein are undefine (this is the widget
826	version)
827
828	A structure which but be read by litchamp.pro and is
829	necessary to complete the grid associated to the data (see
830	the example).
831	</div>
832
833
834	<h3>Parameters</h3>
835
836
837	<h4 id="_read_hope_param_typein">typein
838	<span class="attr">in</span>
839
840
841	<span class="attr">required</span>
842
843	<span class="attr">type:</span> <span class="value">string</span>
844
845
846	</h4>
847
848	<div class="comments">
849	A string specifying from which type of section the 4D
850	array based: 'xy, 'xz', 'yz'
851	</div>
852
853	<h4 id="_read_hope_param_varnamein">varnamein
854	<span class="attr">in</span>
855
856
857	<span class="attr">required</span>
858
859	<span class="attr">type:</span> <span class="value">string</span>
860
861
862	</h4>
863
864	<div class="comments">
865	A string the name of the variable to be read (in
866	lower or upper case)
867	</div>
868
869
870
871
872
873
874	<h3>Keywords</h3>
875
876	<h4 id="_read_hope_keyword_FILENAME">FILENAME
877
878
879
880
881
882	<span class="attr">type:</span> <span class="value">string</span>
883
884
885	</h4>
886
887	<div class="comments">
888	The name of the file to be read
889	</div>
890
891	<h4 id="_read_hope_keyword_XLIMITS">XLIMITS
892
893
894
895
896
897	<span class="attr">type:</span> <span class="value">vector</span>
898
899
900	</h4>
901
902	<div class="comments">
903	A two elements vector [lonmin, lonmax]]
904	the boundary of the longitudes (from 0 to 360)
905	</div>
906
907	<h4 id="_read_hope_keyword_YLIMITS">YLIMITS
908
909
910
911
912
913	<span class="attr">type:</span> <span class="value">vector</span>
914
915
916	</h4>
917
918	<div class="comments">
919	A two elements vector [latmin, latmax]]
920	the boundary of the latitudes (from -90 to 90)
921	</div>
922
923	<h4 id="_read_hope_keyword_ZLIMITS">ZLIMITS
924
925
926
927
928
929	<span class="attr">type:</span> <span class="value">vector</span>
930
931
932	</h4>
933
934	<div class="comments">
935	A two elements vector [depthmin, depthmax]]
936	the boundary of the depth
937	</div>
938
939	<h4 id="_read_hope_keyword_TLIMITS">TLIMITS
940
941
942
943
944
945	<span class="attr">type:</span> <span class="value">vector</span>
946
947
948	</h4>
949
950	<div class="comments">
951	A two elements vector [date1, date2]]
952	the boundary of the calendar with date1 and date2
953	folowing the syntax yyyymmdd
954	</div>
955
956	<h4 id="_read_hope_keyword_ODDPT">ODDPT
957
958
959
960
961
962
963
964
965	</h4>
966
967	<div class="comments">
968	Activate to read only the sections located on ODD
969	points
970	</div>
971
972	<h4 id="_read_hope_keyword_ODDEVENPT">ODDEVENPT
973
974
975
976
977
978
979
980
981	</h4>
982
983	<div class="comments">
984	Activate to read only the sections located on
985	both even and odd points (horizontal sections)
986	</div>
987
988	<h4 id="_read_hope_keyword_EVENPT">EVENPT
989
990
991
992
993
994
995
996
997	</h4>
998
999	<div class="comments">
1000	Activate to read only the sections located on even
1001	points
1002	</div>
1003
1004	<h4 id="_read_hope_keyword__extra">_extra
1005
1006
1007
1008
1009
1010
1011
1012
1013	</h4>
1014
1015	<div class="comments">
1016	Used to pass your keywords
1017	</div>
1018
1019
1020
1021	<h3>Examples</h3><div class="preformat">
1022
1023	IDL> a=read_hope('xy','ocpt',filename='CLIM_CNT_1993-1998.nc')
1024	IDL> help, a,/struct
1025	** Structure <82ec344>, 6 tags, length=1860176, refs=1:
1026	ARRAY FLOAT Array[128, 242, 15]
1027	UNIT STRING 'deg C'
1028	NAME STRING 'Ocean potential temperature'
1029	DATE FLOAT Array[1]
1030	GRID STRING 'T'
1031	HOPEGRID STRUCT -> <Anonymous> Array[1]
1032	IDL> help, a.hopegrid,/struct
1033	** Structure <82eb9cc>, 8 tags, length=1588, refs=2:
1034	XAXIS FLOAT Array[128]
1035	YAXIS FLOAT Array[242]
1036	ZAXIS FLOAT Array[15]
1037	FIRSTS LONG Array[3]
1038	LASTS LONG Array[3]
1039	TYPE STRING 'xy'
1040	LINETYPE STRING 'odd-even'
1041	PTTYPE STRING 'T'
1042	IDL> help, litchamp(a)
1043	<Expression> FLOAT = Array[128, 242, 15]
1044	</div>
1045	<h3>Version history</h3>
1046
1047	<h4>Version</h4><div class="preformat">
1048	$Id: read_hope.pro 157 2006-08-21 09:01:50Z navarro $
1049	</div>
1050	<h4>History</h4><div class="preformat">
1051	Sebastien Masson (smasson@lodyc.jussieu.fr)
1052	June 2001
1053	</div>
1054
1055
1056	<h3>Known issues</h3>
1057
1058
1059
1060	<h4>Restrictions</h4><div class="preformat">
1061	'x', 'y', 'z', 't', 'xt', 'yt' and 'zt' section not coded, xconv
1062	must be able to works with this kind of function.
1063	The grid file has no zoom possibilities on horizontal dimensions.
1064
1065
1066
1067	When typein and varnamein are defined, the method to find the
1068	good variable is:
1069	1) find the variables which are available on this type of
1070	sections with this name
1071	2) if ODDPT, EVENPT or ODDEVENPT are specified, consider only
1072	these types of sections
1073	3) For an XY section the chosen variable is the one which has
1074	the most level in the vertical domain specified by ZLIMITS.
1075	For an XZ section the chosen variable is the one which has
1076	the most points in the latitude domain specified by YLIMITS.
1077	For an YZ section the chosen variable is the one which has
1078	the most points in the longitude domain specified by XLIMITS.
1079
1080	</div>
1081
1082	<h3>Other attributes</h3>
1083
1084
1085	<h4>Uses routines</h4><div class="preformat">
1086	common.pro (useful only for the definition of iodir)
1087	</div>
1088
1089
1090
1091
1092	<h3>Statistics</h3>
1093	<table class="statistics">
1094	<tr><td>McCabe cyclic</td><td> 41</td></tr>
1095	<tr><td>McCabe essential</td><td> 1</td></tr>
1096	<tr><td>McCabe modular design</td><td> 1</td></tr>
1097	</table>
1098
1099
1100	</div>
1101
1102	</div>
1103
1104
1105
1106	<div id="tagline">Produced by IDLdoc 2.0.</div>
1107
1108	</div>
1109
1110	</body>
1111	</html>

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

Download in other formats: