Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DESSINE/pltz.html @ 107

Last change on this file since 107 was 107, checked in by smasson, 18 years ago
bugfix in ead/write_oasis
File size: 19.5 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	<link rel="stylesheet" type="text/css" media="all" href="./../../../main_files.css" />
13	<link rel="stylesheet" type="text/css" media="print" href="./../../../main_files_print.css" />
14
15
16	<script type="text/javascript">
17	function setTitle() {
18	parent.document.title="pltz.pro (SAXO Documentation)";
19	}
20	</script>
21	</head>
22
23	<body onload="setTitle();">
24
25	<div id="navbar_title">
26	<h1>SAXO Documentation</h1>
27	</div>
28
29
30	<div id="main_navbar">
31
32	<table cellspacing="0">
33	<tr>
34
35	<td><a href="./../../../overview.html?format=raw" title="Overview of library">Overview</a></td>
36
37
38
39	<td >Directory</td>
40
41
42
43	<td><a href="./../../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44
45
46
47	<td><a href="./../../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48
49
50
51	<td><a href="./../../../search-page.html?format=raw" title="Search library">Search</a></td>
52
53
54	<td id="selected">File</td>
55
56
57	<td >Source</td>
58
59
60
61	<td><a href="./../../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
62
63
64	<td >Etc</td>
65
66	<td id="flexible">Developer documentation</td>
67	</tr>
68	</table>
69
70	</div>
71
72	<div id="secondary_navbar">
73
74	<a href="pltt.html"><<prev file</a> \| <a href="sbar_plot.html">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>
75
76	</div>
77
78
79	<div id="container">
80
81	<h1 class="directory"><a href="directory-overview.html?format=raw">ToBeReviewed/PLOTS/DESSINE/</a></h1>
82	<h2 class="pro_file">pltz.pro</h2>
83
84	<div id="file_attr">
85	<dl>
86	</dl>
87	</div>
88
89	<div id="file_comments"></div>
90
91
92
93
94
95
96
97
98
99	<div id="routine_details">
100
101
102	<div class="routine_details" id="_pltz">
103
104	<h2><a class="top" href="#container">top</a>pltz </h2>
105
106	<p class="header">
107	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">LABEL</span>, <a href="#_pltz_keyword_CONTLABEL">CONTLABEL</a>=<span class="result">CONTLABEL</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>
108
109	<div class="comments">
110	NAME:
111	PLTZ
112
113	PURPOSE:
114	trace des graphes verticaux
115
116	CATEGORY:
117	Graphics
118
119	CALLING SEQUENCE:
120	pltz, champ [,min[, max]]
121
122	INPUTS:
123	champ: le champ dont on veut faire la coupe verticale champ
124	peut etre de 2 types:
125	1) un tableau 2d ou 3d.
126	Si le champ est 2d undiquer avec le mot cle boxzoom les
127	delimitations geographiques de la boxzoom. Si le chyamp est
128	3d, on extrait la section et on moyenne eventuellement avant
129	de faire le plot
130	2) une structure repondant aux critaire specifies par
131	litchamp.pro. cf. IDL> xhelp,'litchamp'. le tableau contenu
132	ds la structure doit etre 2 ou 3d cf cas 1) si dessus
133
134	ces arguments ne sont pas obligatoires:
135
136	MAX: valeur maximum que l'on veut prendre en compte dans le trace
137	des contours. Par defaut on prend le max de tab1 (sur les pts mer)
138
139	MIN: valeur minimum que l'on veut prendre en compte dans le trace
140	des contours. Par defaut on prend le min de tab1 (sur les pts mer)
141
142	KEYWORD PARAMETERS:
143
144	BOXZOOM:vecteur indiquant la zone geographique sur laquelle doit etre
145	faite la coupe. Si BOXZOOM a :
146	1 element : l''extraction est faite sur [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
147	2 elements: l''extraction est faite sur [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
148	4 elements: l''extraction est faite sur [Boxzoom, 0, 200]
149	5 elements: l''extraction est faite sur [Boxzoom[0:3], 0, Boxzoom[4]]
150	6 elements: l''extraction est faite sur Boxzoom
151
152	Ou lon1, lon2,lat1,lat2 sont les variables globales
153	definies lors du dernier domdef!
154
155	CB_TITLE: le titre de la colorbar
156
157	CB_SUBTITLE: le soustitre de la colorbar
158
159	CB_CHARSIZE: The character size of the color bar annotations
160
161	CONTINTERVALLE: lorsque CONTOUR est active, valeur d'un
162	intervalle entre deux isolignes traces par un trait. Il peut ainsi
163	etre different de celui specifie par INTERVALLE
164	qui, cas ce cas, ne controle que les isolignes coloriees en
165	couleurs. Si aucun min n''est specifie, on choisit un contour min qui va
166	bien avec l''intervalle specifie!. Si ce mot cle n''est pas
167	specifie, on trace 20 isolignes du min au max.
168
169	CONTLABEL: un entier n. lorsque CONTOUR est active, si n
170	different de 0, choisit le type de label correspondant aux cas n
171	pour les isolignes tracees par un trait. Pour specifier le type de
172	label du contour en couleur, utiliser LABEL
173
174	CONTMAX: lorsque CONTOUR est active, valeur maximum que l''on
175	veut prendre en compte dans le trace des isolignes traces par un
176	trait. Par defaut on prend le max (sur les pts mer)
177	du tableau passe ds le mot cle CONTOUR.
178
179	COAST_COLOR: the color of the coastline.
180	defaut value is 0 => black
181
182	COAST_THICK: the thickness of the coastline.
183	defaut value is 1
184
185	/CONT_NOFILL: activer pour ne pas remplir les points masques
186	pour les laisser en transparent!
187	Rq: on trace qd meme le contour du mask
188
189	CONT_COLOR: the color of the continent. defaut value is
190	(!d.n_colors - 1) < 255 => white
191
192	CONTMIN: lorsque CONTOUR est active, valeur minimum que l''on
193	veut prendre en compte dans le trace des isolignes traces par un
194	trait. Par defaut on prend le max (sur les pts mer)
195	du tableau passe ds le mot cle CONTOUR.
196
197	CONTNLEVEL: lorsque CONTOUR est active, nombre de contours
198	trace par un trait a dessiner (actif si
199	CONTLABEL=0) par defaut =20.
200
201	CONTOUR: si on veut tracer les contours d'un champ different que celui
202	que l''on dessin en couleur (par ex E-P en couleur et QSR en
203	contours). Doit etre un champ reponadnt aux meme caracteristiques
204	que l''argument numero 1 de pltz
205
206	ENDPOINTS: mot clef specifiant que l'on veut faire une coupe
207	verticale en diagonale. les coordonnees des extremites de
208	celle-ci sont alors definies les 4 elements du vecteur
209	ENDPOINTS: [x1,y1,x2,y2] qui sont les coordonnees
210
211	INTERVALLE: valeur d''un intervalle entre deux isolignes. Si
212	aucun min n''est specifie, on choisit un contour min qui va bien
213	avec l'intervalle specifie!. Si ce mot cle n''est pas specifie, on
214	trace 20 isolignes du min au max. Rq: Qd CONTOUR est active
215	INTERVALLE ne specifie que intervalle entre 2 isolignes coloriees en
216	couleur. Pour specifier l''intervalle entre 2 isolignes traces par un trait
217	utiliser CONTINTERVALLE.
218
219	/INV: inverse le vecteur couleur utilisee pour colorier le graphe
220	(sans toucher au noir, au blanc et a la palette utilisee)
221
222	ZRATIO: lorsque le dessin presente une partie zoomee, rapport de
223	taille entre la partie zommee, hz (hauteur zoom), et le dessin entier, ht
224	(hauteur total). Par defaut =2./3
225
226	LABEL: un entier n. si n different de 0, choisit le type de
227	label correspondant aux cas n. cf label.pro
228	Rq: Qd CONTOUR est active, ne specifie le type de label que pour les
229	isolignes coloriees en couleur. Pour celles tracees par un trait
230	utiliser CONTLABEL.
231
232	/LANDSCAPE: oblige la feuille ou la fenetre a etre en position
233	"allongee"
234
235	LCT: entier designant le numero de la palette de couleur que
236	l''on veut utiliser pour le plot.
237
238	MAXIN: permet de specifier la valeur maximum que l''on veut
239	prendre en compte dans le trace des contours a l''aide d''un
240	mot cle plutot que par l''argument max. Si l''argument et le
241	mot cle sont specifies en meme temps, c''est la valeur
242	specifiee par le mot cle qui est retenue.
243
244	MININ: permet de specifier la valeur minimum que l''on veut
245	prendre en compte dans le trace des contours a l''aide d''un
246	mot cle plutot que par l''argument min. Si l''argument et le
247	mot cle sont specifies en meme temps, c''est la valeur
248	specifiee par le mot cle qui est retenue.
249
250	NLEVEL: nombre de contours a dessiner. par defaut =20. actif si
251	LABEL=0 ou n'est pas specifie.
252
253	/NOCOLORBAR: activer si on ne veut pas de colorbar
254
255	/NOCONTOUR: activer si on ne veut pas de contour mais juste
256	les couleurs
257
258	/NOFILL: activer si on veut juste les contours en noir et
259	blanc sur fond blanc
260
261	/NOERASE: activer pour faire un dessin a l''ecran sans creer
262	une nouvelle fenetre
263
264	/NOTRI: pour forcer a ne pas utiliser de triangulation.
265
266	OVERPLOT: pour faire un plt par dessus un autre. Rq:
267	contrairemnet a l''utilisation de CONTOUR,
268	l''utilisation de ce mot clef ne modifie pas la legende ou/et
269	la barre de couleur.
270
271	PETITDESSIN: vecteur de 3 ou 4 elements, applique pour faire un
272	dessin sur une petite portion de feuille ou d''ecran. il delimite
273	la zone ds laquelle va etre fait le dessin
274	si il a 4 elements:
275	il est alors constitute des coordonnees -exprime en cm reperes par
276	rapport au coin en bas a gauche de la feuille ou de la fenetre
277	(en portrait comme en landscape)- du coin en bas a
278	gauche et du coin en haut a droite de la zone de dessin.
279	si il a 3 elements:
280	Ds ce cas, on divise la fenetre ou l''ecran en PETITDESSIN[0]
281	colonnes, en PETITDESSIN[1] lignes le dessin se faisant ds la
282	case numero PETITDESSIN[2].La numerotation commencant en haut
283	a gauche par le numero 1 et suivant apres dans le sens de
284	l''ecriture.
285	Par defaut on fait un dessin occupant la plus grande place possible
286	tout en concervant le rapport d''aspect (sauf qd REMPLI est active)
287
288	/PORTRAIT: oblige la feuille ou la fenetre a etre en position
289	"debout"
290
291	/POST: faire une sortie postscript. Ne marche que si on fait
292	un seul dessin sur la feuille. Si on fait plusieurs dessins,</div>
293
294
295
296
297	<h3>Parameters</h3>
298
299
300	<h4 id="_pltz_param_tab">tab
301
302
303
304
305
306
307
308
309	</h4>
310
311	<div class="comments"></div>
312
313	<h4 id="_pltz_param_giventype">giventype
314
315
316
317
318
319
320
321
322	</h4>
323
324	<div class="comments"></div>
325
326	<h4 id="_pltz_param_givenmin">givenmin
327
328
329
330
331
332
333
334
335	</h4>
336
337	<div class="comments"></div>
338
339	<h4 id="_pltz_param_givenmax">givenmax
340
341
342
343
344
345
346
347
348	</h4>
349
350	<div class="comments"></div>
351
352
353
354
355
356
357	<h3>Keywords</h3>
358
359	<h4 id="_pltz_keyword_BOXZOOM">BOXZOOM
360
361
362
363
364
365
366
367
368	</h4>
369
370	<div class="comments"></div>
371
372	<h4 id="_pltz_keyword_CONTOUR">CONTOUR
373
374
375
376
377
378
379
380
381	</h4>
382
383	<div class="comments"></div>
384
385	<h4 id="_pltz_keyword_ENDPOINTS">ENDPOINTS
386
387
388
389
390
391
392
393
394	</h4>
395
396	<div class="comments"></div>
397
398	<h4 id="_pltz_keyword_INTERVALLE">INTERVALLE
399
400
401
402
403
404
405
406
407	</h4>
408
409	<div class="comments"></div>
410
411	<h4 id="_pltz_keyword_INV">INV
412
413
414
415
416
417
418
419
420	</h4>
421
422	<div class="comments"></div>
423
424	<h4 id="_pltz_keyword_ZRATIO">ZRATIO
425
426
427
428
429
430
431
432
433	</h4>
434
435	<div class="comments"></div>
436
437	<h4 id="_pltz_keyword_CONTINTERVALLE">CONTINTERVALLE
438
439
440
441
442
443
444
445
446	</h4>
447
448	<div class="comments"></div>
449
450	<h4 id="_pltz_keyword_LABEL">LABEL
451
452
453
454
455
456
457
458
459	</h4>
460
461	<div class="comments"></div>
462
463	<h4 id="_pltz_keyword_CONTLABEL">CONTLABEL
464
465
466
467
468
469
470
471
472	</h4>
473
474	<div class="comments"></div>
475
476	<h4 id="_pltz_keyword_STYLE">STYLE
477
478
479
480
481
482
483
484
485	</h4>
486
487	<div class="comments"></div>
488
489	<h4 id="_pltz_keyword_CONTMAX">CONTMAX
490
491
492
493
494
495
496
497
498	</h4>
499
500	<div class="comments"></div>
501
502	<h4 id="_pltz_keyword_SIN">SIN
503
504
505
506
507
508
509
510
511	</h4>
512
513	<div class="comments"></div>
514
515	<h4 id="_pltz_keyword_TYPEIN">TYPEIN
516
517
518
519
520
521
522
523
524	</h4>
525
526	<div class="comments"></div>
527
528	<h4 id="_pltz_keyword_CONTMIN">CONTMIN
529
530
531
532
533
534
535
536
537	</h4>
538
539	<div class="comments"></div>
540
541	<h4 id="_pltz_keyword_NLEVEL">NLEVEL
542
543
544
545
546
547
548
549
550	</h4>
551
552	<div class="comments"></div>
553
554	<h4 id="_pltz_keyword_CONTNLEVEL">CONTNLEVEL
555
556
557
558
559
560
561
562
563	</h4>
564
565	<div class="comments"></div>
566
567	<h4 id="_pltz_keyword_NOTRI">NOTRI
568
569
570
571
572
573
574
575
576	</h4>
577
578	<div class="comments"></div>
579
580	<h4 id="_pltz_keyword_USETRI">USETRI
581
582
583
584
585
586
587
588
589	</h4>
590
591	<div class="comments"></div>
592
593	<h4 id="_pltz_keyword_FILLXDIR">FILLXDIR
594
595
596
597
598
599
600
601
602	</h4>
603
604	<div class="comments"></div>
605
606	<h4 id="_pltz_keyword_ZOOM">ZOOM
607
608
609
610
611
612
613
614
615	</h4>
616
617	<div class="comments"></div>
618
619	<h4 id="_pltz_keyword_XZ">XZ
620
621
622
623
624
625
626
627
628	</h4>
629
630	<div class="comments"></div>
631
632	<h4 id="_pltz_keyword_YZ">YZ
633
634
635
636
637
638
639
640
641	</h4>
642
643	<div class="comments"></div>
644
645	<h4 id="_pltz_keyword_MININ">MININ
646
647
648
649
650
651
652
653
654	</h4>
655
656	<div class="comments"></div>
657
658	<h4 id="_pltz_keyword_MAXIN">MAXIN
659
660
661
662
663
664
665
666
667	</h4>
668
669	<div class="comments"></div>
670
671	<h4 id="_pltz_keyword_STRICTFILL">STRICTFILL
672
673
674
675
676
677
678
679
680	</h4>
681
682	<div class="comments"></div>
683
684	<h4 id="_pltz_keyword_OVERPLOT">OVERPLOT
685
686
687
688
689
690
691
692
693	</h4>
694
695	<div class="comments"></div>
696
697	<h4 id="_pltz_keyword_MASKFILL">MASKFILL
698
699
700
701
702
703
704
705
706	</h4>
707
708	<div class="comments"></div>
709
710	<h4 id="_pltz_keyword_WDEPTH">WDEPTH
711
712
713
714
715
716
717
718
719	</h4>
720
721	<div class="comments"></div>
722
723	<h4 id="_pltz_keyword_REALSECTION">REALSECTION
724
725
726
727
728
729
730
731
732	</h4>
733
734	<div class="comments"></div>
735
736	<h4 id="_pltz_keyword__EXTRA">_EXTRA
737
738
739
740
741
742
743
744
745	</h4>
746
747	<div class="comments"></div>
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774	</div>
775
776	</div>
777
778
779
780	<div id="tagline">Produced by IDLdoc 2.0.</div>
781
782	</div>
783
784	</body>
785	</html>

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

Download in other formats: