Context Navigation

pltz.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago
update documentation
File size: 18.0 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_NOMASK">NOMASK</a>=<i>NOMASK</i>, <a href="#_pltz_keyword_NO_PARTIALSTEP">NO_PARTIALSTEP</a>=<i>NO_PARTIALSTEP</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_WDEPTH">WDEPTH</a>=<i>WDEPTH</i>, <a href="#_pltz_keyword_REALSECTION">REALSECTION</a>=<i>REALSECTION</i>, <a href="#_pltz_keyword_MASKFILL">MASKFILL</a>=<i>MASKFILL</i>, <a href="#_pltz_keyword_MASKDTA">MASKDTA</a>=<i>MASKDTA</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	The array contained in the structure must be 2 or 3d (See case 1)
106
107
108
109	<a name="#_pltz_keyword_giventype"></a>
110	<h4>giventype
111
112
113
114
115
116
117
118
119	</h4>
120
121
122
123
124
125	<a name="#_pltz_keyword_givenmin"></a>
126	<h4>givenmin
127
128
129
130	<font size="-1" color="#006633">required</font>
131
132
133
134
135	</h4>
136
137
138	valeur minimum que l'on veut prendre en compte dans le trace
139	des contours. Par defaut on prend le min de tab1 (sur les pts mer)
140
141
142
143	<a name="#_pltz_keyword_givenmax"></a>
144	<h4>givenmax
145
146
147
148	<font size="-1" color="#006633">required</font>
149
150
151
152
153	</h4>
154
155
156	valeur maximum que l'on veut prendre en compte dans le trace
157	des contours. Par defaut on prend le max de tab1 (sur les pts mer)
158
159
160
161
162
163	<h3>Keywords</h3>
164
165
166	<a name="#_pltz_keyword_BOXZOOM"></a>
167	<h4>BOXZOOM
168
169
170
171
172
173
174
175
176	</h4>
177
178
179	Vector indicating the geographic zone on which we want to cut the map.
180	If BOXZOOM has :
181	1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
182	2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
183	4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
184	5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
185	6 elements: The extraction is made on Boxzoom
186
187	Where lon1, lon2,lat1,lat2 are global variables defined at the last
188	<a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> !
189
190
191	<a name="#_pltz_keyword_CONTOUR"></a>
192	<h4>CONTOUR
193
194
195
196
197
198
199
200
201	</h4>
202
203
204	If we want to trace contours of a different field than the one
205	whose we have the colored drawing (by example E-P in color and QSR in contours).
206	It must be a field respecting same characteristics than the argument number one of plt.
207
208
209	<a name="#_pltz_keyword_ENDPOINTS"></a>
210	<h4>ENDPOINTS
211
212
213
214
215
216
217
218
219	</h4>
220
221
222	keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities
223	of these ones are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are
224	coordinates.
225
226
227	<a name="#_pltz_keyword_INTERVALLE"></a>
228	<h4>INTERVALLE
229
230
231
232
233
234
235
236
237	</h4>
238
239
240	Value of an interval between two isolines. If there is none specified min,
241	we choose a min contour which goes well with the specified interval!. If this keyword is not
242	specified, we trace 20 isoline from the min to the max. Comment: When CONTOUR is activated,
243	INTERVALLE only specify the interval between 2 colored isolines. To specify the interval
244	between 2 isolines traced by a trait, use CONTINTERVALLE.
245
246
247	<a name="#_pltz_keyword_INV"></a>
248	<h4>INV
249
250
251
252
253
254
255
256
257	</h4>
258
259
260	Invert the color vector used to color the graph
261	(without use the black, the white and the used palette)
262
263
264	<a name="#_pltz_keyword_ZRATIO"></a>
265	<h4>ZRATIO
266
267
268
269
270
271
272	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>2./3</i></font>
273
274	</h4>
275
276
277	When the drawing has a zoomed part, it is the size ratio between the zoomed
278	part, hz (zoom height), and the whole drawing, ht (total height).
279
280
281	<a name="#_pltz_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="#_pltz_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	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
310
311	</h4>
312
313
314	It choose the label's type corresponding to cases in <a href="../../..//ToBeReviewed/PLOTS/LABEL/label.html">label</a>
315	Comment: When CONTOUR is activated, it only specify the label's type for colored isolines.
316	For these ones traced by a trait, use CONTLABEL.
317
318
319	<a name="#_pltz_keyword_CONTLABEL"></a>
320	<h4>CONTLABEL
321
322
323
324
325
326	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
327
328
329	</h4>
330
331
332	When CONTOUR is activated, if n
333	is different of 0, choose the label type corresponding to n cases for
334	the traced by a traitisolines. To specify the type of label of the
335	colored contour, use LABEL
336
337
338	<a name="#_pltz_keyword_STYLE"></a>
339	<h4>STYLE
340
341
342
343
344
345
346	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>style</i></font>
347
348	</h4>
349
350
351	Contour's style to adopt to draw isolines. See <a href="../../..//ToBeReviewed/PLOTS/style.html">style</a> for more informations
352
353
354	<a name="#_pltz_keyword_CONTMAX"></a>
355	<h4>CONTMAX
356
357
358
359
360
361
362	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>max of the keyword CONTOUR (on ocean points)</i></font>
363
364	</h4>
365
366
367	When CONTOUR is activated, max value we want to consider in the isoline
368	traced by a trait's line.
369
370
371	<a name="#_pltz_keyword_SIN"></a>
372	<h4>SIN
373
374
375
376
377
378
379
380
381	</h4>
382
383
384	Activate this keyword if we want the x axis to be traced in sinus of the
385	latitude when we make a drawing f(y)
386
387
388	<a name="#_pltz_keyword_TYPEIN"></a>
389	<h4>TYPEIN
390
391
392
393
394
395
396
397
398	</h4>
399
400
401
402	<a name="#_pltz_keyword_CONTMIN"></a>
403	<h4>CONTMIN
404
405
406
407
408
409
410	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>min of the keyword CONTOUR (on ocean points)</i></font>
411
412	</h4>
413
414
415	When CONTOUR is activated, min value we want to consider in the isoline
416	traced by a trait's line.
417
418
419	<a name="#_pltz_keyword_NLEVEL"></a>
420	<h4>NLEVEL
421
422
423
424
425
426
427	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>20</i></font>
428
429	</h4>
430
431
432	Number of contours to draw. active if
433	LABEL=0 or is not specified.
434
435
436	<a name="#_pltz_keyword_CONTNLEVEL"></a>
437	<h4>CONTNLEVEL
438
439
440
441
442
443
444	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>20</i></font>
445
446	</h4>
447
448
449	When CONTOUR is activated, it is the number of contours
450	traced by a trait for drawing (active if
451	CONTLABEL=0).
452
453
454	<a name="#_pltz_keyword_NOFILL"></a>
455	<h4>NOFILL
456
457
458
459
460
461
462
463
464	</h4>
465
466
467	To make just isolines with no filling
468
469
470	<a name="#_pltz_keyword_NOMASK"></a>
471	<h4>NOMASK
472
473
474
475
476
477
478
479
480	</h4>
481
482
483	activate to supress the use of the land-sea mask when plotting the field
484
485
486	<a name="#_pltz_keyword_NO_PARTIALSTEP"></a>
487	<h4>NO_PARTIALSTEP
488
489
490
491
492
493
494
495
496	</h4>
497
498
499	activate to supress the use of partial steps (force key_partialstep = 0 within pltz)
500
501
502	<a name="#_pltz_keyword_NOTRI"></a>
503	<h4>NOTRI
504
505
506
507
508
509
510
511
512	</h4>
513
514
515	To force not to use the triangulation. Beware, in this case, the
516	drawing only works if the grid is undeformed (It means that each point of a longitude
517	give one latitude and each point of a latitude give one longitude) except if we use
518	the keyword CELL_FILL=2.
519	Comment: if the field contain points !values.f_nan, then we even do a triangulation.
520
521
522	<a name="#_pltz_keyword_USETRI"></a>
523	<h4>USETRI
524
525
526
527
528
529
530
531
532	</h4>
533
534
535
536	<a name="#_pltz_keyword_FILLXDIR"></a>
537	<h4>FILLXDIR
538
539
540
541
542
543
544
545
546	</h4>
547
548
549
550	<a name="#_pltz_keyword_ZOOM"></a>
551	<h4>ZOOM
552
553
554
555
556
557
558	<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>
559
560	</h4>
561
562
563	Depth where i can make our maximum zoom.
564
565
566	<a name="#_pltz_keyword_XZ"></a>
567	<h4>XZ
568
569
570
571
572
573
574
575
576	</h4>
577
578
579	Force to make a cut following xz
580
581
582	<a name="#_pltz_keyword_YZ"></a>
583	<h4>YZ
584
585
586
587
588
589
590
591
592	</h4>
593
594
595	Force to make a cut following yz
596
597
598	<a name="#_pltz_keyword_MININ"></a>
599	<h4>MININ
600
601
602
603
604
605
606
607
608	</h4>
609
610
611	to specify the min value we want to plot with a keyword instead of with the
612	input parameter min. If min is defined by both, parameter and keyword, the
613	keyword is retained.
614
615
616	<a name="#_pltz_keyword_MAXIN"></a>
617	<h4>MAXIN
618
619
620
621
622
623
624
625
626	</h4>
627
628
629	to specify the max value we want to plot with a keyword instead of with the
630	input parameter max. If max is defined by both, parameter and keyword, the
631	keyword is retained.
632
633
634	<a name="#_pltz_keyword_STRICTFILL"></a>
635	<h4>STRICTFILL
636
637
638
639
640
641
642
643
644	</h4>
645
646
647	Activate this keyword to that the filling of contours be
648	precisely done between the min and the max specified. Values inferior/superior at the
649	specified min/max are not filled. Note that max values a considered
650	as missing values so cells containing one or more corners with
651	values above max will have no contours drawn through them.
652
653
654	<a name="#_pltz_keyword_OVERPLOT"></a>
655	<h4>OVERPLOT
656
657
658
659
660
661
662
663
664	</h4>
665
666
667	To make a plot over an other one.
668	Comment: Contrarily to the use of CONTOUR or VECTEUR, the use of this keyword
669	does not the caption and/or the color bar.
670
671
672	<a name="#_pltz_keyword_WDEPTH"></a>
673	<h4>WDEPTH
674
675
676
677
678
679
680
681
682	</h4>
683
684
685	To specify that the field is at W depth instead of T
686	depth (automatically activated if vargrid eq 'W')
687
688
689	<a name="#_pltz_keyword_REALSECTION"></a>
690	<h4>REALSECTION
691
692
693
694
695
696
697
698
699	</h4>
700
701
702
703	<a name="#_pltz_keyword_MASKFILL"></a>
704	<h4>MASKFILL
705
706
707
708
709
710
711
712
713	</h4>
714
715
716	set to 0 to avoid to fill the masked values
717
718
719	<a name="#_pltz_keyword_MASKDTA"></a>
720	<h4>MASKDTA
721
722
723
724
725
726
727
728
729	</h4>
730
731
732	2d array defining the mask that must be applied to the data instead
733	of the default mask which is defined according to the grid (t/u/v/f mask)
734
735
736	<a name="#_pltz_keyword__EXTRA"></a>
737	<h4>_EXTRA
738
739
740
741
742
743
744
745
746	</h4>
747
748
749
750
751
752
753	</pre><h3>Version history</h3>
754
755	<h4>Version</h4>
756	$Id: pltz.pro 388 2008-12-09 09:36:41Z smasson $
757
758	<h4>History</h4>
759	Sebastien Masson (smasson@lodyc.jussieu.fr)
760	7/1999
761	Sebastien Masson 08/02/2000 checkfield and
762	notri keyword.
763
764
765
766	<h3>Known issues</h3>
767
768
769	<h4>Todo items</h4>
770	seb definition of paramaters L.215 à 221
771
772
773
774	<h3>Other attributes</h3>
775
776
777	<h4>Uses routines</h4>
778	<a href="../../..//Obsolete/common.html">common</a>
779
780
781
782
783
784	<font size="-3"><p> </p></font>
785	<hr size="1" color="#CCCCCC"/>
786
787
788
789
790	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0.</font></p>
791
792	</body>
793	</html>

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

Context Navigation

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

Download in other formats: