Context Navigation

plt.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago
update documentation
File size: 18.4 KB

Line
1
2
3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4	<head>
5	<title>plt.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="bar_plot.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="plt1d.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>plt.pro</h2>
59
60	<dl>
61	</dl>
62
63
64	Draw horizontal graph (map) with <a href="/Applications/itt/idl64/help/online_help/CONTOUR.html">CONTOUR</a> procedure
65
66
67
68
69
70	<a name="#_plt"></a>
71
72	<h2>plt <font size="-1" color="#006633">
73	Graphics
74	</font></h2>
75
76	<p><font face="Courier">plt<i>, <a href="#_plt_keyword_tab1">tab1</a>[, <a href="#_plt_keyword_param2">param2</a>][, <a href="#_plt_keyword_param3">param3</a>][, <a href="#_plt_keyword_param4">param4</a>]</i>, <a href="#_plt_keyword_REALCONT">REALCONT</a>=<i>REALCONT</i>, <a href="#_plt_keyword_CONTOUR">CONTOUR</a>=<i>CONTOUR</i>, <a href="#_plt_keyword_INTERVALLE">INTERVALLE</a>=<i>INTERVALLE</i>, <a href="#_plt_keyword_INV">INV</a>=<i>INV</i>, <a href="#_plt_keyword_GRIDTYPE">GRIDTYPE</a>=<i>GRIDTYPE</i>, <a href="#_plt_keyword_BOXZOOM">BOXZOOM</a>=<i>vector</i>, <a href="#_plt_keyword_CONTINTERVALLE">CONTINTERVALLE</a>=<i>CONTINTERVALLE</i>, <a href="#_plt_keyword_LABEL">LABEL</a>=<i>integer</i>, <a href="#_plt_keyword_CONTLABEL">CONTLABEL</a>=<i>integer</i>, <a href="#_plt_keyword_STYLE">STYLE</a>=<i>STYLE</i>, <a href="#_plt_keyword_CONTMAX">CONTMAX</a>=<i>CONTMAX</i>, <a href="#_plt_keyword_CONTMIN">CONTMIN</a>=<i>CONTMIN</i>, <a href="#_plt_keyword_NLEVEL">NLEVEL</a>=<i>NLEVEL</i>, <a href="#_plt_keyword_CONTNLEVEL">CONTNLEVEL</a>=<i>CONTNLEVEL</i>, <a href="#_plt_keyword_VECTEUR">VECTEUR</a>=<i>struct</i>, <a href="#_plt_keyword_MAP">MAP</a>=<i>MAP</i>, <a href="#_plt_keyword_MININ">MININ</a>=<i>MININ</i>, <a href="#_plt_keyword_MAXIN">MAXIN</a>=<i>MAXIN</i>, <a href="#_plt_keyword_NOFILL">NOFILL</a>=<i>NOFILL</i>, <a href="#_plt_keyword_CONT_NOFILL">CONT_NOFILL</a>=<i>CONT_NOFILL</i>, <a href="#_plt_keyword_USETRI">USETRI</a>=<i>USETRI</i>, <a href="#_plt_keyword_NOTRI">NOTRI</a>=<i>NOTRI</i>, <a href="#_plt_keyword_MASKFILL">MASKFILL</a>=<i>MASKFILL</i>, <a href="#_plt_keyword_DUPLICATE">DUPLICATE</a>=<i>DUPLICATE</i>, <a href="#_plt_keyword_STRICTFILL">STRICTFILL</a>=<i>STRICTFILL</i>, <a href="#_plt_keyword_OVERPLOT">OVERPLOT</a>=<i>OVERPLOT</i>, <a href="#_plt_keyword_DECIMATETRI">DECIMATETRI</a>=<i>DECIMATETRI</i>, <a href="#_plt_keyword_LABMAP">LABMAP</a>=<i>LABMAP</i>, <a href="#_plt_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="#_plt_keyword_tab1"></a>
88	<h4>tab1
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 horizontal map can be:
101	1) an array. if needed, its mean along the z and t direction
102	will be automatically performed.
103	2) a structure respecting all criterions specified by
104	<a href="../../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a>
105
106
107
108	<a name="#_plt_keyword_param2"></a>
109	<h4>param2
110	<font size="-1" color="#006633">in</font>
111
112	<font size="-1" color="#006633">optional</font>
113
114
115
116	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>min of tab1 (on ocean points)</i></font>
117
118	</h4>
119
120
121	Min value we want to consider in the contour's drawing.
122	Note: Could also be the type of plot that can be only 'xy' for plt
123
124
125
126	<a name="#_plt_keyword_param3"></a>
127	<h4>param3
128	<font size="-1" color="#006633">in</font>
129
130	<font size="-1" color="#006633">optional</font>
131
132
133
134	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>max of tab1 (on ocean points)</i></font>
135
136	</h4>
137
138
139	Max value we want to consider in the contour's drawing.
140	Note: if param2 is defined as 'xy' then param3 is used to define the min (see param2)
141
142
143
144	<a name="#_plt_keyword_param4"></a>
145	<h4>param4
146	<font size="-1" color="#006633">in</font>
147
148	<font size="-1" color="#006633">optional</font>
149
150
151
152	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'xy'</i></font>
153
154	</h4>
155
156
157	Type of plot (can be only 'xy' for plt).
158	Note: if param2 is defined as 'xy' then param4 is used to define the max (see param3)
159
160
161
162
163
164	<h3>Keywords</h3>
165
166
167	<a name="#_plt_keyword_REALCONT"></a>
168	<h4>REALCONT
169
170
171
172
173
174
175
176
177	</h4>
178
179
180	Allow to draw continents defined in IDL. REALCONT can have 2 forms:
181	/REALCONT: we draw continents in place of the mask
182	REALCONT=2 we draw continent's contour over the mask (this allows
183	to see if the mask correspond at real continents).
184
185
186	<a name="#_plt_keyword_CONTOUR"></a>
187	<h4>CONTOUR
188
189
190
191
192
193
194
195
196	</h4>
197
198
199	If we want to trace contours of a different field than the one
200	whose we have the colored drawing (by example E-P in color and QSR in contours).
201	It must be a field respecting same characteristics than the argument number one of <a href="../../..//ToBeReviewed/PLOTS/DESSINE/plt.html">plt</a>.
202
203
204	<a name="#_plt_keyword_INTERVALLE"></a>
205	<h4>INTERVALLE
206
207
208
209
210
211
212
213
214	</h4>
215
216
217	Value of an interval between to isoline. If there is none specified min,
218	we choose a min contour which goes well with the specified interval!
219	If this keyword is not specified, we trace 20 isolines from the min
220	to the max.
221	Comment: When CONTOUR is activated, INTERVALLE only specify the interval
222	between 2 colored isolines. To specify the interval
223	between 2 isolines traced by a trait, use CONTINTERVALLE.
224
225
226	<a name="#_plt_keyword_INV"></a>
227	<h4>INV
228
229
230
231
232
233
234
235
236	</h4>
237
238
239	Invert the color vector used to color the graph
240	(without use the black, the white and the used palette)
241
242
243	<a name="#_plt_keyword_GRIDTYPE"></a>
244	<h4>GRIDTYPE
245
246
247
248
249
250
251
252
253	</h4>
254
255
256	'U','T','V','W' or 'F'
257	to specify possibly the grid on which the field is joined.
258	Comment: In this case, we should use a structure like field.
259
260
261	<a name="#_plt_keyword_BOXZOOM"></a>
262	<h4>BOXZOOM
263
264
265
266
267
268	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
269
270
271	</h4>
272
273
274	Vector indicating the geographic zone on which we want to cut the map.
275	If BOXZOOM has :
276	1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
277	2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
278	4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
279	5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
280	6 elements: The extraction is made on Boxzoom
281
282	Where lon1, lon2, lat1, lat2 are global variables defined at the last
283	<a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> !
284
285
286	<a name="#_plt_keyword_CONTINTERVALLE"></a>
287	<h4>CONTINTERVALLE
288
289
290
291
292
293
294
295
296	</h4>
297
298
299	When CONTOUR is activated, it is the value between 2 isolines
300	traced by a trait. So it can be different from the one specified by INTERVALLE which,
301	in this case, does not control colored isolines in color anymore. If there is noone
302	specified min, we choose a contour min which goes well with the specified interval!
303	If this keyword is not specified, we trace 20 isolines from the min to the max.
304
305
306	<a name="#_plt_keyword_LABEL"></a>
307	<h4>LABEL
308
309
310
311
312
313	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
314
315
316	</h4>
317
318
319	It is an integer n. If n different of 0, it choose the label's type
320	corresponding to cases n. cf <a href="../../..//ToBeReviewed/PLOTS/LABEL/label.html">label</a>
321	Comment: When CONTOUR is activated, it only specify the label's type for colored isolines.
322	For these ones traced by a trait, use CONTLABEL.
323
324
325	<a name="#_plt_keyword_CONTLABEL"></a>
326	<h4>CONTLABEL
327
328
329
330
331
332	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
333
334
335	</h4>
336
337
338	It is an integer n. When CONTOUR is activated, if n
339	is different of 0, choose the label type corresponding to n cases for
340	the traced by a traitisolines. To specify the type of label of the
341	colored contour, use LABEL
342
343
344	<a name="#_plt_keyword_STYLE"></a>
345	<h4>STYLE
346
347
348
349
350
351
352	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>style</i></font>
353
354	</h4>
355
356
357	Contour's style to adopt to draw isolines. See <a href="../../..//ToBeReviewed/PLOTS/style.html">style</a> for more informations
358
359
360	<a name="#_plt_keyword_CONTMAX"></a>
361	<h4>CONTMAX
362
363
364
365
366
367
368	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>The max of the array passed in the keyword CONTOUR (on ocean points)</i></font>
369
370	</h4>
371
372
373	When CONTOUR is activated, max value we want to consider in the isoline
374	traced by a trait's line
375
376
377	<a name="#_plt_keyword_CONTMIN"></a>
378	<h4>CONTMIN
379
380
381
382
383
384
385	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>The min of the array passed in the keyword CONTOUR (on ocean points)</i></font>
386
387	</h4>
388
389
390	When CONTOUR is activated, min value we want to consider in the isoline
391	traced by a trait's line.
392
393
394	<a name="#_plt_keyword_NLEVEL"></a>
395	<h4>NLEVEL
396
397
398
399
400
401
402	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>20</i></font>
403
404	</h4>
405
406
407	Number of contour to draw. Active if LABEL=0 or is not specified.
408
409
410	<a name="#_plt_keyword_CONTNLEVEL"></a>
411	<h4>CONTNLEVEL
412
413
414
415
416
417
418	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>20</i></font>
419
420	</h4>
421
422
423	When CONTOUR is activated, it is the number of contours
424	traced by a trait for drawing (active if
425	CONTLABEL=0)
426
427
428	<a name="#_plt_keyword_VECTEUR"></a>
429	<h4>VECTEUR
430
431
432
433
434
435	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>struct</i></font>
436
437
438	</h4>
439
440	is also appropriated.
441
442
443	<a name="#_plt_keyword_MAP"></a>
444	<h4>MAP
445
446
447
448
449
450
451	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>Cylindrical projection</i></font>
452
453	</h4>
454
455
456	We use it when we want to do a projection.
457	This keyword can be of two types:
458	MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of <a href="/Applications/itt/idl64/help/online_help/MAP_SET.html">MAP_SET</a>).
459	/MAP: In this case, map is automatically calculated have the value:
460	map = [0, (lon1+lon2)/2., 0]
461	Comment: A good way to choose the type of the projection we want to do is to have a look at IDL demo:
462	IDL> demo
463	Then choose "Mapping" and "Global Mapping Demo"
464	Comment2: By default it is a cylindrical projection which is done (with or without the keyword map).
465	If we want an other projection, MAP must be activated and we have to add the keyword: /nom_projection.
466	For example, for a polar projection centered on the south pole:
467	IDL> domdef,-180,180,-90,-45
468	IDL> plt, tab, /stereo,map=[-90,0,0]
469
470
471	<a name="#_plt_keyword_MININ"></a>
472	<h4>MININ
473
474
475
476
477
478
479
480
481	</h4>
482
483
484	to specify the min value we want to plot with a keyword instead of with the
485	input parameter min. If min is defined by both, parameter and keyword, the
486	keyword is retained.
487
488
489	<a name="#_plt_keyword_MAXIN"></a>
490	<h4>MAXIN
491
492
493
494
495
496
497
498
499	</h4>
500
501
502	to specify the max value we want to plot with a keyword instead of with the
503	input parameter max. If max is defined by both, parameter and keyword, the
504	keyword is retained.
505
506
507	<a name="#_plt_keyword_NOFILL"></a>
508	<h4>NOFILL
509
510
511
512
513
514
515
516
517	</h4>
518
519
520	To make just isolines with no filling
521
522
523	<a name="#_plt_keyword_CONT_NOFILL"></a>
524	<h4>CONT_NOFILL
525
526
527
528
529
530
531
532
533	</h4>
534
535
536	Activate it not to fill the point mask to let them transparent!
537	Comment: Nevertheless, we trace mask's contour.
538
539
540	<a name="#_plt_keyword_USETRI"></a>
541	<h4>USETRI
542
543
544
545
546
547
548
549
550	</h4>
551
552
553	To force using triangulation.
554
555
556	<a name="#_plt_keyword_NOTRI"></a>
557	<h4>NOTRI
558
559
560
561
562
563
564
565
566	</h4>
567
568
569	To force not to use the triangulation. Beware, in this case, the
570	drawing only works if the grid is undeformed (It means that each point of a longitude
571	give one latitude and each point of a latitude give one longitude) except if we use
572	the keyword CELL_FILL=2.
573	Comment: if the field contain points !values.f_nan, then we even do a triangulation.
574
575
576	<a name="#_plt_keyword_MASKFILL"></a>
577	<h4>MASKFILL
578
579
580
581
582
583
584
585
586	</h4>
587
588
589
590
591	<a name="#_plt_keyword_DUPLICATE"></a>
592	<h4>DUPLICATE
593
594
595
596
597
598
599
600
601	</h4>
602
603
604
605
606	<a name="#_plt_keyword_STRICTFILL"></a>
607	<h4>STRICTFILL
608
609
610
611
612
613
614
615
616	</h4>
617
618
619	Activate this keyword to that the filling of contours be
620	precisely done between the min and the max specified. Values inferior/superior at the
621	specified min/max are not filled. Note that max values a considered
622	as missing values so cells containing one or more corners with
623	values above max will have no contours drawn through them.
624
625
626	<a name="#_plt_keyword_OVERPLOT"></a>
627	<h4>OVERPLOT
628
629
630
631
632
633
634
635
636	</h4>
637
638
639	To make a plot over an other one.
640	Comment: Contrarily to the use of CONTOUR or VECTEUR, the use of this keyword
641	does not the caption and/or the color bar.
642
643
644	<a name="#_plt_keyword_DECIMATETRI"></a>
645	<h4>DECIMATETRI
646
647
648
649
650
651
652
653
654	</h4>
655
656
657
658
659	<a name="#_plt_keyword_LABMAP"></a>
660	<h4>LABMAP
661
662
663
664
665
666
667	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>labmap</i></font>
668
669	</h4>
670
671
672	Corresponds to LABEL keyword of <a href="/Applications/itt/idl64/help/online_help/MAP_SET.html">MAP_SET</a>.
673
674
675	<a name="#_plt_keyword__EXTRA"></a>
676	<h4>_EXTRA
677
678
679
680
681
682
683
684
685	</h4>
686
687
688	Used to pass keywords
689
690
691
692
693
694	</pre><h3>Version history</h3>
695
696	<h4>Version</h4>
697	$Id: plt.pro 390 2009-01-28 11:16:06Z smasson $
698
699	<h4>History</h4>
700	Sebastien Masson (smasson@lodyc.jussieu.fr)
701	7/1999
702	Sebastien Masson 08/02/2000 checkfield and
703	notri keyword (or triangule = -1) .
704
705
706
707	<h3>Known issues</h3>
708
709
710	<h4>Todo items</h4> seb
711	Changer param "tab1",keyword "REMPLI", "UNLABSUR", "UNSUR2",
712	"UNVECTSUR"+ quelques trucs dans la routine.
713
714
715	<h3>Other attributes</h3>
716
717
718	<h4>Uses routines</h4>
719	<a href="../../..//Obsolete/common.html">common</a>
720
721
722
723
724
725	<font size="-3"><p> </p></font>
726	<hr size="1" color="#CCCCCC"/>
727
728
729
730
731	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0.</font></p>
732
733	</body>
734	</html>

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

Context Navigation

source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/PLOTS/DESSINE/plt.html @ 402

Download in other formats: