Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DESSINE/plt.html @ 153

Last change on this file since 153 was 153, checked in by smasson, 18 years ago
doc update
File size: 28.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>plt.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
36	body {
37	margin: 0;
38	padding: 0;
39	font-size: 10pt;
40	font-family: Verdana, Helvetica, Arial, sans-serif;
41	background-color: #FFFFFF;
42	}
43
44	p {
45	margin-top: 0.5em;
46	margin-bottom: 0;
47	}
48
49	#container { margin: 1em; }
50
51	code.section { white-space: pre; }
52
53	pre.snippet {
54	margin-left: 5%;
55	background: #F0F0F0;
56	border: 1px dashed #999999;
57	width: 43em;
58	padding: 0.5em 0.5em 0.5em 0.5em;
59	white-space: pre;
60	}
61
62	/* Navbar styles ------------------------------------------------------------- */
63
64	#navbar_title {
65	color: #000033;
66	background-color: #F0F0FF;
67	font-family: Arial, Helvetica, sans-serif;
68	padding: 20px 30px;
69	border-bottom: 1px solid #000033;
70	}
71
72	#navbar_title * {
73	margin: 0;
74	padding: 0;
75	}
76
77	#navbar_title h1 {
78	letter-spacing: 0.1em;
79	font-variant: small-caps;
80	font-size: 250%;
81	text-indent: -1em;
82	padding-left: 1em;
83	}
84
85	#navbar_title h2 {
86	font-size: 110%;
87	font-weight: normal;
88	color: #333399;
89	}
90
91	#main_navbar table {
92	width: 100%;
93	border-bottom: 1px solid #666699;
94	}
95
96	#main_navbar td {
97	background: #CCCCFF;
98	font-size: 80%;
99	font-weight: bold;
100	font-family: Arial, Helvetica, sans-serif;
101	border-top: 3px solid #CCCCFF;
102	border-bottom: 3px solid #CCCCFF;
103	padding-left: 6px;
104	padding-right: 6px;
105	margin: 0;
106	}
107
108	#main_navbar td#selected {
109	background: #CCCCFF;
110	font-size: 80%;
111	font-weight: bold;
112	font-family: Arial, Helvetica, sans-serif;
113	border-top: 3px solid #333399;
114	border-bottom: 3px solid #CCCCFF;
115	padding-left: 6px;
116	padding-right: 6px;
117	margin: 0;
118	}
119
120	#main_navbar td#flexible {
121	width: 100%;
122	text-align: right;
123	padding-right: 1em;
124	background: #CCCCFF;
125	font-size: 70%;
126	font-weight: normal;
127	font-family: Arial, Helvetica, sans-serif;
128	text-transform: uppercase;
129	border-top: 3px solid #CCCCFF;
130	border-bottom: 3px solid #CCCCFF;
131	}
132
133	#main_navbar a:link, #main_navbar a:visited { color: #660000; border: 0; }
134
135	#main_navbar a:hover, #main_navbar a:focus {
136	color: #FFFF66;
137	background: #CCCCFF;
138	border-bottom: 1px none #606099;
139	border: 0;
140	}
141
142	#secondary_navbar {
143	font-size: 80%;
144	font-weight: normal;
145	font-family: Arial, Helvetica, sans-serif;
146	margin-top: 4px;
147	margin-left: 20px;
148	white-space: nowrap;
149	}
150
151
152	/* Tagline and footer styles ------------------------------------------------- */
153
154	div#tagline {
155	margin-top: 6px;
156	border-top: 1px dotted lightsteelblue;
157	padding-top: 6px;
158	font-size: 66%;
159	font-style: italic;
160	}
161
162	div#footer {
163	margin-top: 6px;
164	border-top: 1px dotted lightsteelblue;
165	padding-top: 6px;
166	font-size: 66%;
167	font-style: italic;
168	}
169
170	/* Basic data presenation styles -------------------------------------------- */
171
172	.index_letter {
173	font-size: 300%;
174	font-weight: bold;
175	color: #000066;
176	margin: 0.5em 0 0 -0.1em;
177	}
178
179	h1, h2, h3, h4 {
180	font-weight: normal;
181	color: #3333CC;
182	}
183
184	h1 {
185	padding-top: 0.75em;
186	font-size: 160%;
187	}
188
189	h2 {
190	padding-top: 1em;
191	font-size: 120%;
192	}
193
194	h3 {
195	padding-top: 0.75em;
196	margin-bottom: 0.25em;
197	font-size: 100%;
198	}
199
200	h4 {
201	padding: 0;
202	margin: 0.5em 0 0 0;
203	font-size: 80%;
204	}
205
206	table.basic {
207	empty-cells: show;
208	margin: 1.5em 1em 0 1em;
209	border: 1px dotted #CFCFFF;
210	font-size: 80%;
211	}
212
213	table.basic th {
214	background-color: #F0F0FF;
215	font-weight: bold;
216	text-align: left;
217	padding: 4px 1em 4px 4px;
218	border-bottom: 1px dotted #666699;
219	}
220
221	table.basic td {
222	vertical-align: top;
223	padding: 4px 1em 4px 4px;
224	}
225
226	dd {
227	margin-bottom: 0.25em;
228	font-size: 80%;
229	}
230
231
232	/* Warnings styles ----------------------------------------------------------- */
233
234
235	#todo dl, #bugs dl {
236	margin: 0 0 0 1.5em;
237	font-size: 80%;
238	}
239
240	#todo dd, #bugs dd {
241	margin-left: 3em;
242	font-size: 100%;
243	}
244
245	#undoc table, #obsolete table, #statistics table {
246	width: 80%;
247	margin-left: 2em;
248	}
249
250	#undoc td, #obsolete td, #statistics td {
251	padding: 0 0 0 0;
252	font-size: 80%;
253	white-space: nowrap;
254	}
255
256	#undoc td.docroutine, #obsolete td.obsroutine, #statistics td.statroutine { width: 50%; }
257
258	#undoc td.docstat, #statistics td.stat {
259	width: 50%;
260	text-align: right;
261	}
262
263	#undoc td.partialdoc, #statistics td.caution { color: #CC6600; }
264
265	#undoc td.notdoc, #statistics td.warning { color: #993333; }
266
267	/* File + routine styles ----------------------------------------------------- */
268
269	h1.directory {
270	padding: 1em 0 0 0;
271	margin: 0;
272	font-size: 66%;
273	}
274
275	h1.directory a { border-bottom: 0; }
276
277	h2.pro_file {
278	padding: 0;
279	margin: 0;
280	font-size: 140%;
281	}
282
283	div#file_attr {
284	padding: 0 1em 0 1em;
285	margin: 1em;
286	background: #F6F6F6;
287	border: 1px dotted #999999;
288	}
289
290	div#file_attr dt {
291	font-size: 80%;
292	font-weight: bold;
293	}
294
295	div#file_attr dd {
296	font-size: 80%;
297	}
298
299	div#class_diagram {
300	padding: 1em 0 1em 0;
301	white-space: pre;
302	font-family: 'Courier New';
303	}
304
305	table#sav_attr {
306	font-size: 90%;
307	margin: 1em;
308	padding: 1em 1em 1em 1em;
309	background: #F6F6F6;
310	border: 1px dotted #999999;
311	}
312
313	table#sav_attr th { text-align: left; }
314
315	table#sav_attr td { vertical-align: top; padding-right: 2em; }
316
317	table#sav_attr td.value { width: 20em; padding-right: 0em; font-style: italic; }
318
319	p.sav_warning { margin-left: 4em; font-family: 80%; }
320
321	table.variables {
322	font-family: 'Courier New', monospace;
323	font-size: 80%;
324	text-indent: -2em;
325	padding-left: 2em;
326	}
327
328	table.variables td.image { width: 64px; }
329
330	div#file_comments { white-space: pre;
331	margin: 2em;
332	font-size: 80%;
333	}
334
335
336	div.field_summary {
337	padding: 0 1em 0 1em;
338	margin: 1em;
339	background: #FFFFF0;
340	border: 1px dotted #C0C000;
341	}
342
343	div#routine_summary {
344	padding: 0 1em 0 1em;
345	margin: 1em;
346	background: #F0F0FF;
347	border: 1px dotted #9999FF;
348	}
349
350	div.field_summary h2, div#routine_summary h2 {
351	padding: 0.5em 0 0 0;
352	margin: 0;
353	}
354
355	div.field_summary table, div.field_summary p {
356	margin: 1em 1em;
357	}
358
359	div.field_summary td.name {
360	vertical-align: top;
361	padding-bottom: 0.25em;
362	color: #3333CC;
363	}
364
365	div.field_summary span.field_type {
366	font-weight: normal;
367	font-size: 80%;
368	color: black;
369	}
370
371	div.field_summary td.comments {
372	vertical-align: top;
373	padding-left: 2em;
374	font-size: 80%;
375	}
376
377	p.commaList {
378	margin: 1em 1em 1em 1em;
379	}
380
381	span.warning {
382	color: #CC6633;
383	font-weight: bold;
384	font-size: 66%;
385	text-transform: uppercase;
386	}
387
388	span.categories {
389	color: #006633;
390	font-weight: bold;
391	font-size: 66%;
392	text-transform: uppercase;
393	}
394
395	span.undoc {
396	color: #FF6633;
397	font-weight: bold;
398	font-size: 80%;
399	text-transform: uppercase;
400	}
401
402	span.attr {
403	color: #006633;
404	font-weight: bold;
405	font-size: 80%;
406	text-transform: uppercase;
407	}
408
409	span.value {
410	color: #006633;
411	font-weight: normal;
412	text-transform: none;
413	}
414
415	a.top {
416	font-weight: bold;
417	font-size: 66%;
418	text-transform: uppercase;
419	float: right;
420	}
421
422	span.result {
423	font-family: Verdana, Arial, Helvetica, sans-serif;
424	font-style: italic;
425	font-size: 80%;
426	}
427
428	div#routine_summary p, div.routine_details p.header {
429	padding-top: 0.5em;
430	margin-left: 1.5em;
431	text-indent: -1.5em;
432	font-family: 'Courier New', monospace;
433	}
434
435	div.routine_details {
436	padding: 0.5em 1em 0.5em 1em;
437	margin: 1em;
438	border: 1px dotted #CCCCCC;
439	}
440
441	div.routine_details h2 {
442	padding-top: 0;
443	margin-top: 0;
444	}
445
446	div.routine_details div.value {
447	margin: 0 1em 0 1em;
448	font-size: 80%;
449	}
450
451	div.routine_details div.comments {
452	font-size: 80%;
453	margin: 0.75em 1em 1em 1em;
454	}
455
456	div.routine_details div.preformat {
457	white-space: pre;
458	}
459
460	table.statistics {
461	font-size: 80%;
462	margin-left: 1em;
463	}
464
465	table.statistics td {
466	padding: 0 2em 0 0;
467	}
468
469	/* Overview styles ----------------------------------------------------------- */
470
471	div.overview {
472	width: 100%;
473	margin-top: 1em;
474	clear: both;
475	}
476
477	div.overview table {
478	empty-cells: show;
479	font-size: 90%;
480	margin: 1em 1em 1em 1em;
481	padding: 1em 0.5em 1em 0.5em;
482	background: #F6F6F6;
483	border: 1px dotted #999999;
484	}
485
486	div.overview td {
487	padding: 3px 1em 3px 1em;
488	}
489
490	div.overview td.dir {
491	width: 1%;
492	vertical-align: top;
493	text-align: right;
494	padding-right: 1em;
495	}
496
497
498	/* Navigation list styles for tree structures -------------------------------- */
499
500	#tree {
501	text-align: left;
502	font-size: 90%;
503	margin: 0.75em 0 0.75em 0;
504	padding: 0;
505	}
506
507	#tree ul {
508	text-align: left;
509	margin: 0;
510	padding: 0;
511	}
512
513	#tree li {
514	margin: 0 0 0 15px;
515	padding: 0;
516	list-style-type: none;
517	}
518
519	#tree .symbols {
520	float: left;
521	width: 12px;
522	height: 1em;
523	padding-left: 4px;
524	background-position: 0 100%;
525	background-repeat: no-repeat;
526	}
527
528	/* Search styles ------------------------------------------------------------- */
529
530	input.writein {
531	padding-left: 0.5em;
532	border: 1px solid #CCCCCC;
533	font-family: 'Courier New';
534	background: #FFFFF3;
535	}
536
537	#search form {
538	margin-left: 2em;
539	}
540
541	#search table {
542	margin: 1em 1em 0 2em;
543	padding: 1em 2em 1em 2em;
544	background: #F6F6F6;
545	border: 1px dotted #999999;
546	}
547
548	#search tr {
549	text-align: center;
550	}
551
552	#search td {
553	font-size: 80%;
554	text-align: left;
555	}
556
557	#search td * {
558	vertical-align: middle;
559	}
560
561	#search p {
562	font-size: 66%;
563	margin: 0 3em 2em 3em;
564	}
565
566	/* Help styles --------------------------------------------------------------- */
567
568	div.toc {
569	padding: 0 1em 0 1em;
570	margin: 1em;
571	background: #F0F0FF;
572	border: 1px dotted #9999FF;
573	width: 19em;
574	}
575
576	div.right {
577	float: right;
578	width: 22em;
579	}
580
581	ol.toc {
582	list-style-type: upper-roman;
583	}
584
585	ol.toc ol {
586	padding-left: 3em;
587	margin-left: 0;
588	list-style-type: lower-alpha;
589	}
590
591	dl.variables dt { font-size: 80%; }
592	dl.variables dd { margin-bottom: 0.5em; }
593
594	</style>
595	<style type="text/css" media="print">
596	#navbar_title {
597	background-color: #FFFFFF;
598	}
599
600	#main_navbar td {
601	background: #FFFFFF;
602	border-top: 0.25em solid #FFFFFF;
603	border-bottom: 0.25em solid #FFFFFF;
604	}
605
606	#main_navbar td#selected {
607	background: #FFFFFF;
608	border-top: 0.25em solid #333399;
609	border-bottom: 0.25em solid #FFFFFF;
610	}
611
612	#main_navbar td#flexible {
613	background: #FFFFFF;
614	border-top: 0.25em solid #FFFFFF;
615	border-bottom: 0.25em solid #FFFFFF;
616	}
617
618	#secondary_navbar {
619	display: none;
620	}
621
622	</style>
623
624
625	<script type="text/javascript">
626	function setTitle() {
627	parent.document.title="plt.pro (SAXO Documentation)";
628	}
629	</script>
630	</head>
631
632	<body onload="setTitle();">
633
634	<div id="navbar_title">
635	<h1>SAXO Documentation</h1>
636	</div>
637
638
639	<div id="main_navbar">
640
641	<table cellspacing="0">
642	<tr>
643
644	<td><a href="./../../../overview.html?format=raw" title="Overview of library">Overview</a></td>
645
646
647
648	<td >Directory</td>
649
650
651
652	<td><a href="./../../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
653
654
655
656	<td><a href="./../../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
657
658
659
660	<td><a href="./../../../search-page.html?format=raw" title="Search library">Search</a></td>
661
662
663	<td id="selected">File</td>
664
665
666	<td >Source</td>
667
668
669
670	<td><a href="./../../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
671
672
673	<td >Etc</td>
674
675	<td id="flexible">Developer documentation</td>
676	</tr>
677	</table>
678
679	</div>
680
681	<div id="secondary_navbar">
682
683	<a href="bar_plot.html?format=raw"><<prev file</a> \| <a href="plt1d.html?format=raw">next file >></a>    <a href="plt.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>
684
685	</div>
686
687
688	<div id="container">
689
690	<h1 class="directory"><a href="directory-overview.html?format=raw">ToBeReviewed/PLOTS/DESSINE/</a></h1>
691	<h2 class="pro_file">plt.pro</h2>
692
693	<div id="file_attr">
694	<dl>
695	</dl>
696	</div>
697
698	<div id="file_comments">
699	Draw horizontal graph (map) with CONTOUR procedure
700	</div>
701
702
703
704
705
706
707
708
709
710	<div id="routine_details">
711
712
713	<div class="routine_details" id="_plt">
714
715	<h2><a class="top" href="#container">top</a>plt <span class="categories">
716	graphic
717	</span></h2>
718
719	<p class="header">
720	plt<span class="result">, <a href="#_plt_param_tab1">tab1</a>[, <a href="#_plt_param_param2">param2</a>][, <a href="#_plt_param_param3">param3</a>][, <a href="#_plt_param_param4">param4</a>]</span>, <a href="#_plt_keyword_REALCONT">REALCONT</a>=<span class="result">REALCONT</span>, <a href="#_plt_keyword_CONTOUR">CONTOUR</a>=<span class="result">CONTOUR</span>, <a href="#_plt_keyword_INTERVALLE">INTERVALLE</a>=<span class="result">INTERVALLE</span>, <a href="#_plt_keyword_INV">INV</a>=<span class="result">INV</span>, <a href="#_plt_keyword_GRIDTYPE">GRIDTYPE</a>=<span class="result">GRIDTYPE</span>, <a href="#_plt_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_plt_keyword_CONTINTERVALLE">CONTINTERVALLE</a>=<span class="result">CONTINTERVALLE</span>, <a href="#_plt_keyword_LABEL">LABEL</a>=<span class="result">LABEL</span>, <a href="#_plt_keyword_CONTLABEL">CONTLABEL</a>=<span class="result">CONTLABEL</span>, <a href="#_plt_keyword_STYLE">STYLE</a>=<span class="result">STYLE</span>, <a href="#_plt_keyword_CONTMAX">CONTMAX</a>=<span class="result">CONTMAX</span>, <a href="#_plt_keyword_CONTMIN">CONTMIN</a>=<span class="result">CONTMIN</span>, <a href="#_plt_keyword_NLEVEL">NLEVEL</a>=<span class="result">NLEVEL</span>, <a href="#_plt_keyword_CONTNLEVEL">CONTNLEVEL</a>=<span class="result">CONTNLEVEL</span>, <a href="#_plt_keyword_VECTEUR">VECTEUR</a>=<span class="result">VECTEUR</span>, <a href="#_plt_keyword_MAP">MAP</a>=<span class="result">MAP</span>, <a href="#_plt_keyword_MININ">MININ</a>=<span class="result">MININ</span>, <a href="#_plt_keyword_MAXIN">MAXIN</a>=<span class="result">MAXIN</span>, <a href="#_plt_keyword_CONT_NOFILL">CONT_NOFILL</a>=<span class="result">CONT_NOFILL</span>, <a href="#_plt_keyword_USETRI">USETRI</a>=<span class="result">USETRI</span>, <a href="#_plt_keyword_NOTRI">NOTRI</a>=<span class="result">NOTRI</span>, <a href="#_plt_keyword_MASKFILL">MASKFILL</a>=<span class="result">MASKFILL</span>, <a href="#_plt_keyword_DUPLICATE">DUPLICATE</a>=<span class="result">DUPLICATE</span>, <a href="#_plt_keyword_STRICTFILL">STRICTFILL</a>=<span class="result">STRICTFILL</span>, <a href="#_plt_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_plt_keyword_DECIMATETRI">DECIMATETRI</a>=<span class="result">DECIMATETRI</span>, <a href="#_plt_keyword_LABMAP">LABMAP</a>=<span class="result">LABMAP</span>, <a href="#_plt_keyword__extra">_extra</a>=<span class="result">_extra</span></p>
721
722	<div class="comments">
723	</div>
724
725
726
727
728	<h3>Parameters</h3>
729
730
731	<h4 id="_plt_param_tab1">tab1
732	<span class="attr">in</span>
733
734
735	<span class="attr">required</span>
736
737
738
739
740	</h4>
741
742	<div class="comments">
743	The field whose we want to make the horizontal map can be:
744	1) an array. if needed, its mean along the z and t direction
745	will be automatically performed.
746	2) a structure respecting all criterions specified by
747	litchamp.pro. cf. IDL> xhelp,'litchamp'
748	</div>
749
750	<h4 id="_plt_param_param2">param2
751	<span class="attr">in</span>
752
753	<span class="attr">optional</span>
754
755
756
757	<span class="attr">default:</span> <span class="value">min of tab1 (on ocean points)</span>
758
759	</h4>
760
761	<div class="comments">
762	Min value we want to consider in the contour's drawing.
763	Note: Could also be the type of plot that can be only 'xy' for plt
764	</div>
765
766	<h4 id="_plt_param_param3">param3
767	<span class="attr">in</span>
768
769	<span class="attr">optional</span>
770
771
772
773	<span class="attr">default:</span> <span class="value">max of tab1 (on ocean points)</span>
774
775	</h4>
776
777	<div class="comments">
778	Max value we want to consider in the contour's drawing.
779	Note: if param2 is defined as 'xy' then param3 is used to define the min (see param2)
780	</div>
781
782	<h4 id="_plt_param_param4">param4
783	<span class="attr">in</span>
784
785	<span class="attr">optional</span>
786
787
788
789	<span class="attr">default:</span> <span class="value">'xy'</span>
790
791	</h4>
792
793	<div class="comments">
794	Type of plot (can be only 'xy' for plt).
795	Note: if param2 is defined as 'xy' then param4 is used to define the max (see param3)
796	</div>
797
798
799
800
801
802
803	<h3>Keywords</h3>
804
805	<h4 id="_plt_keyword_REALCONT">REALCONT
806
807
808
809
810
811
812
813
814	</h4>
815
816	<div class="comments">
817	Allow to draw continents defined in IDL. REALCONT can have 2 form:
818	/REALCONT: we draww continents in place of the mask
819	REALCONT=2 we draw cnotinents's contour over the mask (this allows
820	to see if the mask correspond at real continents).
821	</div>
822
823	<h4 id="_plt_keyword_CONTOUR">CONTOUR
824
825
826
827
828
829
830
831
832	</h4>
833
834	<div class="comments">
835	If we want to trace contours of a different field than the one
836	whose we have the colored drawing (by examlpe E-P in color and QSR in contours).
837	It must be a field respecting same caracteristics than the argument number one of plt.
838	</div>
839
840	<h4 id="_plt_keyword_INTERVALLE">INTERVALLE
841
842
843
844
845
846
847
848
849	</h4>
850
851	<div class="comments">
852	Value of an internal between to isoline. If there is none specified min,
853	we choose a min contour which goes well with the specified interval!. If this keyword is not
854	specified, we trace 20 isoline from the min to the max. Comment: When CONTOUR is activated,
855	INTERVALLE only specify the interval between 2 colored isoline. To specify the interval
856	between 2 isolines traced by a trait, use CONTINTERVALLE.
857	</div>
858
859	<h4 id="_plt_keyword_INV">INV
860
861
862
863
864
865
866
867
868	</h4>
869
870	<div class="comments">
871	Invert the color vector used to color the graph
872	(without use the black, the white and the used palette)
873	</div>
874
875	<h4 id="_plt_keyword_GRIDTYPE">GRIDTYPE
876
877
878
879
880
881
882
883
884	</h4>
885
886	<div class="comments"> 'U','T','V','W' or 'F' to specify possibly the grid on wiche the field is joined.
887	Comment: In this case, we should use a structure like field.
888	</div>
889
890	<h4 id="_plt_keyword_BOXZOOM">BOXZOOM
891
892
893
894
895
896
897
898
899	</h4>
900
901	<div class="comments">
902	Vector indicating the geographic zone on which we want to cut the map.
903	If BOXZOOM has :
904	1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
905	2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
906	4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
907	5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
908	6 elements: The extraction is made on Boxzoom
909
910	Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef!
911	</div>
912
913	<h4 id="_plt_keyword_CONTINTERVALLE">CONTINTERVALLE
914
915
916
917
918
919
920
921
922	</h4>
923
924	<div class="comments">
925	When CONTOUR is activated, it is the value between 2 isolines
926	traced by a trait. So it can be different from the one specified by INTERVALLE which,
927	in this case, does not control colored isolines in color anymore. If there is noone
928	specified min, we choose a contour min which goes well with the specified interval!
929	If this keyword is not specified, we trace 20 isolines from the min to the max.
930	</div>
931
932	<h4 id="_plt_keyword_LABEL">LABEL
933
934
935
936
937
938
939
940
941	</h4>
942
943	<div class="comments">
944	It is an integer n. If n different of 0, it choose the label's type
945	corresponding to cases n. cf label.pro
946	Comment: When CONTOUR is activated, it only specify the label's type for colored isolines.
947	For tese one traced by a trait, use CONTLABEL.
948	</div>
949
950	<h4 id="_plt_keyword_CONTLABEL">CONTLABEL
951
952
953
954
955
956
957
958
959	</h4>
960
961	<div class="comments">
962	It is an integer n. When CONTOUR is actvated, if n
963	is different of 0, choose the label type corresponding to n cases for
964	the traced by a traitisolines. To specify the type of label of the
965	colored contour, use LABEL
966	</div>
967
968	<h4 id="_plt_keyword_STYLE">STYLE
969
970
971
972
973
974
975
976
977	</h4>
978
979	<div class="comments">
980	Contour's style to adopt to draw isolines(by default, style=0. see style.pro)
981	</div>
982
983	<h4 id="_plt_keyword_CONTMAX">CONTMAX
984
985
986
987
988
989
990
991
992	</h4>
993
994	<div class="comments">
995	When CONTOUR is activated, max value we want to consider in the isoline
996	traced by a trait's line. By default, we take the max (on ocean points) of the array
997	passed in the keyword CONTOUR.
998	</div>
999
1000	<h4 id="_plt_keyword_CONTMIN">CONTMIN
1001
1002
1003
1004
1005
1006
1007
1008
1009	</h4>
1010
1011	<div class="comments">
1012	When CONTOUR is activated, min value we want to consider in the isoline
1013	traced by a trait's line. By default, we take the min (on ocean points) of the array
1014	passed in the keyword CONTOUR.
1015	</div>
1016
1017	<h4 id="_plt_keyword_NLEVEL">NLEVEL
1018
1019
1020
1021
1022
1023
1024
1025
1026	</h4>
1027
1028	<div class="comments">
1029	Number of contour to draw by default =20. active if
1030	LABEL=0 or is not specified.
1031	</div>
1032
1033	<h4 id="_plt_keyword_CONTNLEVEL">CONTNLEVEL
1034
1035
1036
1037
1038
1039
1040
1041
1042	</h4>
1043
1044	<div class="comments">
1045	When CONTOUR is activated, it is the numbre of contours
1046	traced by a trait for drawing (active if
1047	CONTLABEL=0) by default=20.
1048	</div>
1049
1050	<h4 id="_plt_keyword_VECTEUR">VECTEUR
1051
1052
1053
1054
1055
1056
1057
1058
1059	</h4>
1060
1061	<div class="comments"> is also appropriated.
1062	</div>
1063
1064	<h4 id="_plt_keyword_MAP">MAP
1065
1066
1067
1068
1069
1070
1071
1072
1073	</h4>
1074
1075	<div class="comments">
1076	We use it when we want to do a projection.
1077	This keyword can be of two types:
1078	MAP=[P0lat,P0lon,Rot]. For the descrption of these 3 values (see the online help of MAP_SET).
1079	/MAP: In this case, map is automatically caculated have the value:
1080	map = [0, (lon1+lon2)/2., 0]
1081	Comment: A good way to choose the type of the projection we want to do is to have a look at IDL demo:
1082	IDL> demo
1083	Then choose earth sciences and mapping.
1084	Comment2: By default it is a cindrical projection which is effectuated (with or without the keyword map).
1085	If we want an other projection, MAP must be activated and we have to add the keyword: /nom_projection.
1086	For example, for a polar projection centered on the south pole:
1087	IDL> domdef,-180,180,-90,-45
1088	IDL> plt, tab, /stereo,map=[-90,0,0]
1089	</div>
1090
1091	<h4 id="_plt_keyword_MININ">MININ
1092
1093
1094
1095
1096
1097
1098
1099
1100	</h4>
1101
1102	<div class="comments">
1103	to specify the min value we want to plot with a keyword instead of with the
1104	input parameter min. If min is defined by both, parameter and keyword, the
1105	keyword is retained.
1106	</div>
1107
1108	<h4 id="_plt_keyword_MAXIN">MAXIN
1109
1110
1111
1112
1113
1114
1115
1116
1117	</h4>
1118
1119	<div class="comments">
1120	to specify the max value we want to plot with a keyword instead of with the
1121	input parameter max. If max is defined by both, parameter and keyword, the
1122	keyword is retained.
1123	</div>
1124
1125	<h4 id="_plt_keyword_CONT_NOFILL">CONT_NOFILL
1126
1127
1128
1129
1130
1131
1132
1133
1134	</h4>
1135
1136	<div class="comments">
1137	Activate it not to fill the point mask to let them transparent!
1138	Comment: Nevertheless, we trace mask's contour.
1139	</div>
1140
1141	<h4 id="_plt_keyword_USETRI">USETRI
1142
1143
1144
1145
1146
1147
1148
1149
1150	</h4>
1151
1152	<div class="comments">
1153	To force using triangulation.
1154	</div>
1155
1156	<h4 id="_plt_keyword_NOTRI">NOTRI
1157
1158
1159
1160
1161
1162
1163
1164
1165	</h4>
1166
1167	<div class="comments">
1168	To force not to use the triangulation. Beware, in this case, the
1169	drawing only works if the grid is undeformed (It means that each point of a longitude
1170	give one latitude and each point of a latitude give one longitude) exept if we use
1171	the keyword CELL_FILL=2.
1172	Comment: if the field contain points !values.f_nan, then we even do a triangulation.
1173	</div>
1174
1175	<h4 id="_plt_keyword_MASKFILL">MASKFILL
1176
1177
1178
1179
1180
1181
1182
1183
1184	</h4>
1185
1186	<div class="comments">
1187	</div>
1188
1189	<h4 id="_plt_keyword_DUPLICATE">DUPLICATE
1190
1191
1192
1193
1194
1195
1196
1197
1198	</h4>
1199
1200	<div class="comments">
1201	</div>
1202
1203	<h4 id="_plt_keyword_STRICTFILL">STRICTFILL
1204
1205
1206
1207
1208
1209
1210
1211
1212	</h4>
1213
1214	<div class="comments">
1215	Activate this keyword to that the filling of contours be
1216	precisely done between the min and the max specified letting values inferior at the
1217	specified min and values superior at the specified max in white.
1218	</div>
1219
1220	<h4 id="_plt_keyword_OVERPLOT">OVERPLOT
1221
1222
1223
1224
1225
1226
1227
1228
1229	</h4>
1230
1231	<div class="comments">
1232	To make a plot over an other one.
1233	Comment: Contrarily to the use of CONTOUR or VECTEUR, the use of this keyword
1234	does not the caption and/or the color bar.
1235	</div>
1236
1237	<h4 id="_plt_keyword_DECIMATETRI">DECIMATETRI
1238
1239
1240
1241
1242
1243
1244
1245
1246	</h4>
1247
1248	<div class="comments">
1249	</div>
1250
1251	<h4 id="_plt_keyword_LABMAP">LABMAP
1252
1253
1254
1255
1256
1257
1258
1259
1260	</h4>
1261
1262	<div class="comments">
1263	Corresponds to label keywords of map_set. Defaut
1264	definition is labmap=1
1265
1266	</div>
1267
1268	<h4 id="_plt_keyword__extra">_extra
1269
1270
1271
1272
1273
1274
1275
1276
1277	</h4>
1278
1279	<div class="comments">
1280	used to pass your keywords
1281	</div>
1282
1283
1284
1285
1286	<h3>Version history</h3>
1287
1288	<h4>Version</h4><div class="preformat">
1289	$Id: plt.pro 152 2006-08-10 07:01:35Z smasson $
1290	</div>
1291	<h4>History</h4><div class="preformat"> </div>
1292
1293
1294	<h3>Known issues</h3>
1295
1296
1297	<h4>Todo items</h4><div class="preformat"> seb
1298	Changer param "tab1",keyword "REMPLI", "UNLABSUR", "UNSUR2",
1299	"UNVECTSUR"+ quelques trucs dans la routine.</div>
1300
1301
1302	<h3>Other attributes</h3>
1303
1304
1305	<h4>Uses routines</h4><div class="preformat">
1306	common.pro
1307	</div>
1308
1309
1310
1311
1312
1313
1314	</div>
1315
1316	</div>
1317
1318
1319
1320	<div id="tagline">Produced by IDLdoc 2.0.</div>
1321
1322	</div>
1323
1324	</body>
1325	</html>

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

Download in other formats: