Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DESSINE/plt.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: 20.4 KB

Line
1
2	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5	<!-- Generated by IDLdoc 2.0 -->
6
7	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8	<head>
9	<title>plt.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="plt.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="bar_plot.html"><<prev file</a> \| <a href="plt1d.html">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>
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">plt.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="_plt">
103
104	<h2><a class="top" href="#container">top</a>plt </h2>
105
106	<p class="header">
107	plt<span class="result">, <a href="#_plt_param_tab1">tab1</a>, <a href="#_plt_param_giventype">giventype</a>, <a href="#_plt_param_givenmin">givenmin</a>, <a href="#_plt_param_givenmax">givenmax</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>
108
109	<div class="comments">
110	NAME:
111	PLT
112
113	PURPOSE:
114	trace des graphes horizontaux (cartes)
115
116	CATEGORY:
117	Graphics, trace des graphes horizontaux
118
119	CALLING SEQUENCE:
120	plt, champ [,min[, max]]
121
122	INPUTS:
123	champ: le champ dont on veut faire la carte horizontale champ
124	peut etre de 2 types:
125	1) an array. if needed, its mean along the z and t direction
126	will be automatically performed.
127	2) une structure repondant aux critaire specifies par
128	litchamp.pro. cf. IDL> xhelp,'litchamp'
129
130	ces ARGUMENTS ne sont pas obligatoires:
131
132	MAX: valeur maximum que l''on veut prendre en compte dans le trace
133	des contours. Par defaut on prend le max de tab1 (sur les pts mer)
134
135	MIN: valeur minimum que l''on veut prendre en compte dans le trace
136	des contours. Par defaut on prend le min de tab1 (sur les pts mer)
137
138	KEYWORD PARAMETERS:
139
140	BOXZOOM:vecteur indiquant la zone geographique sur laquelle doit etre
141	faite la coupe. Si BOXZOOM a :
142	1 element : l''extraction est faite sur [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
143	2 elements: l''extraction est faite sur [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
144	4 elements: l''extraction est faite sur [Boxzoom, 0, max([gdept, gdepw])]
145	5 elements: l''extraction est faite sur [Boxzoom[0:3], 0, Boxzoom[4]]
146	6 elements: l''extraction est faite sur Boxzoom
147
148	Ou lon1, lon2,lat1,lat2 sont les variables globales
149	definies lors du dernier domdef!
150
151	REALCONT:Permet de dessiner les continents definits ds IDL. REALCONT
152	peut prendre deux formes:
153	/REALCONT: on dessine les continents a la place du mask
154	REALCONT=2 on dessine le contours des continents par
155	dessus le dessin masque (ceci permet de voir si le masque
156	correspond bien aux continents reels).
157
158	CB_TITLE: le titre de la colorbar
159
160	CB_SUBTITLE: le soustitre de la colorbar
161
162	CB_CHARSIZE: The character size of the color bar annotations
163
164	CMREF: la longeur en cm sur le papier que doit faire la fleche
165	de norme normeref. par defaut ajuste au dessin et compris entre
166	.5 et 1.5 cm
167
168	COAST_COLOR: the color of the coastline.
169	defaut value is 0 => black
170
171	COAST_THICK: the thickness of the coastline.
172	defaut value is 1
173
174	/CONT_NOFILL: activer pour ne pas remplir les points masques
175	pour les laisser en transparent!
176	Rq: on trace qd meme le contour du mask
177
178	CONT_COLOR: the color of the continent. defaut value is
179	(!d.n_colors - 1) < 255 => white
180
181	CONTINTERVALLE: lorsque CONTOUR est active, valeur d'un
182	intervalle entre deux isolignes traces par un trait. Il peut ainsi
183	etre different de celui specifie par INTERVALLE
184	qui, cas ce cas, ne controle que les isolignes coloriees en
185	couleurs. Si aucun min n''est specifie, on choisit un contour min qui va
186	bien avec l''intervalle specifie!. Si ce mot cle n''est pas
187	specifie, on trace 20 isolignes du min au max.
188
189	CONTLABEL: un entier n. lorsque CONTOUR est active, si n
190	different de 0, choisit le type de label correspondant aux cas n
191	pour les isolignes tracees par un trait. Pour specifier le type de
192	label du contour en couleur, utiliser LABEL
193
194	CONTMAX: lorsque CONTOUR est active, valeur maximum que l''on
195	veut prendre en compte dans le trace des isolignes traces par un
196	trait. Par defaut on prend le max (sur les pts mer)
197	du tableau passe ds le mot cle CONTOUR.
198
199	CONTMIN: lorsque CONTOUR est active, valeur minimum que l''on
200	veut prendre en compte dans le trace des isolignes traces par un
201	trait. Par defaut on prend le max (sur les pts mer)
202	du tableau passe ds le mot cle CONTOUR.
203
204	CONTNLEVEL: lorsque CONTOUR est active, nombre de contours
205	trace par un trait a dessiner (actif si
206	CONTLABEL=0) par defaut =20.
207
208	CONTOUR: si on veut tracer les contours d'un champ different que celui
209	que l''on dessin en couleur (par ex E-P en couleur et QSR en
210	contours). Doit etre un champ repondant aux meme caracteristiques
211	que l''argument numero 1 de plt
212
213	GRIDTYPE:'U','T','V','W' ou 'F' pour specifer eventuellement la
214	grille a laquelle est rattache le champ. Rq: il afaut mieux
215	utiliser ds ce cas une structure comme champ
216
217	INTERVALLE: valeur d''un intervalle entre deux isolignes. Si
218	aucun min n''est specifie, on choisit un contour min qui va bien
219	avec l'intervalle specifie!. Si ce mot cle n''est pas specifie, on
220	trace 20 isolignes du min au max. Rq: Qd CONTOUR est active
221	INTERVALLE ne specifie que intervalle entre 2 isolignes coloriees en
222	couleur. Pour specifier l''intervalle entre 2 isolignes traces par un trait
223	utiliser CONTINTERVALLE.
224
225	/INV: inverse le vecteur couleur utilise pour colorier le graphe
226	(sans toucher au noir, au blanc et a la palette utilisee)
227
228	LABEL: un entier n. si n different de 0, choisit le type de
229	label correspondant aux cas n. cf label.pro
230	Rq: Qd CONTOUR est active, ne specifie le type de label que pour les
231	isolignes coloriees en couleur. Pour celles tracees par un trait
232	utiliser CONTLABEL.
233
234	/LANDSCAPE: oblige la feuille ou le fenetre a l''ecran a etre
235	en position "allongee".
236
237	LCT: entier designant le numero de la palette de couleur que
238	l''on veut utiliser pour le plot.
239
240	MAP:Mot cle a actine losque l''on veut faire une projection.
241	Ce mot cle peut etre de 2 formes:
242	MAP=[P0lat,P0lon,Rot]. Pour la description de ces 3 valeurs cf.
243	l''aide en ligne de MAP_SET.
244	/MAP: dans ce cas map est calcule tout seul et vaut:
245	map = [0, (lon1+lon2)/2., 0]
246	Rq: Un bon moyen de choisir sa projection est la valeur du vecteur
247	MAP est d''utiliser la demo d''IDL5.2:
248	IDL> demo
249	Puis choisir earth sciences et mapping.
250	Rq2: Par defaut c''est une projection cylindrique qui est effectuee
251	(avec ou sans le mot cle map). Si on veut une autre projection MAP
252	doit etre active et il faut rajouter le mot cle: /nom_projection.
253	par ex pour une projection polaire centree sur le pole sud:
254	IDL> domdef,-180,180,-90,-45
255	IDL> plt, tab, /stereo,map=[-90,0,0]
256
257	labmap: corresponds to label keywords of map_set. Defaut
258	definition is labmap=1
259
260
261	MAXIN: permet de specifier la valeur maximum que l''on veut
262	prendre en compte dans le trace des contours a l''aide d''un
263	mot cle plutot que par l''argument max. Si l''argument et le
264	mot cle sont specifies en meme temps, c''est la valeur
265	specifiee par le mot cle qui est retenue.
266
267	MININ: permet de specifier la valeur minimum que l''on veut
268	prendre en compte dans le trace des contours a l''aide d''un
269	mot cle plutot que par l''argument min. Si l''argument et le
270	mot cle sont specifies en meme temps, c''est la valeur
271	specifiee par le mot cle qui est retenue.
272
273	NLEVEL: nombre de contours a dessiner. par defaut =20. actif si
274	LABEL=0 ou n'est pas specifie.
275
276	/NOCOLORBAR: activer si on ne veut pas de colorbar
277
278	/NOCONTOUR: activer si on ne veut pas de contour mais juste
279	les couleurs
280
281	/NOFILL: activer si on veut juste les contours en noir et
282	blanc sur fond blanc
283
284	/NOERASE: activer pour faire un dessin a l''ecran sans creer
285	une nouvelle fenetre
286
287	NORMEREF: la norme de la fleche de reference. par defaut on
288	essaie de faire qqch qui colle pas trop mal!
289
290	/NOTRI: pour forcer a ne pas utiliser de
291	triangulation. Attention dans ce cas le trace ne marchera que
292	si la grille est non deformee (cad, chaque pts d''une
293	longitude donnee a la meme latitude et chaque pts d''une
294	latitude donnee a la meme longitude) sauf si on utilise le mot
295	clef CELL_FILL=2. Rq si le champ contient des points a
296	!values.f_nan alors on fait qd meme une triangulation.
297
298	OVERPLOT: pour faire un plt par dessus un autre. Rq:
299	contrairemnet a l''utilisation de CONTOUR ou de VECTEUR,
300	l''utilisation de ce mot clef ne modifie pas la legende ou/et
301	la barre de couleur.
302
303	PETITDESSIN: vecteur de 3 ou 4 elements, applique pour faire un
304	dessin sur une petite portion de feuille ou d''ecran. il delimite
305	la zone ds laquelle va etre fait le dessin
306	si il a 4 elements:
307	il est alors constitute des coordonnees -exprime en cm reperes par
308	rapport au coin en bas a gauche de la feuille ou de la fenetre
309	(en portrait comme en landscape)- du coin en bas a
310	gauche et du coin en haut a droite de la zone de dessin.
311	si il a 3 elements:
312	Ds ce cas, on divise la fenetre ou l''ecran en PETITDESSIN[0]
313	colonnes, en PETITDESSIN[1] lignes le dessin se faisant ds la
314	case numero PETITDESSIN[2].La numerotation commencant en haut
315	a gauche par le numero 1 et suivant apres dans le sens de
316	l''ecriture.
317	Par defaut on fait un dessin occupant la plus grande place possible
318	tout en concervant le rapport d''aspect (sauf qd REMPLI est active)
319
320	/PORTRAIT: oblige la feuille ou la fenetre a etre en position "debout".
321
322	/POST: faire une sortie postscript. Ne marche que si on fait
323	un seul dessin sur la feuille. Si on fait plusieurs dessins,</div>
324
325
326
327
328	<h3>Parameters</h3>
329
330
331	<h4 id="_plt_param_tab1">tab1
332
333
334
335
336
337
338
339
340	</h4>
341
342	<div class="comments"></div>
343
344	<h4 id="_plt_param_giventype">giventype
345
346
347
348
349
350
351
352
353	</h4>
354
355	<div class="comments"></div>
356
357	<h4 id="_plt_param_givenmin">givenmin
358
359
360
361
362
363
364
365
366	</h4>
367
368	<div class="comments"></div>
369
370	<h4 id="_plt_param_givenmax">givenmax
371
372
373
374
375
376
377
378
379	</h4>
380
381	<div class="comments"></div>
382
383
384
385
386
387
388	<h3>Keywords</h3>
389
390	<h4 id="_plt_keyword_REALCONT">REALCONT
391
392
393
394
395
396
397
398
399	</h4>
400
401	<div class="comments"></div>
402
403	<h4 id="_plt_keyword_CONTOUR">CONTOUR
404
405
406
407
408
409
410
411
412	</h4>
413
414	<div class="comments"></div>
415
416	<h4 id="_plt_keyword_INTERVALLE">INTERVALLE
417
418
419
420
421
422
423
424
425	</h4>
426
427	<div class="comments"></div>
428
429	<h4 id="_plt_keyword_INV">INV
430
431
432
433
434
435
436
437
438	</h4>
439
440	<div class="comments"></div>
441
442	<h4 id="_plt_keyword_GRIDTYPE">GRIDTYPE
443
444
445
446
447
448
449
450
451	</h4>
452
453	<div class="comments"></div>
454
455	<h4 id="_plt_keyword_BOXZOOM">BOXZOOM
456
457
458
459
460
461
462
463
464	</h4>
465
466	<div class="comments"></div>
467
468	<h4 id="_plt_keyword_CONTINTERVALLE">CONTINTERVALLE
469
470
471
472
473
474
475
476
477	</h4>
478
479	<div class="comments"></div>
480
481	<h4 id="_plt_keyword_LABEL">LABEL
482
483
484
485
486
487
488
489
490	</h4>
491
492	<div class="comments"></div>
493
494	<h4 id="_plt_keyword_CONTLABEL">CONTLABEL
495
496
497
498
499
500
501
502
503	</h4>
504
505	<div class="comments"></div>
506
507	<h4 id="_plt_keyword_STYLE">STYLE
508
509
510
511
512
513
514
515
516	</h4>
517
518	<div class="comments"></div>
519
520	<h4 id="_plt_keyword_CONTMAX">CONTMAX
521
522
523
524
525
526
527
528
529	</h4>
530
531	<div class="comments"></div>
532
533	<h4 id="_plt_keyword_CONTMIN">CONTMIN
534
535
536
537
538
539
540
541
542	</h4>
543
544	<div class="comments"></div>
545
546	<h4 id="_plt_keyword_NLEVEL">NLEVEL
547
548
549
550
551
552
553
554
555	</h4>
556
557	<div class="comments"></div>
558
559	<h4 id="_plt_keyword_CONTNLEVEL">CONTNLEVEL
560
561
562
563
564
565
566
567
568	</h4>
569
570	<div class="comments"></div>
571
572	<h4 id="_plt_keyword_VECTEUR">VECTEUR
573
574
575
576
577
578
579
580
581	</h4>
582
583	<div class="comments"></div>
584
585	<h4 id="_plt_keyword_MAP">MAP
586
587
588
589
590
591
592
593
594	</h4>
595
596	<div class="comments"></div>
597
598	<h4 id="_plt_keyword_MININ">MININ
599
600
601
602
603
604
605
606
607	</h4>
608
609	<div class="comments"></div>
610
611	<h4 id="_plt_keyword_MAXIN">MAXIN
612
613
614
615
616
617
618
619
620	</h4>
621
622	<div class="comments"></div>
623
624	<h4 id="_plt_keyword_CONT_NOFILL">CONT_NOFILL
625
626
627
628
629
630
631
632
633	</h4>
634
635	<div class="comments"></div>
636
637	<h4 id="_plt_keyword_USETRI">USETRI
638
639
640
641
642
643
644
645
646	</h4>
647
648	<div class="comments"></div>
649
650	<h4 id="_plt_keyword_NOTRI">NOTRI
651
652
653
654
655
656
657
658
659	</h4>
660
661	<div class="comments"></div>
662
663	<h4 id="_plt_keyword_MASKFILL">MASKFILL
664
665
666
667
668
669
670
671
672	</h4>
673
674	<div class="comments"></div>
675
676	<h4 id="_plt_keyword_DUPLICATE">DUPLICATE
677
678
679
680
681
682
683
684
685	</h4>
686
687	<div class="comments"></div>
688
689	<h4 id="_plt_keyword_STRICTFILL">STRICTFILL
690
691
692
693
694
695
696
697
698	</h4>
699
700	<div class="comments"></div>
701
702	<h4 id="_plt_keyword_OVERPLOT">OVERPLOT
703
704
705
706
707
708
709
710
711	</h4>
712
713	<div class="comments"></div>
714
715	<h4 id="_plt_keyword_DECIMATETRI">DECIMATETRI
716
717
718
719
720
721
722
723
724	</h4>
725
726	<div class="comments"></div>
727
728	<h4 id="_plt_keyword_LABMAP">LABMAP
729
730
731
732
733
734
735
736
737	</h4>
738
739	<div class="comments"></div>
740
741	<h4 id="_plt_keyword__extra">_extra
742
743
744
745
746
747
748
749
750	</h4>
751
752	<div class="comments"></div>
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779	</div>
780
781	</div>
782
783
784
785	<div id="tagline">Produced by IDLdoc 2.0.</div>
786
787	</div>
788
789	</body>
790	</html>

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

Download in other formats: