Context Navigation

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

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

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

Download in other formats: