Context Navigation

source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/PLOTS/DESSINE/pltt.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago
update documentation
File size: 18.6 KB

Line
1
2
3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4	<head>
5	<title>pltt.pro (SAXO Documentation Assistant)</title>
6	</head>
7
8	<body text="#000000" bgcolor="#FFFFFF">
9
10
11	<!-- Navbar template takes a structure with the following fields:
12	overview_href :
13	overview_selected :
14	dir_overview_href :
15	dir_overview_selected :
16	categories_href :
17	categories_selected :
18	index_href :
19	index_selected :
20	search_href :
21	search_selected :
22	file_selected :
23	source_href :
24	source_selected :
25	help_href :
26	help_selected :
27	etc_selected :
28
29	prev_file_href :
30	next_file_href :
31
32	view_single_page_href :
33	view_frames_href :
34
35	summary_fields_href :
36	summary_routine_href :
37	details_routine_href :
38
39	title :
40	subtitle :
41	user :
42	-->
43
44
45	<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46	<tr>
47	<td width="10%">
48	<a href="pltsc.html"><img src="./../../../prev.gif" border="0" alt="Previous"></a></td>
49	<td width="80%" align="center" valign="center">
50	<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../../home.html">Overview</a></font></td>
51	<td width="10%" align="right">
52	<a href="pltv.html"><img src="./../../../next.gif" border="0" alt="Next"></a></td>
53	</tr>
54	</table>
55
56
57	<h1><font size="-2">ToBeReviewed/PLOTS/DESSINE/</font></h1>
58	<h2>pltt.pro</h2>
59
60	<dl>
61	</dl>
62
63
64	Trace hovmoeller graphs: xt,yt,zt,t
65
66
67
68
69
70	<a name="#_pltt"></a>
71
72	<h2>pltt <font size="-1" color="#006633">
73	Graphics
74	</font></h2>
75
76	<p><font face="Courier">pltt<i>, <a href="#_pltt_keyword_tab">tab</a>, <a href="#_pltt_keyword_giventype">giventype</a>, <a href="#_pltt_keyword_givenmin">givenmin</a>, <a href="#_pltt_keyword_givenmax">givenmax</a>, <a href="#_pltt_keyword_datmin">datmin</a>, <a href="#_pltt_keyword_datmax">datmax</a></i>, <a href="#_pltt_keyword_BOXZOOM">BOXZOOM</a>=<i>BOXZOOM</i>, <a href="#_pltt_keyword_CONTOUR">CONTOUR</a>=<i>CONTOUR</i>, <a href="#_pltt_keyword_ENDPOINTS">ENDPOINTS</a>=<i>ENDPOINTS</i>, <a href="#_pltt_keyword_INTERVALLE">INTERVALLE</a>=<i>INTERVALLE</i>, <a href="#_pltt_keyword_INV">INV</a>=<i>INV</i>, <a href="#_pltt_keyword_CONTINTERVALLE">CONTINTERVALLE</a>=<i>CONTINTERVALLE</i>, <a href="#_pltt_keyword_LABEL">LABEL</a>=<i>integer</i>, <a href="#_pltt_keyword_CONTLABEL">CONTLABEL</a>=<i>integer</i>, <a href="#_pltt_keyword_STYLE">STYLE</a>=<i>STYLE</i>, <a href="#_pltt_keyword_CONTMAX">CONTMAX</a>=<i>CONTMAX</i>, <a href="#_pltt_keyword_CONTMIN">CONTMIN</a>=<i>CONTMIN</i>, <a href="#_pltt_keyword_NOFILL">NOFILL</a>=<i>NOFILL</i>, <a href="#_pltt_keyword_NLEVEL">NLEVEL</a>=<i>NLEVEL</i>, <a href="#_pltt_keyword_CONTNLEVEL">CONTNLEVEL</a>=<i>CONTNLEVEL</i>, <a href="#_pltt_keyword_COL1D">COL1D</a>=<i>COL1D</i>, <a href="#_pltt_keyword_STY1D">STY1D</a>=<i>STY1D</i>, <a href="#_pltt_keyword_MININ">MININ</a>=<i>MININ</i>, <a href="#_pltt_keyword_MAXIN">MAXIN</a>=<i>MAXIN</i>, <a href="#_pltt_keyword_OV1D">OV1D</a>=<i>OV1D</i>, <a href="#_pltt_keyword_FILTER">FILTER</a>=<i>FILTER</i>, <a href="#_pltt_keyword_TREND_TYPE">TREND_TYPE</a>=<i>TREND_TYPE</i>, <a href="#_pltt_keyword_REPEAT_C">REPEAT_C</a>=<i>REPEAT_C</i>, <a href="#_pltt_keyword_TYPEIN">TYPEIN</a>=<i>TYPEIN</i>, <a href="#_pltt_keyword_XT">XT</a>=<i>XT</i>, <a href="#_pltt_keyword_YT">YT</a>=<i>YT</i>, <a href="#_pltt_keyword_ZT">ZT</a>=<i>ZT</i>, <a href="#_pltt_keyword_TT">TT</a>=<i>TT</i>, <a href="#_pltt_keyword_STRICTFILL">STRICTFILL</a>=<i>STRICTFILL</i>, <a href="#_pltt_keyword_OVERPLOT">OVERPLOT</a>=<i>OVERPLOT</i>, <a href="#_pltt_keyword_EXCHANGE_XY">EXCHANGE_XY</a>=<i>EXCHANGE_XY</i>, <a href="#_pltt_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
77
78
79
80
81
82
83
84	<h3>Parameters</h3>
85
86
87	<a name="#_pltt_keyword_tab"></a>
88	<h4>tab
89	<font size="-1" color="#006633">in</font>
90
91
92	<font size="-1" color="#006633">required</font>
93
94
95
96
97	</h4>
98
99
100	The field whose we want to make the hovmoeller map can be 2 kind of thing:
101	1) An array which can be:
102	* 3d or 4d: array 'xt','yt','zt','t'. The last component is the time. In this case, the array will
103	pass in <a href="../../..//ToBeReviewed/CALCULS/grossemoyenne.html">grossemoyenne</a> to be averaged and become an 1d or 2d array.
104	* 2d: If the array is already 2d, it is not modified (beware, lands must
105	be masked at the value valmask) and nevertheless, type must be specified
106	to we know of which trace it is about.
107	To have a correct caption, respecify the extraction zone via BOXZOOM.
108	* 1d: only for traces of the 't' type. Nevertheless, type must be specified
109	to we know of which trace it is about.
110	To have a correct caption, respecify the extraction zone via BOXZOOM.
111	2) a structure respecting all criterions specified by <a href="../../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a>
112	See IDL> xhelp,'litchamp'. The array contained in the structure
113	respecting criterions of case 1)
114
115
116
117
118	<a name="#_pltt_keyword_giventype"></a>
119	<h4>giventype
120
121
122
123
124
125
126
127
128	</h4>
129
130
131
132
133
134	<a name="#_pltt_keyword_givenmin"></a>
135	<h4>givenmin
136
137
138
139
140
141
142
143
144	</h4>
145
146
147	valeur minimum que l''on veut prendre en compte dans le trace
148	des contours. Par defaut on prend le min de tableau (sur les pts mer)
149
150
151
152	<a name="#_pltt_keyword_givenmax"></a>
153	<h4>givenmax
154
155
156
157
158
159
160
161
162	</h4>
163
164
165	valeur maximum que l''on veut prendre en compte dans le trace
166	des contours. Par defaut on prend le max de tableau (sur les pts mer)
167
168
169
170	<a name="#_pltt_keyword_datmin"></a>
171	<h4>datmin
172
173
174
175
176
177
178
179
180	</h4>
181
182
183	c''est la borne inf de l''axe temporel. c''est un
184	longinteger de la forme yyyymmdd (ou bien yymmdd).
185
186
187
188	<a name="#_pltt_keyword_datmax"></a>
189	<h4>datmax
190
191
192
193
194
195
196
197
198	</h4>
199
200
201	c''est la borne max de l''axe temporel. c''est un
202	longinteger de la forme yyyymmdd (ou bien yymmdd)
203
204
205
206
207
208	<h3>Keywords</h3>
209
210
211	<a name="#_pltt_keyword_BOXZOOM"></a>
212	<h4>BOXZOOM
213
214
215
216
217
218
219
220
221	</h4>
222
223
224	Vector indicating the geographic zone (3d) on which the extraction of the field must
225	be done to do the hovmoeller.
226	If BOXZOOM has :
227	1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
228	2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
229	4 elements: The extraction is made on [Boxzoom, vert1, vert2]
230	5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
231	6 elements: The extraction is made on Boxzoom
232
233	Where lon1, lon2,lat1,lat2,vert1,vert2 are global variables defined at the last
234	<a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> !
235
236
237	<a name="#_pltt_keyword_CONTOUR"></a>
238	<h4>CONTOUR
239
240
241
242
243
244
245
246
247	</h4>
248
249
250	If we want to trace contours of a different field than the one
251	whose we have the colored drawing (by example E-P in color and QSR in contours).
252	It must be a field respecting same characteristics than the argument number one of pltt.
253
254
255	<a name="#_pltt_keyword_ENDPOINTS"></a>
256	<h4>ENDPOINTS
257
258
259
260
261
262
263
264
265	</h4>
266
267
268	keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities
269	of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are
270	coordinates.
271
272
273	<a name="#_pltt_keyword_INTERVALLE"></a>
274	<h4>INTERVALLE
275
276
277
278
279
280
281
282
283	</h4>
284
285
286	Value of an interval between two isolines. If there is none specified min,
287	we choose a min contour which goes well with the specified interval!. If this keyword is not
288	specified, we trace 20 isoline from the min to the max. Comment: When CONTOUR is activated,
289	INTERVALLE only specify the interval between 2 colored isolines. To specify the interval
290	between 2 isolines traced by a trait, use CONTINTERVALLE.
291
292
293	<a name="#_pltt_keyword_INV"></a>
294	<h4>INV
295
296
297
298
299
300
301
302
303	</h4>
304
305
306	Invert the color vector used to color the graph
307	(without use the black, the white and the used palette)
308
309
310	<a name="#_pltt_keyword_CONTINTERVALLE"></a>
311	<h4>CONTINTERVALLE
312
313
314
315
316
317
318
319
320	</h4>
321
322
323	When CONTOUR is activated, it is the value between 2 isolines
324	traced by a trait. So it can be different from the one specified by INTERVALLE which,
325	in this case, does not control colored isolines in color anymore. If there is noone
326	specified min, we choose a contour min which goes well with the specified interval!
327	If this keyword is not specified, we trace 20 isolines from the min to the max.
328
329
330	<a name="#_pltt_keyword_LABEL"></a>
331	<h4>LABEL
332
333
334
335
336
337	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
338
339
340	</h4>
341
342
343	If n different of 0, it choose the label's type
344	corresponding to cases n. cf <a href="../../..//ToBeReviewed/PLOTS/LABEL/label.html">label</a>
345	Comment: When CONTOUR is activated, it only specify the label's type for colored isolines.
346	For these one traced by a trait, use CONTLABEL.
347
348
349	<a name="#_pltt_keyword_CONTLABEL"></a>
350	<h4>CONTLABEL
351
352
353
354
355
356	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
357
358
359	</h4>
360
361
362	When CONTOUR is activated, if n
363	is different of 0, choose the label type corresponding to n cases for
364	the traced by a traitisolines. To specify the type of label of the
365	colored contour, use LABEL
366
367
368	<a name="#_pltt_keyword_STYLE"></a>
369	<h4>STYLE
370
371
372
373
374
375
376	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>style</i></font>
377
378	</h4>
379
380
381	Contour's style to adopt to draw isolines. See <a href="../../..//ToBeReviewed/PLOTS/style.html">style</a> for more informations
382
383
384	<a name="#_pltt_keyword_CONTMAX"></a>
385	<h4>CONTMAX
386
387
388
389
390
391
392	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>we take the max of the array passed in the keyword CONTOUR (on ocean points)</i></font>
393
394	</h4>
395
396
397	When CONTOUR is activated, max value we want to consider in the isoline
398	traced by a trait's line.
399
400
401	<a name="#_pltt_keyword_CONTMIN"></a>
402	<h4>CONTMIN
403
404
405
406
407
408
409	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>we take the min of the array passed in the keyword CONTOUR (on ocean points)</i></font>
410
411	</h4>
412
413
414	When CONTOUR is activated, min value we want to consider in the isoline
415	traced by a trait's line.
416
417
418	<a name="#_pltt_keyword_NOFILL"></a>
419	<h4>NOFILL
420
421
422
423
424
425
426
427
428	</h4>
429
430
431	To make just isolines with no filling
432
433
434	<a name="#_pltt_keyword_NLEVEL"></a>
435	<h4>NLEVEL
436
437
438
439
440
441
442	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>20</i></font>
443
444	</h4>
445
446
447	Number of contours to draw. active if
448	LABEL=0 or is not specified.
449
450
451	<a name="#_pltt_keyword_CONTNLEVEL"></a>
452	<h4>CONTNLEVEL
453
454
455
456
457
458
459	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>20</i></font>
460
461	</h4>
462
463
464	When CONTOUR is activated, it is the number of contours
465	traced by a trait for drawing (active if
466	CONTLABEL=0).
467
468
469	When CONTOUR is activated, it is the number of contours
470	traced by a trait for drawing (active if
471	CONTLABEL=0).
472
473
474	<a name="#_pltt_keyword_COL1D"></a>
475	<h4>COL1D
476
477
478
479
480
481
482
483
484	</h4>
485
486
487	--OBSOLETE--Color number when we make a trace 1d by default, 0.It is better to use the
488	keyword COLOR used by plot.
489
490
491	<a name="#_pltt_keyword_STY1D"></a>
492	<h4>STY1D
493
494
495
496
497
498
499
500
501	</h4>
502
503
504	--OBSOLETE--
505	Number of the style used when we make a 1d drawing. We should better use the
506	keyword LINESTYLE which is tho one of the plot. Beware, this keyword is still
507	useful if we want to d bars instead of curves, put sty1d='bar'
508
509
510	<a name="#_pltt_keyword_MININ"></a>
511	<h4>MININ
512
513
514
515
516
517
518
519
520	</h4>
521
522
523	to specify the min value we want to plot with a keyword instead of with the
524	input parameter min. If min is defined by both, parameter and keyword, the
525	keyword is retained.
526
527
528	<a name="#_pltt_keyword_MAXIN"></a>
529	<h4>MAXIN
530
531
532
533
534
535
536
537
538	</h4>
539
540
541	to specify the max value we want to plot with a keyword instead of with the
542	input parameter max. If max is defined by both, parameter and keyword, the
543	keyword is retained.
544
545
546	<a name="#_pltt_keyword_OV1D"></a>
547	<h4>OV1D
548
549
550
551
552
553
554
555
556	</h4>
557
558
559	Allows to overprint a 1d curve over a precedent 1d drawing.
560
561
562	<a name="#_pltt_keyword_FILTER"></a>
563	<h4>FILTER
564
565
566
567
568
569
570
571
572	</h4>
573
574
575	Apply a slippery average of width FILTER
576
577
578	<a name="#_pltt_keyword_TREND_TYPE"></a>
579	<h4>TREND_TYPE
580
581
582
583
584
585
586
587
588	</h4>
589
590
591	Modify field by calling <pro>trends</pro>
592
593
594	<a name="#_pltt_keyword_REPEAT_C"></a>
595	<h4>REPEAT_C
596
597
598
599
600
601
602
603
604	</h4>
605
606
607
608	<a name="#_pltt_keyword_TYPEIN"></a>
609	<h4>TYPEIN
610
611
612
613
614
615
616
617
618	</h4>
619
620
621	allows to specify the type of hovmoeller we want to do
622	'xt','yt','zt','t'
623	with help of a keyword rather than the argument type. If the argument and the
624	keyword are specified in the same time, it is the value specified by the
625	keyword which is retained.
626
627
628	<a name="#_pltt_keyword_XT"></a>
629	<h4>XT
630
631
632
633
634
635
636
637
638	</h4>
639
640
641
642	<a name="#_pltt_keyword_YT"></a>
643	<h4>YT
644
645
646
647
648
649
650
651
652	</h4>
653
654
655
656	<a name="#_pltt_keyword_ZT"></a>
657	<h4>ZT
658
659
660
661
662
663
664
665
666	</h4>
667
668
669
670	<a name="#_pltt_keyword_TT"></a>
671	<h4>TT
672
673
674
675
676
677
678
679
680	</h4>
681
682
683
684	<a name="#_pltt_keyword_STRICTFILL"></a>
685	<h4>STRICTFILL
686
687
688
689
690
691
692
693
694	</h4>
695
696
697	Activate this keyword to that the filling of contours be
698	precisely done between the min and the max specified. Values inferior/superior at the
699	specified min/max are not filled. Note that max values a considered
700	as missing values so cells containing one or more corners with
701	values above max will have no contours drawn through them.
702
703
704	<a name="#_pltt_keyword_OVERPLOT"></a>
705	<h4>OVERPLOT
706
707
708
709
710
711
712
713
714	</h4>
715
716
717	To make a plot over an other one.
718	Comment: Contrarily to the use of CONTOUR or VECTEUR, the use of this keyword
719	does not the caption and/or the color bar.
720
721
722	<a name="#_pltt_keyword_EXCHANGE_XY"></a>
723	<h4>EXCHANGE_XY
724
725
726
727
728
729
730
731
732	</h4>
733
734
735	Allows to invert axes.
736
737
738	<a name="#_pltt_keyword__EXTRA"></a>
739	<h4>_EXTRA
740
741
742
743
744
745
746
747
748	</h4>
749
750
751	Used to pass keywords
752
753
754
755
756
757	</pre><h3>Version history</h3>
758
759	<h4>Version</h4>
760	$Id: pltt.pro 328 2007-12-13 19:27:11Z smasson $
761
762	<h4>History</h4>
763	Sebastien Masson (smasson@lodyc.jussieu.fr)
764	27/5/98
765	Jerome Vialard (adapting plt to hovmoeller drawing)
766	2/7/98
767	Sebastien Masson 14/8/98 (continents,barres)
768	15/1/98
769	Adaptation for arrays 3 and 4d to the average be done in pltt rather than during the reading.
770	Sebastien Masson 14/8/98
771	7/1999
772	Eric Guilyardi 29/7/99 FILTER, TREND_TYPE,
773	REPEAT_C
774	Sebastien Masson 08/02/2000 checkfield and
775	usetri keyword.
776
777
778
779	<h3>Known issues</h3>
780
781
782	<h4>Todo items</h4>
783	seb: definition of parameters, L.426 à 427, L. 492 à 493
784
785
786
787	<h3>Other attributes</h3>
788
789
790	<h4>Uses routines</h4>
791	common.pro
792
793
794
795
796
797	<font size="-3"><p> </p></font>
798	<hr size="1" color="#CCCCCC"/>
799
800
801
802
803	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0.</font></p>
804
805	</body>
806	</html>

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

Download in other formats: