Context Navigation

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

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

Download in other formats: