Context Navigation

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

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

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

Download in other formats: