Context Navigation

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

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

Download in other formats: