Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DESSINE/pltt.html @ 89

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago
add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 21.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>pltt.pro (IDLdoc API 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="pltt.pro (IDLdoc API documentation)";
19	}
20	</script>
21	</head>
22
23	<body onload="setTitle();">
24
25	<div id="navbar_title">
26	<h1>IDLdoc API 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="pltsc.html"><<prev file</a> \| <a href="pltz.html">next file >></a>    <a href="pltt.html" 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">pltt.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="_pltt">
103
104	<h2><a class="top" href="#container">top</a>pltt </h2>
105
106	<p class="header">
107	pltt<span class="result">, <a href="#_pltt_param_tab">tab</a>, <a href="#_pltt_param_giventype">giventype</a>, <a href="#_pltt_param_givenmin">givenmin</a>, <a href="#_pltt_param_givenmax">givenmax</a>, <a href="#_pltt_param_datmin">datmin</a>, <a href="#_pltt_param_datmax">datmax</a></span>, <a href="#_pltt_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_pltt_keyword_CONTOUR">CONTOUR</a>=<span class="result">CONTOUR</span>, <a href="#_pltt_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_pltt_keyword_INTERVALLE">INTERVALLE</a>=<span class="result">INTERVALLE</span>, <a href="#_pltt_keyword_INV">INV</a>=<span class="result">INV</span>, <a href="#_pltt_keyword_CONTINTERVALLE">CONTINTERVALLE</a>=<span class="result">CONTINTERVALLE</span>, <a href="#_pltt_keyword_LABEL">LABEL</a>=<span class="result">LABEL</span>, <a href="#_pltt_keyword_CONTLABEL">CONTLABEL</a>=<span class="result">CONTLABEL</span>, <a href="#_pltt_keyword_STYLE">STYLE</a>=<span class="result">STYLE</span>, <a href="#_pltt_keyword_CONTMAX">CONTMAX</a>=<span class="result">CONTMAX</span>, <a href="#_pltt_keyword_CONTMIN">CONTMIN</a>=<span class="result">CONTMIN</span>, <a href="#_pltt_keyword_NLEVEL">NLEVEL</a>=<span class="result">NLEVEL</span>, <a href="#_pltt_keyword_CONTNLEVEL">CONTNLEVEL</a>=<span class="result">CONTNLEVEL</span>, <a href="#_pltt_keyword_COL1D">COL1D</a>=<span class="result">COL1D</span>, <a href="#_pltt_keyword_STY1D">STY1D</a>=<span class="result">STY1D</span>, <a href="#_pltt_keyword_MININ">MININ</a>=<span class="result">MININ</span>, <a href="#_pltt_keyword_MAXIN">MAXIN</a>=<span class="result">MAXIN</span>, <a href="#_pltt_keyword_OV1D">OV1D</a>=<span class="result">OV1D</span>, <a href="#_pltt_keyword_FILTER">FILTER</a>=<span class="result">FILTER</span>, <a href="#_pltt_keyword_TREND_TYPE">TREND_TYPE</a>=<span class="result">TREND_TYPE</span>, <a href="#_pltt_keyword_REPEAT_C">REPEAT_C</a>=<span class="result">REPEAT_C</span>, <a href="#_pltt_keyword_TYPEIN">TYPEIN</a>=<span class="result">TYPEIN</span>, <a href="#_pltt_keyword_XT">XT</a>=<span class="result">XT</span>, <a href="#_pltt_keyword_YT">YT</a>=<span class="result">YT</span>, <a href="#_pltt_keyword_ZT">ZT</a>=<span class="result">ZT</span>, <a href="#_pltt_keyword_TT">TT</a>=<span class="result">TT</span>, <a href="#_pltt_keyword_STRICTFILL">STRICTFILL</a>=<span class="result">STRICTFILL</span>, <a href="#_pltt_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_pltt_keyword_EXCHANGE_XY">EXCHANGE_XY</a>=<span class="result">EXCHANGE_XY</span>, <a href="#_pltt_keyword__extra">_extra</a>=<span class="result">_extra</span></p>
108
109	<div class="comments">
110	NAME:
111	PLTT
112
113	PURPOSE:
114	trace des graphes hovmoller
115
116	CATEGORY:
117	Graphics, trace des graphes hovmoller: xt,yt,zt,t
118
119	CALLING SEQUENCE:
120	pltt, champ,type [,min[, max[, datmin[, datmax]]]]
121
122	INPUTS:
123	champ: le champ dont on veut faire le hovmoller champ
124	peut etre de 2 types:
125	1) un tableu qui peut etre:
126	* 3d ou 4d: la derniere composante etant le temps. dans ce
127	cas, le tableau va passer dans grossemoyenne pour etre
128	moyennee suivant et devenir un tableau 2d ou 1d.
129	* 2d: si tableau est deja 2d, il n''est pas modifie
130	(attention les terres doivent etre masquees a la valeure
131	valmask) et type doit qd meme etre specifie pour qu''on
132	sache de quel trace il sagit. Pour avoir une legende
133	correcte, respecifier la zone d''extraction via BOXZOOM
134	* 1d: uniquement pour les traces de type 't'. Type doit qd
135	meme etre specifie pour qu''on sache de quel trace il
136	sagit. Pour avoir une legende correcte, respecifier la zone
137	d''extraction via BOXZOOM
138	2) une structure repondant aux critaire specifies par
139	litchamp.pro. cf. IDL> xhelp,'litchamp'. Le tableau contennu ds
140	la structure repondant aux criteres du cas 1) cf. ci-dessus
141
142	TYPE: type de hovmoller que l''on veut faire:
143	'xt','yt','zt','t'
144
145	ces arguments ne sont pas obligatoires:
146
147	MAX: valeur maximum que l''on veut prendre en compte dans le trace
148	des contours. Par defaut on prend le max de tableau (sur les pts mer)
149
150	MIN: valeur minimum que l''on veut prendre en compte dans le trace
151	des contours. Par defaut on prend le min de tableau (sur les pts
152	mer)
153
154	DATMIN: c''est la borne inf de l''axe temporel. c''est un
155	longinteger de la forme yyyymmdd (ou bien yymmdd).
156
157	DATMAX: c''est la borne max de l''axe temporel. c''est un
158	longinteger de la forme yyyymmdd (ou bien yymmdd)
159
160	KEYWORD PARAMETERS:
161
162	BOXZOOM:vecteur indiquant la zone geographique (3d) sur laquelle doit
163	etre fait l''extraction du champ pour faire le hovmoeller.
164	Si BOXZOOM a :
165	1 element : l''extraction est faite sur [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
166	2 elements: l''extraction est faite sur [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
167	4 elements: l''extraction est faite sur [Boxzoom, vert1, vert2]
168	5 elements: l''extraction est faite sur [Boxzoom[0:3], 0, Boxzoom[4]]
169	6 elements: l''extraction est faite sur Boxzoom
170
171	Ou lon1, lon2,lat1,lat2,vert1,vert2 sont les variables globales
172	definies lors du dernier domdef!
173
174	CB_TITLE: le titre de la colorbar
175
176	CB_SUBTITLE: le soustitre de la colorbar
177
178	CB_CHARSIZE: The character size of the color bar annotations
179
180	COAST_COLOR: the color of the coastline.
181	defaut value is 0 => black
182
183	COAST_THICK: the thickness of the coastline.
184	defaut value is 1
185
186	/CONT_NOFILL: activer pour ne pas remplir les points masques
187	pour les laisser en transparent!
188	Rq: on trace qd meme le contour du mask
189
190	CONT_COLOR: the color of the continent. defaut value is
191	(!d.n_colors - 1) < 255 => white
192
193	CONTINTERVALLE: lorsque CONTOUR est active, valeur d''un
194	intervalle entre deux isolignes traces par un trait. Il peut ainsi
195	etre different de celui specifie par INTERVALLE
196	qui, cas ce cas, ne controle que les isolignes coloriees en
197	couleurs. Si aucun min n''est specifie, on choisit un contour min qui va
198	bien avec l''intervalle specifie!. Si ce mot cle n''est pas
199	specifie, on trace 20 isolignes du min au max.
200
201	CONTLABEL: un entier n. lorsque CONTOUR est active, si n
202	different de 0, choisit le type de label correspondant aux cas n
203	pour les isolignes tracees par un trait. Pour specifier le type de
204	label du contour en couleur, utiliser LABEL
205
206	CONTMAX: lorsque CONTOUR est active, valeur maximum que l''on
207	veut prendre en compte dans le trace des isolignes traces par un
208	trait. Par defaut on prend le max (sur les pts mer)
209	du tableau passe ds le mot cle CONTOUR.
210
211	CONTMIN: lorsque CONTOUR est active, valeur minimum que l''on
212	veut prendre en compte dans le trace des isolignes traces par un
213	trait. Par defaut on prend le max (sur les pts mer)
214	du tableau passe ds le mot cle CONTOUR.
215
216	CONTNLEVEL: lorsque CONTOUR est active, nombre de contours
217	trace par un trait a dessiner (actif si
218	CONTLABEL=0) par defaut =20.
219
220	CONTOUR: si on veut tracer les contours d''un champ different que celui
221	que l''on dessin en couleur (par ex E-P en couleur et QSR en
222	contours). Doit etre un champ reponadnt aux meme caracteristiques
223	que l''argument numero 1 de pltt
224
225	ENDPOINTS: mot clef specifiant que l'on veut faire une coupe
226	verticale en diagonale. les coordonnees des extremites de
227	celle-ci sont alors definies les 4 elements du vecteur
228	ENDPOINTS: [x1,y1,x2,y2] qui sont les coordonnees
229
230	/EXCHANGE_XY: permet d''intervertir les axes.
231
232	FILTER: applique une moyenne glissante de largeur FILTER
233
234	INTERVALLE: valeur d''un intervalle entre deux isolignes. Si
235	aucun min n''est specifie, on choisit un contour min qui va bien
236	avec l''intervalle specifie!. Si ce mot cle n''est pas specifie, on
237	trace 20 isolignes du min au max. Rq: Qd CONTOUR est active
238	INTERVALLE ne specifie que intervalle entre 2 isolignes coloriees en
239	couleur. Pour specifier l''intervalle entre 2 isolignes traces par un trait
240	utiliser CONTINTERVALLE.
241
242	/INV: inverse le vecteur couleur utilise pour colorier le graphe
243	(sans toucher au noir, au blanc et a la palette utilisee)
244
245	LABEL: un entier n. si n different de 0, choisit le type de
246	label correspondant aux cas n. cf label.pro
247	Rq: Qd CONTOUR est active, ne specifie le type de label que pour les
248	isolignes coloriees en couleur. Pour celles tracees par un trait
249	utiliser CONTLABEL.
250
251	/LANDSCAPE: oblige la feuille ou le fenetre a l''ecran a etre
252	en position "allongee".
253
254	LCT: entier designant le numero de la palette de couleur que
255	l''on veut utiliser pour le plot.
256
257	COL1d: --OBSOLETE--numero de la couleur qd on fait un trace 1d
258	par defaut, 0. il faut mieux utiliser le mot cle COLOR utilise
259	par plot
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	CONTNLEVEL: nombre de contours a dessiner qd on utilise ajoutcontour
277	active par le mot cle CONTOUR.(actif si CONTLABEL=0) par defaut =20.
278
279	/NOCOLORBAR: activer si on ne veut pas de colorbar
280
281	/NOCONTOUR: activer si on ne veut pas de contour mais juste
282	les couleurs
283
284	/NOFILL: activer si on veut juste les contours en noir et
285	blanc sur fond blanc
286
287	/NOERASE: activer pour faire un dessin a l''ecran sans creer
288	une nouvelle fenetre. Rq: activer ds le cas d''un Postscript de
289	plusieurs traces de type 't' pour ne pas faire un Postscript de
290	plusieurs pages
291
292	/OV1D:permet de surimprimer un courbe 1d a un precedent trace 1d.
293
294	OVERPLOT: pour faire un pltt par dessus un autre. Rq:
295	contrairemnet a l''utilisation de CONTOUR,
296	l''utilisation de ce mot clef ne modifie pas la legende ou/et
297	la barre de couleur. dans le cas d''un plot 1d, contrairement
298	a ov1d, on peut changer les axes et les ranges.
299
300	PETITDESSIN: vecteur de 3 ou 4 elements, applique pour faire un
301	dessin sur une petite portion de feuille ou d''ecran. il delimite
302	la zone ds laquelle va etre fait le dessin
303	si il a 4 elements:
304	il est alors constitute des coordonnees -exprime en cm reperes par
305	rapport au coin en bas a gauche de la feuille ou de la fenetre
306	(en portrait comme en landscape)- du coin en bas a
307	gauche et du coin en haut a droite de la zone de dessin.
308	si il a 3 elements:
309	Ds ce cas, on divise la fenetre ou l''ecran en PETITDESSIN[0]
310	colonnes, en PETITDESSIN[1] lignes le dessin se faisant ds la
311	case numero PETITDESSIN[2].La numerotation commencant en haut
312	a gauche par le numero 1 et suivant apres dans le sens de
313	l''ecriture.
314	Par defaut on fait un dessin occupant la plus grande place possible
315	tout en concervant le rapport d''aspect (sauf qd REMPLI est active)
316
317	/PORTRAIT: oblige la feuille ou la fenetre a etre en position "debout".
318
319	/POST: faire une sortie postscript. Ne marche que si on fait
320	un seul dessin sur la feuille. Si on fait plusieurs dessins,</div>
321
322
323
324
325	<h3>Parameters</h3>
326
327
328	<h4 id="_pltt_param_tab">tab
329
330
331
332
333
334
335
336
337	</h4>
338
339	<div class="comments"></div>
340
341	<h4 id="_pltt_param_giventype">giventype
342
343
344
345
346
347
348
349
350	</h4>
351
352	<div class="comments"></div>
353
354	<h4 id="_pltt_param_givenmin">givenmin
355
356
357
358
359
360
361
362
363	</h4>
364
365	<div class="comments"></div>
366
367	<h4 id="_pltt_param_givenmax">givenmax
368
369
370
371
372
373
374
375
376	</h4>
377
378	<div class="comments"></div>
379
380	<h4 id="_pltt_param_datmin">datmin
381
382
383
384
385
386
387
388
389	</h4>
390
391	<div class="comments"></div>
392
393	<h4 id="_pltt_param_datmax">datmax
394
395
396
397
398
399
400
401
402	</h4>
403
404	<div class="comments"></div>
405
406
407
408
409
410
411	<h3>Keywords</h3>
412
413	<h4 id="_pltt_keyword_BOXZOOM">BOXZOOM
414
415
416
417
418
419
420
421
422	</h4>
423
424	<div class="comments"></div>
425
426	<h4 id="_pltt_keyword_CONTOUR">CONTOUR
427
428
429
430
431
432
433
434
435	</h4>
436
437	<div class="comments"></div>
438
439	<h4 id="_pltt_keyword_ENDPOINTS">ENDPOINTS
440
441
442
443
444
445
446
447
448	</h4>
449
450	<div class="comments"></div>
451
452	<h4 id="_pltt_keyword_INTERVALLE">INTERVALLE
453
454
455
456
457
458
459
460
461	</h4>
462
463	<div class="comments"></div>
464
465	<h4 id="_pltt_keyword_INV">INV
466
467
468
469
470
471
472
473
474	</h4>
475
476	<div class="comments"></div>
477
478	<h4 id="_pltt_keyword_CONTINTERVALLE">CONTINTERVALLE
479
480
481
482
483
484
485
486
487	</h4>
488
489	<div class="comments"></div>
490
491	<h4 id="_pltt_keyword_LABEL">LABEL
492
493
494
495
496
497
498
499
500	</h4>
501
502	<div class="comments"></div>
503
504	<h4 id="_pltt_keyword_CONTLABEL">CONTLABEL
505
506
507
508
509
510
511
512
513	</h4>
514
515	<div class="comments"></div>
516
517	<h4 id="_pltt_keyword_STYLE">STYLE
518
519
520
521
522
523
524
525
526	</h4>
527
528	<div class="comments"></div>
529
530	<h4 id="_pltt_keyword_CONTMAX">CONTMAX
531
532
533
534
535
536
537
538
539	</h4>
540
541	<div class="comments"></div>
542
543	<h4 id="_pltt_keyword_CONTMIN">CONTMIN
544
545
546
547
548
549
550
551
552	</h4>
553
554	<div class="comments"></div>
555
556	<h4 id="_pltt_keyword_NLEVEL">NLEVEL
557
558
559
560
561
562
563
564
565	</h4>
566
567	<div class="comments"></div>
568
569	<h4 id="_pltt_keyword_CONTNLEVEL">CONTNLEVEL
570
571
572
573
574
575
576
577
578	</h4>
579
580	<div class="comments"></div>
581
582	<h4 id="_pltt_keyword_COL1D">COL1D
583
584
585
586
587
588
589
590
591	</h4>
592
593	<div class="comments"></div>
594
595	<h4 id="_pltt_keyword_STY1D">STY1D
596
597
598
599
600
601
602
603
604	</h4>
605
606	<div class="comments"></div>
607
608	<h4 id="_pltt_keyword_MININ">MININ
609
610
611
612
613
614
615
616
617	</h4>
618
619	<div class="comments"></div>
620
621	<h4 id="_pltt_keyword_MAXIN">MAXIN
622
623
624
625
626
627
628
629
630	</h4>
631
632	<div class="comments"></div>
633
634	<h4 id="_pltt_keyword_OV1D">OV1D
635
636
637
638
639
640
641
642
643	</h4>
644
645	<div class="comments"></div>
646
647	<h4 id="_pltt_keyword_FILTER">FILTER
648
649
650
651
652
653
654
655
656	</h4>
657
658	<div class="comments"></div>
659
660	<h4 id="_pltt_keyword_TREND_TYPE">TREND_TYPE
661
662
663
664
665
666
667
668
669	</h4>
670
671	<div class="comments"></div>
672
673	<h4 id="_pltt_keyword_REPEAT_C">REPEAT_C
674
675
676
677
678
679
680
681
682	</h4>
683
684	<div class="comments"></div>
685
686	<h4 id="_pltt_keyword_TYPEIN">TYPEIN
687
688
689
690
691
692
693
694
695	</h4>
696
697	<div class="comments"></div>
698
699	<h4 id="_pltt_keyword_XT">XT
700
701
702
703
704
705
706
707
708	</h4>
709
710	<div class="comments"></div>
711
712	<h4 id="_pltt_keyword_YT">YT
713
714
715
716
717
718
719
720
721	</h4>
722
723	<div class="comments"></div>
724
725	<h4 id="_pltt_keyword_ZT">ZT
726
727
728
729
730
731
732
733
734	</h4>
735
736	<div class="comments"></div>
737
738	<h4 id="_pltt_keyword_TT">TT
739
740
741
742
743
744
745
746
747	</h4>
748
749	<div class="comments"></div>
750
751	<h4 id="_pltt_keyword_STRICTFILL">STRICTFILL
752
753
754
755
756
757
758
759
760	</h4>
761
762	<div class="comments"></div>
763
764	<h4 id="_pltt_keyword_OVERPLOT">OVERPLOT
765
766
767
768
769
770
771
772
773	</h4>
774
775	<div class="comments"></div>
776
777	<h4 id="_pltt_keyword_EXCHANGE_XY">EXCHANGE_XY
778
779
780
781
782
783
784
785
786	</h4>
787
788	<div class="comments"></div>
789
790	<h4 id="_pltt_keyword__extra">_extra
791
792
793
794
795
796
797
798
799	</h4>
800
801	<div class="comments"></div>
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828	</div>
829
830	</div>
831
832
833
834	<div id="tagline">Produced by IDLdoc 2.0.</div>
835
836	</div>
837
838	</body>
839	</html>

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

Download in other formats: