Context Navigation

source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/PLOTS/DESSINE/pltz.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago
update documentation
File size: 16.9 KB

Line
1
2
3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4	<head>
5	<title>pltz.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="pltv.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="sbar_plot.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>pltz.pro</h2>
59
60	<dl>
61	</dl>
62
63
64	Trace vertical graphs.
65
66
67
68
69
70	<a name="#_pltz"></a>
71
72	<h2>pltz <font size="-1" color="#006633">
73	Graphics
74	</font></h2>
75
76	<p><font face="Courier">pltz<i>, <a href="#_pltz_keyword_tab">tab</a>, <a href="#_pltz_keyword_giventype">giventype</a>, <a href="#_pltz_keyword_givenmin">givenmin</a>, <a href="#_pltz_keyword_givenmax">givenmax</a></i>, <a href="#_pltz_keyword_BOXZOOM">BOXZOOM</a>=<i>BOXZOOM</i>, <a href="#_pltz_keyword_CONTOUR">CONTOUR</a>=<i>CONTOUR</i>, <a href="#_pltz_keyword_ENDPOINTS">ENDPOINTS</a>=<i>ENDPOINTS</i>, <a href="#_pltz_keyword_INTERVALLE">INTERVALLE</a>=<i>INTERVALLE</i>, <a href="#_pltz_keyword_INV">INV</a>=<i>INV</i>, <a href="#_pltz_keyword_ZRATIO">ZRATIO</a>=<i>ZRATIO</i>, <a href="#_pltz_keyword_CONTINTERVALLE">CONTINTERVALLE</a>=<i>CONTINTERVALLE</i>, <a href="#_pltz_keyword_LABEL">LABEL</a>=<i>integer</i>, <a href="#_pltz_keyword_CONTLABEL">CONTLABEL</a>=<i>integer</i>, <a href="#_pltz_keyword_STYLE">STYLE</a>=<i>STYLE</i>, <a href="#_pltz_keyword_CONTMAX">CONTMAX</a>=<i>CONTMAX</i>, <a href="#_pltz_keyword_SIN">SIN</a>=<i>SIN</i>, <a href="#_pltz_keyword_TYPEIN">TYPEIN</a>=<i>TYPEIN</i>, <a href="#_pltz_keyword_CONTMIN">CONTMIN</a>=<i>CONTMIN</i>, <a href="#_pltz_keyword_NLEVEL">NLEVEL</a>=<i>NLEVEL</i>, <a href="#_pltz_keyword_CONTNLEVEL">CONTNLEVEL</a>=<i>CONTNLEVEL</i>, <a href="#_pltz_keyword_NOFILL">NOFILL</a>=<i>NOFILL</i>, <a href="#_pltz_keyword_NOTRI">NOTRI</a>=<i>NOTRI</i>, <a href="#_pltz_keyword_USETRI">USETRI</a>=<i>USETRI</i>, <a href="#_pltz_keyword_FILLXDIR">FILLXDIR</a>=<i>FILLXDIR</i>, <a href="#_pltz_keyword_ZOOM">ZOOM</a>=<i>ZOOM</i>, <a href="#_pltz_keyword_XZ">XZ</a>=<i>XZ</i>, <a href="#_pltz_keyword_YZ">YZ</a>=<i>YZ</i>, <a href="#_pltz_keyword_MININ">MININ</a>=<i>MININ</i>, <a href="#_pltz_keyword_MAXIN">MAXIN</a>=<i>MAXIN</i>, <a href="#_pltz_keyword_STRICTFILL">STRICTFILL</a>=<i>STRICTFILL</i>, <a href="#_pltz_keyword_OVERPLOT">OVERPLOT</a>=<i>OVERPLOT</i>, <a href="#_pltz_keyword_MASKFILL">MASKFILL</a>=<i>MASKFILL</i>, <a href="#_pltz_keyword_WDEPTH">WDEPTH</a>=<i>WDEPTH</i>, <a href="#_pltz_keyword_REALSECTION">REALSECTION</a>=<i>REALSECTION</i>, <a href="#_pltz_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="#_pltz_keyword_tab"></a>
88	<h4>tab
89
90
91
92
93
94
95
96
97	</h4>
98
99
100	The field whose we want to make a vertical cut can be 2 kind of thing:
101	1) An 2d or 3d array.
102	If the field is 2d, indicate, with the keyword BOXZOOM, geographic delineations of the boxzoom.
103	If the field is 3d, we extract the section on we average possibly before to do the plot.
104	2) a structure respecting all criterions specified by <a href="../../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a>.
105	See IDL> xhelp,'litchamp'. The array contained in the structure must be 2 or 3d (See case 1)
106
107
108
109
110	<a name="#_pltz_keyword_giventype"></a>
111	<h4>giventype
112
113
114
115
116
117
118
119
120	</h4>
121
122
123
124
125
126	<a name="#_pltz_keyword_givenmin"></a>
127	<h4>givenmin
128
129
130
131	<font size="-1" color="#006633">required</font>
132
133
134
135
136	</h4>
137
138
139	valeur minimum que l'on veut prendre en compte dans le trace
140	des contours. Par defaut on prend le min de tab1 (sur les pts mer)
141
142
143
144	<a name="#_pltz_keyword_givenmax"></a>
145	<h4>givenmax
146
147
148
149	<font size="-1" color="#006633">required</font>
150
151
152
153
154	</h4>
155
156
157	valeur maximum que l'on veut prendre en compte dans le trace
158	des contours. Par defaut on prend le max de tab1 (sur les pts mer)
159
160
161
162
163
164	<h3>Keywords</h3>
165
166
167	<a name="#_pltz_keyword_BOXZOOM"></a>
168	<h4>BOXZOOM
169
170
171
172
173
174
175
176
177	</h4>
178
179
180	Vector indicating the geographic zone on which we want to cut the map.
181	If BOXZOOM has :
182	1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
183	2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
184	4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
185	5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
186	6 elements: The extraction is made on Boxzoom
187
188	Where lon1, lon2,lat1,lat2 are global variables defined at the last
189	<a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> !
190
191
192	<a name="#_pltz_keyword_CONTOUR"></a>
193	<h4>CONTOUR
194
195
196
197
198
199
200
201
202	</h4>
203
204
205	If we want to trace contours of a different field than the one
206	whose we have the colored drawing (by example E-P in color and QSR in contours).
207	It must be a field respecting same characteristics than the argument number one of plt.
208
209
210	<a name="#_pltz_keyword_ENDPOINTS"></a>
211	<h4>ENDPOINTS
212
213
214
215
216
217
218
219
220	</h4>
221
222
223	keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities
224	of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are
225	coordinates.
226
227
228	<a name="#_pltz_keyword_INTERVALLE"></a>
229	<h4>INTERVALLE
230
231
232
233
234
235
236
237
238	</h4>
239
240
241	Value of an interval between two isolines. If there is none specified min,
242	we choose a min contour which goes well with the specified interval!. If this keyword is not
243	specified, we trace 20 isoline from the min to the max. Comment: When CONTOUR is activated,
244	INTERVALLE only specify the interval between 2 colored isolines. To specify the interval
245	between 2 isolines traced by a trait, use CONTINTERVALLE.
246
247
248	<a name="#_pltz_keyword_INV"></a>
249	<h4>INV
250
251
252
253
254
255
256
257
258	</h4>
259
260
261	Invert the color vector used to color the graph
262	(without use the black, the white and the used palette)
263
264
265	<a name="#_pltz_keyword_ZRATIO"></a>
266	<h4>ZRATIO
267
268
269
270
271
272
273	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>2./3</i></font>
274
275	</h4>
276
277
278	When the drawing has a zoomed part, it is the size rapport between the zoomed part,
279	hz (zoom height), and the whole drawing, ht (total height).
280
281
282	<a name="#_pltz_keyword_CONTINTERVALLE"></a>
283	<h4>CONTINTERVALLE
284
285
286
287
288
289
290
291
292	</h4>
293
294
295	When CONTOUR is activated, it is the value between 2 isolines
296	traced by a trait. So it can be different from the one specified by INTERVALLE which,
297	in this case, does not control colored isolines in color anymore. If there is noone
298	specified min, we choose a contour min which goes well with the specified interval!
299	If this keyword is not specified, we trace 20 isolines from the min to the max.
300
301
302	<a name="#_pltz_keyword_LABEL"></a>
303	<h4>LABEL
304
305
306
307
308
309	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
310	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
311
312	</h4>
313
314
315	It choose the label's type corresponding to cases in <a href="../../..//ToBeReviewed/PLOTS/LABEL/label.html">label</a>
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="#_pltz_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	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="#_pltz_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. See <a href="../../..//ToBeReviewed/PLOTS/style.html">style</a> for more informations
353
354
355	<a name="#_pltz_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>max of 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="#_pltz_keyword_SIN"></a>
373	<h4>SIN
374
375
376
377
378
379
380
381
382	</h4>
383
384
385	Activate this keyword if we want the x axis to be traced in sinus of the
386	latitude when we make a drawing f(y)
387
388
389	<a name="#_pltz_keyword_TYPEIN"></a>
390	<h4>TYPEIN
391
392
393
394
395
396
397
398
399	</h4>
400
401
402
403	<a name="#_pltz_keyword_CONTMIN"></a>
404	<h4>CONTMIN
405
406
407
408
409
410
411	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>min of the keyword CONTOUR (on ocean points)</i></font>
412
413	</h4>
414
415
416	When CONTOUR is activated, min value we want to consider in the isoline
417	traced by a trait's line.
418
419
420	<a name="#_pltz_keyword_NLEVEL"></a>
421	<h4>NLEVEL
422
423
424
425
426
427
428	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>20</i></font>
429
430	</h4>
431
432
433	Number of contours to draw. active if
434	LABEL=0 or is not specified.
435
436
437	<a name="#_pltz_keyword_CONTNLEVEL"></a>
438	<h4>CONTNLEVEL
439
440
441
442
443
444
445	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>20</i></font>
446
447	</h4>
448
449
450	When CONTOUR is activated, it is the number of contours
451	traced by a trait for drawing (active if
452	CONTLABEL=0).
453
454
455	<a name="#_pltz_keyword_NOFILL"></a>
456	<h4>NOFILL
457
458
459
460
461
462
463
464
465	</h4>
466
467
468	To make just isolines with no filling
469
470
471	<a name="#_pltz_keyword_NOTRI"></a>
472	<h4>NOTRI
473
474
475
476
477
478
479
480
481	</h4>
482
483
484	To force not to use the triangulation. Beware, in this case, the
485	drawing only works if the grid is undeformed (It means that each point of a longitude
486	give one latitude and each point of a latitude give one longitude) except if we use
487	the keyword CELL_FILL=2.
488	Comment: if the field contain points !values.f_nan, then we even do a triangulation.
489
490
491	<a name="#_pltz_keyword_USETRI"></a>
492	<h4>USETRI
493
494
495
496
497
498
499
500
501	</h4>
502
503
504
505	<a name="#_pltz_keyword_FILLXDIR"></a>
506	<h4>FILLXDIR
507
508
509
510
511
512
513
514
515	</h4>
516
517
518
519	<a name="#_pltz_keyword_ZOOM"></a>
520	<h4>ZOOM
521
522
523
524
525
526
527	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>200m or max depth if it is inferior at 200m</i></font>
528
529	</h4>
530
531
532	Depth where i can make our maximum zoom.
533
534
535	<a name="#_pltz_keyword_XZ"></a>
536	<h4>XZ
537
538
539
540
541
542
543
544
545	</h4>
546
547
548	Force to make a cut following xz
549
550
551	<a name="#_pltz_keyword_YZ"></a>
552	<h4>YZ
553
554
555
556
557
558
559
560
561	</h4>
562
563
564	Force to make a cut following yz
565
566
567	<a name="#_pltz_keyword_MININ"></a>
568	<h4>MININ
569
570
571
572
573
574
575
576
577	</h4>
578
579
580	to specify the min value we want to plot with a keyword instead of with the
581	input parameter min. If min is defined by both, parameter and keyword, the
582	keyword is retained.
583
584
585	<a name="#_pltz_keyword_MAXIN"></a>
586	<h4>MAXIN
587
588
589
590
591
592
593
594
595	</h4>
596
597
598	to specify the max value we want to plot with a keyword instead of with the
599	input parameter max. If max is defined by both, parameter and keyword, the
600	keyword is retained.
601
602
603	<a name="#_pltz_keyword_STRICTFILL"></a>
604	<h4>STRICTFILL
605
606
607
608
609
610
611
612
613	</h4>
614
615
616	Activate this keyword to that the filling of contours be
617	precisely done between the min and the max specified. Values inferior/superior at the
618	specified min/max are not filled. Note that max values a considered
619	as missing values so cells containing one or more corners with
620	values above max will have no contours drawn through them.
621
622
623	<a name="#_pltz_keyword_OVERPLOT"></a>
624	<h4>OVERPLOT
625
626
627
628
629
630
631
632
633	</h4>
634
635
636	To make a plot over an other one.
637	Comment: Contrarily to the use of CONTOUR or VECTEUR, the use of this keyword
638	does not the caption and/or the color bar.
639
640
641	<a name="#_pltz_keyword_MASKFILL"></a>
642	<h4>MASKFILL
643
644
645
646
647
648
649
650
651	</h4>
652
653
654
655	<a name="#_pltz_keyword_WDEPTH"></a>
656	<h4>WDEPTH
657
658
659
660
661
662
663
664
665	</h4>
666
667
668	To specify that the field is at W depth instead of T
669	depth (automatically activated if vargrid eq 'W')
670
671
672	<a name="#_pltz_keyword_REALSECTION"></a>
673	<h4>REALSECTION
674
675
676
677
678
679
680
681
682	</h4>
683
684
685
686	<a name="#_pltz_keyword__EXTRA"></a>
687	<h4>_EXTRA
688
689
690
691
692
693
694
695
696	</h4>
697
698
699
700
701
702
703	</pre><h3>Version history</h3>
704
705	<h4>Version</h4>
706	$Id: pltz.pro 328 2007-12-13 19:27:11Z smasson $
707
708	<h4>History</h4>
709	Sebastien Masson (smasson@lodyc.jussieu.fr)
710	7/1999
711	Sebastien Masson 08/02/2000 checkfield and
712	notri keyword.
713
714
715
716	<h3>Known issues</h3>
717
718
719	<h4>Todo items</h4>
720	seb definition of paramaters L.215 à 221
721
722
723
724	<h3>Other attributes</h3>
725
726
727	<h4>Uses routines</h4>
728	common.pro
729
730
731
732
733
734	<font size="-3"><p> </p></font>
735	<hr size="1" color="#CCCCCC"/>
736
737
738
739
740	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0.</font></p>
741
742	</body>
743	</html>

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

Download in other formats: