Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DESSINE/pltt.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: 30.7 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>pltt.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="pltt.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="pltsc.html?format=raw"><<prev file</a> \| <a href="pltv.html?format=raw">next file >></a>    <a href="pltt.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/PLOTS/DESSINE/</a></h1>
694	<h2 class="pro_file">pltt.pro</h2>
695
696	<div id="file_attr">
697	<dl>
698	</dl>
699	</div>
700
701	<div id="file_comments">
702	Trace hovmoller graphs: xt,yt,zt,t
703	</div>
704
705
706
707
708
709
710
711
712
713	<div id="routine_details">
714
715
716	<div class="routine_details" id="_pltt">
717
718	<h2><a class="top" href="#container">top</a>pltt <span class="categories"> Graphics
719	</span></h2>
720
721	<p class="header">
722	pltt<span class="result">, <a href="#_pltt_param_tab">tab</a>, <a href="#_pltt_param_giventype">giventype</a>, <a href="#_pltt_param_givenmin">givenmin</a>, <a href="#_pltt_param_givenmax">givenmax</a>, <a href="#_pltt_param_datmin">datmin</a>, <a href="#_pltt_param_datmax">datmax</a></span>, <a href="#_pltt_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_pltt_keyword_CONTOUR">CONTOUR</a>=<span class="result">CONTOUR</span>, <a href="#_pltt_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_pltt_keyword_INTERVALLE">INTERVALLE</a>=<span class="result">INTERVALLE</span>, <a href="#_pltt_keyword_INV">INV</a>=<span class="result">INV</span>, <a href="#_pltt_keyword_CONTINTERVALLE">CONTINTERVALLE</a>=<span class="result">CONTINTERVALLE</span>, <a href="#_pltt_keyword_LABEL">LABEL</a>=<span class="result">integer</span>, <a href="#_pltt_keyword_CONTLABEL">CONTLABEL</a>=<span class="result">integer</span>, <a href="#_pltt_keyword_STYLE">STYLE</a>=<span class="result">STYLE</span>, <a href="#_pltt_keyword_CONTMAX">CONTMAX</a>=<span class="result">CONTMAX</span>, <a href="#_pltt_keyword_CONTMIN">CONTMIN</a>=<span class="result">CONTMIN</span>, <a href="#_pltt_keyword_NLEVEL">NLEVEL</a>=<span class="result">NLEVEL</span>, <a href="#_pltt_keyword_CONTNLEVEL">CONTNLEVEL</a>=<span class="result">CONTNLEVEL</span>, <a href="#_pltt_keyword_COL1D">COL1D</a>=<span class="result">COL1D</span>, <a href="#_pltt_keyword_STY1D">STY1D</a>=<span class="result">STY1D</span>, <a href="#_pltt_keyword_MININ">MININ</a>=<span class="result">MININ</span>, <a href="#_pltt_keyword_MAXIN">MAXIN</a>=<span class="result">MAXIN</span>, <a href="#_pltt_keyword_OV1D">OV1D</a>=<span class="result">OV1D</span>, <a href="#_pltt_keyword_FILTER">FILTER</a>=<span class="result">FILTER</span>, <a href="#_pltt_keyword_TREND_TYPE">TREND_TYPE</a>=<span class="result">TREND_TYPE</span>, <a href="#_pltt_keyword_REPEAT_C">REPEAT_C</a>=<span class="result">REPEAT_C</span>, <a href="#_pltt_keyword_TYPEIN">TYPEIN</a>=<span class="result">TYPEIN</span>, <a href="#_pltt_keyword_XT">XT</a>=<span class="result">XT</span>, <a href="#_pltt_keyword_YT">YT</a>=<span class="result">YT</span>, <a href="#_pltt_keyword_ZT">ZT</a>=<span class="result">ZT</span>, <a href="#_pltt_keyword_TT">TT</a>=<span class="result">TT</span>, <a href="#_pltt_keyword_STRICTFILL">STRICTFILL</a>=<span class="result">STRICTFILL</span>, <a href="#_pltt_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_pltt_keyword_EXCHANGE_XY">EXCHANGE_XY</a>=<span class="result">EXCHANGE_XY</span>, <a href="#_pltt_keyword__extra">_extra</a>=<span class="result">_extra</span></p>
723
724	<div class="comments">
725	</div>
726
727
728
729
730	<h3>Parameters</h3>
731
732
733	<h4 id="_pltt_param_tab">tab
734	<span class="attr">in</span>
735
736
737	<span class="attr">required</span>
738
739
740
741
742	</h4>
743
744	<div class="comments">
745	The field whose we want to make the hovmoller map can be 2 kind of thing:
746	1) An array which can be:
747	* 3d or 4d: array 'xt','yt','zt','t'. The last component is the time. In this case, the array will
748	pass in grossemoyenne to be averaged and become an 1d or 2d array.
749	* 2d: If the array is already 2d, it is not modified (beware, lands must
750	be masked at the value valmask) and nevertheless,type must be specified
751	to we know of which trace it is about.
752	To have a correct caption, respecify the extraction zone via BOXZOOM.
753	* 1d: only for traces of the 't' type. Nevertheless, type must be specified
754	to we know of which trace it is about.
755	To have a correct caption, respecify the extraction zone via BOXZOOM.
756	2) a structure respecting all criterions specified by litchamp.pro.
757	See IDL> xhelp,'litchamp'. The array contained in the structure
758	respecting criterions of case 1)
759
760	PARAM:
761	MAX: valeur maximum que l''on veut prendre en compte dans le trace
762	des contours. Par defaut on prend le max de tableau (sur les pts mer)
763
764	MIN: valeur minimum que l''on veut prendre en compte dans le trace
765	des contours. Par defaut on prend le min de tableau (sur les pts
766	mer)
767
768	DATMIN: c''est la borne inf de l''axe temporel. c''est un
769	longinteger de la forme yyyymmdd (ou bien yymmdd).
770
771	DATMAX: c''est la borne max de l''axe temporel. c''est un
772	longinteger de la forme yyyymmdd (ou bien yymmdd)
773	</div>
774
775	<h4 id="_pltt_param_giventype">giventype
776
777
778
779
780
781
782
783
784	</h4>
785
786	<div class="comments"></div>
787
788	<h4 id="_pltt_param_givenmin">givenmin
789
790
791
792
793
794
795
796
797	</h4>
798
799	<div class="comments"></div>
800
801	<h4 id="_pltt_param_givenmax">givenmax
802
803
804
805
806
807
808
809
810	</h4>
811
812	<div class="comments"></div>
813
814	<h4 id="_pltt_param_datmin">datmin
815
816
817
818
819
820
821
822
823	</h4>
824
825	<div class="comments"></div>
826
827	<h4 id="_pltt_param_datmax">datmax
828
829
830
831
832
833
834
835
836	</h4>
837
838	<div class="comments"></div>
839
840
841
842
843
844
845	<h3>Keywords</h3>
846
847	<h4 id="_pltt_keyword_BOXZOOM">BOXZOOM
848
849
850
851
852
853
854
855
856	</h4>
857
858	<div class="comments">
859	Vector indicating the geographic zone (3d) on which the extraction of the field must
860	be done to do the hovmoeller.
861	If BOXZOOM has :
862	1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
863	2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
864	4 elements: The extraction is made on [Boxzoom, vert1, vert2]
865	5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
866	6 elements: The extraction is made on Boxzoom
867
868	Where lon1, lon2,lat1,lat2,vert1,vert2 are global variables defined at the last domdef!
869	</div>
870
871	<h4 id="_pltt_keyword_CONTOUR">CONTOUR
872
873
874
875
876
877
878
879
880	</h4>
881
882	<div class="comments">
883	If we want to trace contours of a different field than the one
884	whose we have the colored drawing (by example E-P in color and QSR in contours).
885	It must be a field respecting same characteristics than the argument number one of pltt.
886	</div>
887
888	<h4 id="_pltt_keyword_ENDPOINTS">ENDPOINTS
889
890
891
892
893
894
895
896
897	</h4>
898
899	<div class="comments">
900	keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities
901	of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are
902	coordinates.
903	</div>
904
905	<h4 id="_pltt_keyword_INTERVALLE">INTERVALLE
906
907
908
909
910
911
912
913
914	</h4>
915
916	<div class="comments">
917	Value of an internal between to isoline. If there is none specified min,
918	we choose a min contour which goes well with the specified interval!. If this keyword is not
919	specified, we trace 20 isoline from the min to the max. Comment: When CONTOUR is activated,
920	INTERVALLE only specify the interval between 2 colored isoline. To specify the interval
921	between 2 isolines traced by a trait, use CONTINTERVALLE.
922	</div>
923
924	<h4 id="_pltt_keyword_INV">INV
925
926
927
928
929
930
931
932
933	</h4>
934
935	<div class="comments">
936	Invert the color vector used to color the graph
937	(without use the black, the white and the used palette)
938	</div>
939
940	<h4 id="_pltt_keyword_CONTINTERVALLE">CONTINTERVALLE
941
942
943
944
945
946
947
948
949	</h4>
950
951	<div class="comments">
952	When CONTOUR is activated, it is the value between 2 isolines
953	traced by a trait. So it can be different from the one specified by INTERVALLE which,
954	in this case, does not control colored isolines in color anymore. If there is noone
955	specified min, we choose a contour min which goes well with the specified interval!
956	If this keyword is not specified, we trace 20 isolines from the min to the max.
957	</div>
958
959	<h4 id="_pltt_keyword_LABEL">LABEL
960
961
962
963
964
965	<span class="attr">type:</span> <span class="value">integer</span>
966
967
968	</h4>
969
970	<div class="comments">
971	If n different of 0, it choose the label's type
972	corresponding to cases n. cf label.pro
973	Comment: When CONTOUR is activated, it only specify the label's type for colored isolines.
974	For these one traced by a trait, use CONTLABEL.
975	</div>
976
977	<h4 id="_pltt_keyword_CONTLABEL">CONTLABEL
978
979
980
981
982
983	<span class="attr">type:</span> <span class="value">integer</span>
984
985
986	</h4>
987
988	<div class="comments">
989	When CONTOUR is activated, if n
990	is different of 0, choose the label type corresponding to n cases for
991	the traced by a traitisolines. To specify the type of label of the
992	colored contour, use LABEL
993	</div>
994
995	<h4 id="_pltt_keyword_STYLE">STYLE
996
997
998
999
1000
1001
1002	<span class="attr">default:</span> <span class="value">style</span>
1003
1004	</h4>
1005
1006	<div class="comments">
1007	Contour's style to adopt to draw isolines
1008	</div>
1009
1010	<h4 id="_pltt_keyword_CONTMAX">CONTMAX
1011
1012
1013
1014
1015
1016
1017	<span class="attr">default:</span> <span class="value">we take the max of the array passed in the keyword CONTOUR (on ocean points)</span>
1018
1019	</h4>
1020
1021	<div class="comments">
1022	When CONTOUR is activated, max value we want to consider in the isoline
1023	traced by a trait's line.
1024	</div>
1025
1026	<h4 id="_pltt_keyword_CONTMIN">CONTMIN
1027
1028
1029
1030
1031
1032
1033	<span class="attr">default:</span> <span class="value">we take the min of the array passed in the keyword CONTOUR (on ocean points)</span>
1034
1035	</h4>
1036
1037	<div class="comments">
1038	When CONTOUR is activated, min value we want to consider in the isoline
1039	traced by a trait's line.
1040	</div>
1041
1042	<h4 id="_pltt_keyword_NLEVEL">NLEVEL
1043
1044
1045
1046
1047
1048
1049	<span class="attr">default:</span> <span class="value">20</span>
1050
1051	</h4>
1052
1053	<div class="comments">
1054	Number of contour to draw by default =20. active if
1055	LABEL=0 or is not specified.
1056	</div>
1057
1058	<h4 id="_pltt_keyword_CONTNLEVEL">CONTNLEVEL
1059
1060
1061
1062
1063
1064
1065	<span class="attr">default:</span> <span class="value">20</span>
1066
1067	</h4>
1068
1069	<div class="comments">
1070	When CONTOUR is activated, it is the number of contours
1071	traced by a trait for drawing (active if
1072	CONTLABEL=0).
1073
1074
1075	When CONTOUR is activated, it is the number of contours
1076	traced by a trait for drawing (active if
1077	CONTLABEL=0).
1078	</div>
1079
1080	<h4 id="_pltt_keyword_COL1D">COL1D
1081
1082
1083
1084
1085
1086
1087
1088
1089	</h4>
1090
1091	<div class="comments">
1092	--OBSOLETE--Color number when we make a trace 1d by default, 0.It is better to use the
1093	keyword COLOR used by plot.
1094	</div>
1095
1096	<h4 id="_pltt_keyword_STY1D">STY1D
1097
1098
1099
1100
1101
1102
1103
1104
1105	</h4>
1106
1107	<div class="comments">
1108	--OBSOLETE--
1109	Number of the style used when we make a 1d drawing. We should better use the
1110	keyword LINESTYLE which is tho one of the plot. Beware, this keyword is still
1111	useful if we want to d bars instead of curves, put sty1d='bar'
1112	</div>
1113
1114	<h4 id="_pltt_keyword_MININ">MININ
1115
1116
1117
1118
1119
1120
1121
1122
1123	</h4>
1124
1125	<div class="comments">
1126	to specify the min value we want to plot with a keyword instead of with the
1127	input parameter min. If min is defined by both, parameter and keyword, the
1128	keyword is retained.
1129	</div>
1130
1131	<h4 id="_pltt_keyword_MAXIN">MAXIN
1132
1133
1134
1135
1136
1137
1138
1139
1140	</h4>
1141
1142	<div class="comments">
1143	to specify the max value we want to plot with a keyword instead of with the
1144	input parameter max. If max is defined by both, parameter and keyword, the
1145	keyword is retained.
1146	</div>
1147
1148	<h4 id="_pltt_keyword_OV1D">OV1D
1149
1150
1151
1152
1153
1154
1155
1156
1157	</h4>
1158
1159	<div class="comments">
1160	Allows to overprint a 1d curve over a precedent 1d drawing.
1161	</div>
1162
1163	<h4 id="_pltt_keyword_FILTER">FILTER
1164
1165
1166
1167
1168
1169
1170
1171
1172	</h4>
1173
1174	<div class="comments">
1175	Apply a slippery average of width FILTER
1176	</div>
1177
1178	<h4 id="_pltt_keyword_TREND_TYPE">TREND_TYPE
1179
1180
1181
1182
1183
1184
1185
1186
1187	</h4>
1188
1189	<div class="comments">
1190	Modify field by calling trends.pro
1191	</div>
1192
1193	<h4 id="_pltt_keyword_REPEAT_C">REPEAT_C
1194
1195
1196
1197
1198
1199
1200
1201
1202	</h4>
1203
1204	<div class="comments"></div>
1205
1206	<h4 id="_pltt_keyword_TYPEIN">TYPEIN
1207
1208
1209
1210
1211
1212
1213
1214
1215	</h4>
1216
1217	<div class="comments">
1218	allows to specify the type of hovmoller we want to do
1219	'xt','yt','zt','t'
1220	with help of a keyword rather than the argument type. If the argument and the
1221	keyword are specified in the same time, it is the value specified by the
1222	keyword which is retained.
1223	</div>
1224
1225	<h4 id="_pltt_keyword_XT">XT
1226
1227
1228
1229
1230
1231
1232
1233
1234	</h4>
1235
1236	<div class="comments"></div>
1237
1238	<h4 id="_pltt_keyword_YT">YT
1239
1240
1241
1242
1243
1244
1245
1246
1247	</h4>
1248
1249	<div class="comments"></div>
1250
1251	<h4 id="_pltt_keyword_ZT">ZT
1252
1253
1254
1255
1256
1257
1258
1259
1260	</h4>
1261
1262	<div class="comments"></div>
1263
1264	<h4 id="_pltt_keyword_TT">TT
1265
1266
1267
1268
1269
1270
1271
1272
1273	</h4>
1274
1275	<div class="comments"></div>
1276
1277	<h4 id="_pltt_keyword_STRICTFILL">STRICTFILL
1278
1279
1280
1281
1282
1283
1284
1285
1286	</h4>
1287
1288	<div class="comments">
1289	Activate this keyword to that the filling of contours be
1290	precisely done between the min and the max specified letting values inferior at the
1291	specified min and values superior at the specified max in white.
1292	</div>
1293
1294	<h4 id="_pltt_keyword_OVERPLOT">OVERPLOT
1295
1296
1297
1298
1299
1300
1301
1302
1303	</h4>
1304
1305	<div class="comments">
1306	To make a plot over an other one.
1307	Comment: Contrarily to the use of CONTOUR or VECTEUR, the use of this keyword
1308	does not the caption and/or the color bar.
1309	</div>
1310
1311	<h4 id="_pltt_keyword_EXCHANGE_XY">EXCHANGE_XY
1312
1313
1314
1315
1316
1317
1318
1319
1320	</h4>
1321
1322	<div class="comments">
1323	Allows to invert axes.
1324	</div>
1325
1326	<h4 id="_pltt_keyword__extra">_extra
1327
1328
1329
1330
1331
1332
1333
1334
1335	</h4>
1336
1337	<div class="comments">
1338	Used to pass your keywords
1339	</div>
1340
1341
1342
1343
1344	<h3>Version history</h3>
1345
1346	<h4>Version</h4><div class="preformat">
1347	$Id: pltt.pro 157 2006-08-21 09:01:50Z navarro $
1348	</div>
1349	<h4>History</h4><div class="preformat">
1350	Sebastien Masson (smasson@lodyc.jussieu.fr)
1351	27/5/98
1352	Jerome Vialard (adapting plt to hovmoller drawing)
1353	2/7/98
1354	Sebastien Masson 14/8/98 (continents,barres)
1355	15/1/98
1356	Adaptation for arrays 3 and 4d to the average be done in pltt rather than during the reading.
1357	Sebastien Masson 14/8/98
1358	7/1999
1359	Eric Guilyardi 29/7/99 FILTER, TREND_TYPE,
1360	REPEAT_C
1361	Sebastien Masson 08/02/2000 checkfield and
1362	usetri keyword.
1363	</div>
1364
1365
1366	<h3>Known issues</h3>
1367
1368
1369	<h4>Todo items</h4><div class="preformat"> seb: L.24 à 36, L.426 à 427, L. 492 à 493</div>
1370
1371
1372	<h3>Other attributes</h3>
1373
1374
1375	<h4>Uses routines</h4><div class="preformat">
1376	common.pro
1377	</div>
1378
1379
1380
1381
1382	<h3>Statistics</h3>
1383	<table class="statistics">
1384	<tr><td>McCabe cyclic</td><td> 88</td></tr>
1385	<tr><td>McCabe essential</td><td> 8</td></tr>
1386	<tr><td>McCabe modular design</td><td> 1</td></tr>
1387	</table>
1388
1389
1390	</div>
1391
1392	</div>
1393
1394
1395
1396	<div id="tagline">Produced by IDLdoc 2.0.</div>
1397
1398	</div>
1399
1400	</body>
1401	</html>

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

Download in other formats: