Context Navigation

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

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

Download in other formats: