Context Navigation

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

Last change on this file since 163 was 163, checked in by navarro, 18 years ago
header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 17.5 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 CONTOUR 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_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	litchamp.pro. cf. IDL> xhelp,'litchamp'
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 form:
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 plt.
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 internal between to isoline. If there is none specified min,
218	we choose a min contour which goes well with the specified interval!. If this keyword is not
219	specified, we trace 20 isoline from the min to the max. Comment: When CONTOUR is activated,
220	INTERVALLE only specify the interval between 2 colored isoline. To specify the interval
221	between 2 isolines traced by a trait, use CONTINTERVALLE.
222
223
224	<a name="#_plt_keyword_INV"></a>
225	<h4>INV
226
227
228
229
230
231
232
233
234	</h4>
235
236
237	Invert the color vector used to color the graph
238	(without use the black, the white and the used palette)
239
240
241	<a name="#_plt_keyword_GRIDTYPE"></a>
242	<h4>GRIDTYPE
243
244
245
246
247
248
249
250
251	</h4>
252
253	'U','T','V','W' or 'F' to specify possibly the grid on which the field is joined.
254	Comment: In this case, we should use a structure like field.
255
256
257	<a name="#_plt_keyword_BOXZOOM"></a>
258	<h4>BOXZOOM
259
260
261
262
263
264	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
265
266
267	</h4>
268
269
270	Vector indicating the geographic zone on which we want to cut the map.
271	If BOXZOOM has :
272	1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
273	2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
274	4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
275	5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
276	6 elements: The extraction is made on Boxzoom
277
278	Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef!
279
280
281	<a name="#_plt_keyword_CONTINTERVALLE"></a>
282	<h4>CONTINTERVALLE
283
284
285
286
287
288
289
290
291	</h4>
292
293
294	When CONTOUR is activated, it is the value between 2 isolines
295	traced by a trait. So it can be different from the one specified by INTERVALLE which,
296	in this case, does not control colored isolines in color anymore. If there is noone
297	specified min, we choose a contour min which goes well with the specified interval!
298	If this keyword is not specified, we trace 20 isolines from the min to the max.
299
300
301	<a name="#_plt_keyword_LABEL"></a>
302	<h4>LABEL
303
304
305
306
307
308	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
309
310
311	</h4>
312
313
314	It is an integer n. If n different of 0, it choose the label's type
315	corresponding to cases n. cf label.pro
316	Comment: When CONTOUR is activated, it only specify the label's type for colored isolines.
317	For these one traced by a trait, use CONTLABEL.
318
319
320	<a name="#_plt_keyword_CONTLABEL"></a>
321	<h4>CONTLABEL
322
323
324
325
326
327	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
328
329
330	</h4>
331
332
333	It is an integer n. When CONTOUR is activated, if n
334	is different of 0, choose the label type corresponding to n cases for
335	the traced by a traitisolines. To specify the type of label of the
336	colored contour, use LABEL
337
338
339	<a name="#_plt_keyword_STYLE"></a>
340	<h4>STYLE
341
342
343
344
345
346
347	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>style</i></font>
348
349	</h4>
350
351
352	Contour's style to adopt to draw isolines.
353
354
355	<a name="#_plt_keyword_CONTMAX"></a>
356	<h4>CONTMAX
357
358
359
360
361
362
363	<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>
364
365	</h4>
366
367
368	When CONTOUR is activated, max value we want to consider in the isoline
369	traced by a trait's line
370
371
372	<a name="#_plt_keyword_CONTMIN"></a>
373	<h4>CONTMIN
374
375
376
377
378
379
380	<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>
381
382	</h4>
383
384
385	When CONTOUR is activated, min value we want to consider in the isoline
386	traced by a trait's line.
387
388
389	<a name="#_plt_keyword_NLEVEL"></a>
390	<h4>NLEVEL
391
392
393
394
395
396
397	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>20</i></font>
398
399	</h4>
400
401
402	Number of contour to draw by default =20. active if
403	LABEL=0 or is not specified.
404
405
406	<a name="#_plt_keyword_CONTNLEVEL"></a>
407	<h4>CONTNLEVEL
408
409
410
411
412
413
414	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>20</i></font>
415
416	</h4>
417
418
419	When CONTOUR is activated, it is the number of contours
420	traced by a trait for drawing (active if
421	CONTLABEL=0)
422
423
424	<a name="#_plt_keyword_VECTEUR"></a>
425	<h4>VECTEUR
426
427
428
429
430
431	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>struct</i></font>
432
433
434	</h4>
435
436	is also appropriated.
437
438
439	<a name="#_plt_keyword_MAP"></a>
440	<h4>MAP
441
442
443
444
445
446
447	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>Cylindrical projection</i></font>
448
449	</h4>
450
451
452	We use it when we want to do a projection.
453	This keyword can be of two types:
454	MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of MAP_SET).
455	/MAP: In this case, map is automatically calculated have the value:
456	map = [0, (lon1+lon2)/2., 0]
457	Comment: A good way to choose the type of the projection we want to do is to have a look at IDL demo:
458	IDL> demo
459	Then choose earth sciences and mapping.
460	Comment2: By default it is a cylindrical projection which is effectuated (with or without the keyword map).
461	If we want an other projection, MAP must be activated and we have to add the keyword: /nom_projection.
462	For example, for a polar projection centered on the south pole:
463	IDL> domdef,-180,180,-90,-45
464	IDL> plt, tab, /stereo,map=[-90,0,0]
465
466
467	<a name="#_plt_keyword_MININ"></a>
468	<h4>MININ
469
470
471
472
473
474
475
476
477	</h4>
478
479
480	to specify the min value we want to plot with a keyword instead of with the
481	input parameter min. If min is defined by both, parameter and keyword, the
482	keyword is retained.
483
484
485	<a name="#_plt_keyword_MAXIN"></a>
486	<h4>MAXIN
487
488
489
490
491
492
493
494
495	</h4>
496
497
498	to specify the max value we want to plot with a keyword instead of with the
499	input parameter max. If max is defined by both, parameter and keyword, the
500	keyword is retained.
501
502
503	<a name="#_plt_keyword_CONT_NOFILL"></a>
504	<h4>CONT_NOFILL
505
506
507
508
509
510
511
512
513	</h4>
514
515
516	Activate it not to fill the point mask to let them transparent!
517	Comment: Nevertheless, we trace mask's contour.
518
519
520	<a name="#_plt_keyword_USETRI"></a>
521	<h4>USETRI
522
523
524
525
526
527
528
529
530	</h4>
531
532
533	To force using triangulation.
534
535
536	<a name="#_plt_keyword_NOTRI"></a>
537	<h4>NOTRI
538
539
540
541
542
543
544
545
546	</h4>
547
548
549	To force not to use the triangulation. Beware, in this case, the
550	drawing only works if the grid is undeformed (It means that each point of a longitude
551	give one latitude and each point of a latitude give one longitude) except if we use
552	the keyword CELL_FILL=2.
553	Comment: if the field contain points !values.f_nan, then we even do a triangulation.
554
555
556	<a name="#_plt_keyword_MASKFILL"></a>
557	<h4>MASKFILL
558
559
560
561
562
563
564
565
566	</h4>
567
568
569
570
571	<a name="#_plt_keyword_DUPLICATE"></a>
572	<h4>DUPLICATE
573
574
575
576
577
578
579
580
581	</h4>
582
583
584
585
586	<a name="#_plt_keyword_STRICTFILL"></a>
587	<h4>STRICTFILL
588
589
590
591
592
593
594
595
596	</h4>
597
598
599	Activate this keyword to that the filling of contours be
600	precisely done between the min and the max specified letting values inferior at the
601	specified min and values superior at the specified max in white.
602
603
604	<a name="#_plt_keyword_OVERPLOT"></a>
605	<h4>OVERPLOT
606
607
608
609
610
611
612
613
614	</h4>
615
616
617	To make a plot over an other one.
618	Comment: Contrarily to the use of CONTOUR or VECTEUR, the use of this keyword
619	does not the caption and/or the color bar.
620
621
622	<a name="#_plt_keyword_DECIMATETRI"></a>
623	<h4>DECIMATETRI
624
625
626
627
628
629
630
631
632	</h4>
633
634
635
636
637	<a name="#_plt_keyword_LABMAP"></a>
638	<h4>LABMAP
639
640
641
642
643
644
645	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>labmap</i></font>
646
647	</h4>
648
649
650	Corresponds to label keywords of map_set.
651
652
653	<a name="#_plt_keyword__extra"></a>
654	<h4>_extra
655
656
657
658
659
660
661
662
663	</h4>
664
665
666	used to pass your keywords
667
668
669
670
671
672	<h3>Version history</h3>
673
674	<h4>Version</h4>
675	$Id: plt.pro 157 2006-08-21 09:01:50Z navarro $
676
677	<h4>History</h4>
678	Sebastien Masson (smasson@lodyc.jussieu.fr)
679	7/1999
680	Sebastien Masson 08/02/2000 checkfield and
681	notri keyword (or triangule = -1) .
682
683
684
685	<h3>Known issues</h3>
686
687
688	<h4>Todo items</h4> seb
689	Changer param "tab1",keyword "REMPLI", "UNLABSUR", "UNSUR2",
690	"UNVECTSUR"+ quelques trucs dans la routine.
691
692
693	<h3>Other attributes</h3>
694
695
696	<h4>Uses routines</h4>
697	common.pro
698
699
700
701
702
703	<font size="-3"><p> </p></font>
704	<hr size="1" color="#CCCCCC"/>
705
706
707
708
709	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0 on Tue Aug 29 14:50:09 2006.</font></p>
710
711	</body>
712	</html>

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

Download in other formats: