Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DESSINE/pltz.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: 28.9 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>pltz.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="pltz.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="pltv.html?format=raw"><<prev file</a> \| <a href="sbar_plot.html?format=raw">next file >></a>    <a href="pltz.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">pltz.pro</h2>
695
696	<div id="file_attr">
697	<dl>
698	</dl>
699	</div>
700
701	<div id="file_comments">
702	Trace vertical graphs.
703	</div>
704
705
706
707
708
709
710
711
712
713	<div id="routine_details">
714
715
716	<div class="routine_details" id="_pltz">
717
718	<h2><a class="top" href="#container">top</a>pltz <span class="categories">
719	Graphics
720	</span></h2>
721
722	<p class="header">
723	pltz<span class="result">, <a href="#_pltz_param_tab">tab</a>, <a href="#_pltz_param_giventype">giventype</a>, <a href="#_pltz_param_givenmin">givenmin</a>, <a href="#_pltz_param_givenmax">givenmax</a></span>, <a href="#_pltz_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_pltz_keyword_CONTOUR">CONTOUR</a>=<span class="result">CONTOUR</span>, <a href="#_pltz_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_pltz_keyword_INTERVALLE">INTERVALLE</a>=<span class="result">INTERVALLE</span>, <a href="#_pltz_keyword_INV">INV</a>=<span class="result">INV</span>, <a href="#_pltz_keyword_ZRATIO">ZRATIO</a>=<span class="result">ZRATIO</span>, <a href="#_pltz_keyword_CONTINTERVALLE">CONTINTERVALLE</a>=<span class="result">CONTINTERVALLE</span>, <a href="#_pltz_keyword_LABEL">LABEL</a>=<span class="result">integer</span>, <a href="#_pltz_keyword_CONTLABEL">CONTLABEL</a>=<span class="result">integer</span>, <a href="#_pltz_keyword_STYLE">STYLE</a>=<span class="result">STYLE</span>, <a href="#_pltz_keyword_CONTMAX">CONTMAX</a>=<span class="result">CONTMAX</span>, <a href="#_pltz_keyword_SIN">SIN</a>=<span class="result">SIN</span>, <a href="#_pltz_keyword_TYPEIN">TYPEIN</a>=<span class="result">TYPEIN</span>, <a href="#_pltz_keyword_CONTMIN">CONTMIN</a>=<span class="result">CONTMIN</span>, <a href="#_pltz_keyword_NLEVEL">NLEVEL</a>=<span class="result">NLEVEL</span>, <a href="#_pltz_keyword_CONTNLEVEL">CONTNLEVEL</a>=<span class="result">CONTNLEVEL</span>, <a href="#_pltz_keyword_NOTRI">NOTRI</a>=<span class="result">NOTRI</span>, <a href="#_pltz_keyword_USETRI">USETRI</a>=<span class="result">USETRI</span>, <a href="#_pltz_keyword_FILLXDIR">FILLXDIR</a>=<span class="result">FILLXDIR</span>, <a href="#_pltz_keyword_ZOOM">ZOOM</a>=<span class="result">ZOOM</span>, <a href="#_pltz_keyword_XZ">XZ</a>=<span class="result">XZ</span>, <a href="#_pltz_keyword_YZ">YZ</a>=<span class="result">YZ</span>, <a href="#_pltz_keyword_MININ">MININ</a>=<span class="result">MININ</span>, <a href="#_pltz_keyword_MAXIN">MAXIN</a>=<span class="result">MAXIN</span>, <a href="#_pltz_keyword_STRICTFILL">STRICTFILL</a>=<span class="result">STRICTFILL</span>, <a href="#_pltz_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_pltz_keyword_MASKFILL">MASKFILL</a>=<span class="result">MASKFILL</span>, <a href="#_pltz_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>, <a href="#_pltz_keyword_REALSECTION">REALSECTION</a>=<span class="result">REALSECTION</span>, <a href="#_pltz_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
724
725	<div class="comments">
726	</div>
727
728
729
730
731	<h3>Parameters</h3>
732
733
734	<h4 id="_pltz_param_tab">tab
735
736
737
738
739
740
741
742
743	</h4>
744
745	<div class="comments">
746	The field whose we want to make a vertical cut can be 2 kind of thing:
747	1) An 2d or 3d array.
748	If the field is 2d, indicate, with the keyword BOXZOOM, geographic delineations of the boxzoom.
749	If the field is 3d, we extract the section on we average possibly before to do the plot.
750	2) a structure respecting all criterions specified by litchamp.pro.
751	See IDL> xhelp,'litchamp'. The array contained in the structure must be 2 or 3d (See case 1)
752
753	ces arguments ne sont pas obligatoires:
754
755	MAX: valeur maximum que l'on veut prendre en compte dans le trace
756	des contours. Par defaut on prend le max de tab1 (sur les pts mer)
757
758	MIN: valeur minimum que l'on veut prendre en compte dans le trace
759	des contours. Par defaut on prend le min de tab1 (sur les pts mer)
760	</div>
761
762	<h4 id="_pltz_param_giventype">giventype
763
764
765
766
767
768
769
770
771	</h4>
772
773	<div class="comments"></div>
774
775	<h4 id="_pltz_param_givenmin">givenmin
776
777
778
779
780
781
782
783
784	</h4>
785
786	<div class="comments"></div>
787
788	<h4 id="_pltz_param_givenmax">givenmax
789
790
791
792
793
794
795
796
797	</h4>
798
799	<div class="comments"></div>
800
801
802
803
804
805
806	<h3>Keywords</h3>
807
808	<h4 id="_pltz_keyword_BOXZOOM">BOXZOOM
809
810
811
812
813
814
815
816
817	</h4>
818
819	<div class="comments">
820	Vector indicating the geographic zone on which we want to cut the map.
821	If BOXZOOM has :
822	1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
823	2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
824	4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
825	5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
826	6 elements: The extraction is made on Boxzoom
827
828	Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef!
829	</div>
830
831	<h4 id="_pltz_keyword_CONTOUR">CONTOUR
832
833
834
835
836
837
838
839
840	</h4>
841
842	<div class="comments">
843	If we want to trace contours of a different field than the one
844	whose we have the colored drawing (by example E-P in color and QSR in contours).
845	It must be a field respecting same characteristics than the argument number one of plt.
846	</div>
847
848	<h4 id="_pltz_keyword_ENDPOINTS">ENDPOINTS
849
850
851
852
853
854
855
856
857	</h4>
858
859	<div class="comments">
860	keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities
861	of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are
862	coordinates.
863	</div>
864
865	<h4 id="_pltz_keyword_INTERVALLE">INTERVALLE
866
867
868
869
870
871
872
873
874	</h4>
875
876	<div class="comments">
877	Value of an internal between to isoline. If there is none specified min,
878	we choose a min contour which goes well with the specified interval!. If this keyword is not
879	specified, we trace 20 isoline from the min to the max. Comment: When CONTOUR is activated,
880	INTERVALLE only specify the interval between 2 colored isoline. To specify the interval
881	between 2 isolines traced by a trait, use CONTINTERVALLE.
882	</div>
883
884	<h4 id="_pltz_keyword_INV">INV
885
886
887
888
889
890
891
892
893	</h4>
894
895	<div class="comments">
896	Invert the color vector used to color the graph
897	(without use the black, the white and the used palette)
898	</div>
899
900	<h4 id="_pltz_keyword_ZRATIO">ZRATIO
901
902
903
904
905
906
907	<span class="attr">default:</span> <span class="value">2./3</span>
908
909	</h4>
910
911	<div class="comments">
912	When the drawing has a zoomed part, it is the size rapport between the zoomed part,
913	hz (zoom height), and the whole drawing, ht (total height).
914	</div>
915
916	<h4 id="_pltz_keyword_CONTINTERVALLE">CONTINTERVALLE
917
918
919
920
921
922
923
924
925	</h4>
926
927	<div class="comments">
928	When CONTOUR is activated, it is the value between 2 isolines
929	traced by a trait. So it can be different from the one specified by INTERVALLE which,
930	in this case, does not control colored isolines in color anymore. If there is noone
931	specified min, we choose a contour min which goes well with the specified interval!
932	If this keyword is not specified, we trace 20 isolines from the min to the max.
933	</div>
934
935	<h4 id="_pltz_keyword_LABEL">LABEL
936
937
938
939
940
941	<span class="attr">type:</span> <span class="value">integer</span>
942	<span class="attr">default:</span> <span class="value">0</span>
943
944	</h4>
945
946	<div class="comments">
947	It choose the label's type corresponding to cases in label.pro.
948	Comment: When CONTOUR is activated, it only specify the label's type for colored isolines.
949	For these one traced by a trait, use CONTLABEL.
950	</div>
951
952	<h4 id="_pltz_keyword_CONTLABEL">CONTLABEL
953
954
955
956
957
958	<span class="attr">type:</span> <span class="value">integer</span>
959
960
961	</h4>
962
963	<div class="comments">
964	When CONTOUR is activated, if n
965	is different of 0, choose the label type corresponding to n cases for
966	the traced by a traitisolines. To specify the type of label of the
967	colored contour, use LABEL
968	</div>
969
970	<h4 id="_pltz_keyword_STYLE">STYLE
971
972
973
974
975
976
977	<span class="attr">default:</span> <span class="value">style</span>
978
979	</h4>
980
981	<div class="comments">
982	Contour's style to adopt to draw isolines
983	</div>
984
985	<h4 id="_pltz_keyword_CONTMAX">CONTMAX
986
987
988
989
990
991
992	<span class="attr">default:</span> <span class="value">max of the keyword CONTOUR (on ocean points)</span>
993
994	</h4>
995
996	<div class="comments">
997	When CONTOUR is activated, max value we want to consider in the isoline
998	traced by a trait's line.
999	</div>
1000
1001	<h4 id="_pltz_keyword_SIN">SIN
1002
1003
1004
1005
1006
1007
1008
1009
1010	</h4>
1011
1012	<div class="comments">
1013	Activate this keyword if we want the x axis to be traced in sinus of the
1014	latitude when we make a drawing f(y)
1015	</div>
1016
1017	<h4 id="_pltz_keyword_TYPEIN">TYPEIN
1018
1019
1020
1021
1022
1023
1024
1025
1026	</h4>
1027
1028	<div class="comments"></div>
1029
1030	<h4 id="_pltz_keyword_CONTMIN">CONTMIN
1031
1032
1033
1034
1035
1036
1037	<span class="attr">default:</span> <span class="value">min of the keyword CONTOUR (on ocean points)</span>
1038
1039	</h4>
1040
1041	<div class="comments">
1042	When CONTOUR is activated, min value we want to consider in the isoline
1043	traced by a trait's line.
1044	</div>
1045
1046	<h4 id="_pltz_keyword_NLEVEL">NLEVEL
1047
1048
1049
1050
1051
1052
1053	<span class="attr">default:</span> <span class="value">20</span>
1054
1055	</h4>
1056
1057	<div class="comments">
1058	Number of contour to draw by default =20. active if
1059	LABEL=0 or is not specified.
1060	</div>
1061
1062	<h4 id="_pltz_keyword_CONTNLEVEL">CONTNLEVEL
1063
1064
1065
1066
1067
1068
1069	<span class="attr">default:</span> <span class="value">20</span>
1070
1071	</h4>
1072
1073	<div class="comments">
1074	When CONTOUR is activated, it is the number of contours
1075	traced by a trait for drawing (active if
1076	CONTLABEL=0).
1077	</div>
1078
1079	<h4 id="_pltz_keyword_NOTRI">NOTRI
1080
1081
1082
1083
1084
1085
1086
1087
1088	</h4>
1089
1090	<div class="comments">
1091	To force not to use the triangulation. Beware, in this case, the
1092	drawing only works if the grid is undeformed (It means that each point of a longitude
1093	give one latitude and each point of a latitude give one longitude) except if we use
1094	the keyword CELL_FILL=2.
1095	Comment: if the field contain points !values.f_nan, then we even do a triangulation.
1096	</div>
1097
1098	<h4 id="_pltz_keyword_USETRI">USETRI
1099
1100
1101
1102
1103
1104
1105
1106
1107	</h4>
1108
1109	<div class="comments"></div>
1110
1111	<h4 id="_pltz_keyword_FILLXDIR">FILLXDIR
1112
1113
1114
1115
1116
1117
1118
1119
1120	</h4>
1121
1122	<div class="comments"></div>
1123
1124	<h4 id="_pltz_keyword_ZOOM">ZOOM
1125
1126
1127
1128
1129
1130
1131	<span class="attr">default:</span> <span class="value">200m or max depth if it is inferior at 200m</span>
1132
1133	</h4>
1134
1135	<div class="comments">
1136	Depth where i can make our maximum zoom.
1137	</div>
1138
1139	<h4 id="_pltz_keyword_XZ">XZ
1140
1141
1142
1143
1144
1145
1146
1147
1148	</h4>
1149
1150	<div class="comments">
1151	Force to make a cut following xz
1152	</div>
1153
1154	<h4 id="_pltz_keyword_YZ">YZ
1155
1156
1157
1158
1159
1160
1161
1162
1163	</h4>
1164
1165	<div class="comments">
1166	Force to make a cut following yz
1167	</div>
1168
1169	<h4 id="_pltz_keyword_MININ">MININ
1170
1171
1172
1173
1174
1175
1176
1177
1178	</h4>
1179
1180	<div class="comments">
1181	to specify the min value we want to plot with a keyword instead of with the
1182	input parameter min. If min is defined by both, parameter and keyword, the
1183	keyword is retained.
1184	</div>
1185
1186	<h4 id="_pltz_keyword_MAXIN">MAXIN
1187
1188
1189
1190
1191
1192
1193
1194
1195	</h4>
1196
1197	<div class="comments">
1198	to specify the max value we want to plot with a keyword instead of with the
1199	input parameter max. If max is defined by both, parameter and keyword, the
1200	keyword is retained.
1201	</div>
1202
1203	<h4 id="_pltz_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="_pltz_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="_pltz_keyword_MASKFILL">MASKFILL
1238
1239
1240
1241
1242
1243
1244
1245
1246	</h4>
1247
1248	<div class="comments"></div>
1249
1250	<h4 id="_pltz_keyword_WDEPTH">WDEPTH
1251
1252
1253
1254
1255
1256
1257
1258
1259	</h4>
1260
1261	<div class="comments">
1262	To specify that the field is at W depth instead of T
1263	depth (automatically activated if vargrid eq 'W')
1264	</div>
1265
1266	<h4 id="_pltz_keyword_REALSECTION">REALSECTION
1267
1268
1269
1270
1271
1272
1273
1274
1275	</h4>
1276
1277	<div class="comments"></div>
1278
1279	<h4 id="_pltz_keyword__EXTRA">_EXTRA
1280
1281
1282
1283
1284
1285
1286
1287
1288	</h4>
1289
1290	<div class="comments"></div>
1291
1292
1293
1294
1295	<h3>Version history</h3>
1296
1297	<h4>Version</h4><div class="preformat">
1298	$Id: pltz.pro 157 2006-08-21 09:01:50Z navarro $
1299	</div>
1300	<h4>History</h4><div class="preformat">
1301	Sebastien Masson (smasson@lodyc.jussieu.fr)
1302	7/1999
1303	Sebastien Masson 08/02/2000 checkfield and
1304	notri keyword.
1305	</div>
1306
1307
1308	<h3>Known issues</h3>
1309
1310
1311	<h4>Todo items</h4><div class="preformat"> seb L.20 à 26, L.215 à 221
1312	</div>
1313
1314
1315	<h3>Other attributes</h3>
1316
1317
1318	<h4>Uses routines</h4><div class="preformat">
1319	common.pro
1320	</div>
1321
1322
1323
1324
1325	<h3>Statistics</h3>
1326	<table class="statistics">
1327	<tr><td>McCabe cyclic</td><td> 61</td></tr>
1328	<tr><td>McCabe essential</td><td> 3</td></tr>
1329	<tr><td>McCabe modular design</td><td> 1</td></tr>
1330	</table>
1331
1332
1333	</div>
1334
1335	</div>
1336
1337
1338
1339	<div id="tagline">Produced by IDLdoc 2.0.</div>
1340
1341	</div>
1342
1343	</body>
1344	</html>

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

Download in other formats: