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

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation

File size: 11.0 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>plt1d.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="plt.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="pltbase.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>plt1d.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Trace 1d graphs: x,y,z (or t but in this case, we recall directly pltt)
65
66
67   
68
69     
70      <a name="#_plt1d"></a>
71
72      <h2>plt1d  <font size="-1" color="#006633">
73 Graphics
74</font></h2>
75
76      <p><font face="Courier">plt1d<i>, <a href="#_plt1d_keyword_tab">tab</a>, <a href="#_plt1d_keyword_param2">param2</a>[, <a href="#_plt1d_keyword_param3">param3</a>][, <a href="#_plt1d_keyword_param4">param4</a>]</i>, <a href="#_plt1d_keyword_BOXZOOM">BOXZOOM</a>=<i>BOXZOOM</i>, <a href="#_plt1d_keyword_SIN">SIN</a>=<i>SIN</i>, <a href="#_plt1d_keyword_MININ">MININ</a>=<i>MININ</i>, <a href="#_plt1d_keyword_MAXIN">MAXIN</a>=<i>MAXIN</i>, <a href="#_plt1d_keyword_TYPEIN">TYPEIN</a>=<i>TYPEIN</i>, <a href="#_plt1d_keyword_ENDPOINTS">ENDPOINTS</a>=<i>ENDPOINTS</i>, <a href="#_plt1d_keyword_COL1D">COL1D</a>=<i>COL1D</i>, <a href="#_plt1d_keyword_STY1D">STY1D</a>=<i>STY1D</i>, <a href="#_plt1d_keyword_OV1D">OV1D</a>=<i>OV1D</i>, <a href="#_plt1d_keyword_X">X</a>=<i>X</i>, <a href="#_plt1d_keyword_Y">Y</a>=<i>Y</i>, <a href="#_plt1d_keyword_Z">Z</a>=<i>Z</i>, <a href="#_plt1d_keyword_TT">TT</a>=<i>TT</i>, <a href="#_plt1d_keyword_REVERSE_X">REVERSE_X</a>=<i>REVERSE_X</i>, <a href="#_plt1d_keyword_REVERSE_Y">REVERSE_Y</a>=<i>REVERSE_Y</i>, <a href="#_plt1d_keyword_SWITCHXY">SWITCHXY</a>=<i>SWITCHXY</i>, <a href="#_plt1d_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="#_plt1d_keyword_tab"></a>
88    <h4>tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
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 hovmoeller map can be 2 kind of thing:
101 1) An array which can be:
102
103   * 2d, 3d or 4d:  array xy, xyz. xyt or xyzt. In this case, the array
104     will pass in <a href="../../..//ToBeReviewed/CALCULS/moyenne.html">moyenne</a> or <a href="../../..//ToBeReviewed/CALCULS/grossemoyenne.html">grossemoyenne</a> to be
105     averaged and become an array 1d.
106   * 1d:Nevertheless, the type must be specified in order to we know which
107     trace it is about. To have a correct caption, respecify the extraction
108     zone via BOXZOOM.
109 2) a structure respecting all criterions specified by <a href="../../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a>
110    The array contained in the structure respecting criterions of case 1)
111
112   
113
114    <a name="#_plt1d_keyword_param2"></a>
115    <h4>param2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
116      <font size="-1" color="#006633">in</font>
117     
118     
119      <font size="-1" color="#006633">required</font>
120     
121     
122     
123     
124    </h4>
125
126   
127 Min value we want to consider in the contour's drawing.
128 Note: could also be the type of plot:'x','y','z'
129
130   
131
132    <a name="#_plt1d_keyword_param3"></a>
133    <h4>param3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
134      <font size="-1" color="#006633">in</font>
135     
136      <font size="-1" color="#006633">optional</font>
137     
138     
139     
140      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>min/max of tab (on ocean points)</i></font>
141     
142    </h4>
143
144   
145 Max value we want to consider in the contour's drawing.
146 Note: if param2 is defined as 'x','y','z' then param3 is used to define the min (see param2)
147
148   
149
150    <a name="#_plt1d_keyword_param4"></a>
151    <h4>param4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
152      <font size="-1" color="#006633">in</font>
153     
154      <font size="-1" color="#006633">optional</font>
155     
156     
157     
158      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>max of tab (on ocean points)</i></font>
159     
160    </h4>
161
162   
163 Type of plot (can be only 'x','y','z' for plt1d).
164 Note: if param2 is defined as 'xy' then param4 is used to define the max (see param3)
165
166   
167   
168
169   
170    <h3>Keywords</h3>
171
172   
173    <a name="#_plt1d_keyword_BOXZOOM"></a>
174    <h4>BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
175     
176     
177     
178     
179     
180     
181     
182     
183    </h4>
184
185   
186 Vector indicating the geographic zone (3d) on which the extraction of the
187 field must be done to do the hovmoeller.
188
189 If BOXZOOM has :
190 1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
191 2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
192 4 elements: The extraction is made on [Boxzoom, vert1, vert2]
193 5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
194 6 elements: The extraction is made on Boxzoom
195
196 Where lon1, lon2,lat1,lat2,vert1,vert2 are global variables defined at
197 the last <a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> !
198
199   
200    <a name="#_plt1d_keyword_SIN"></a>
201    <h4>SIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
202     
203     
204     
205     
206     
207     
208     
209     
210    </h4>
211
212   
213 Activate this keyword if we want the x axis to be traced in sinus of the
214 latitude when we make a drawing f(y)
215
216   
217    <a name="#_plt1d_keyword_MININ"></a>
218    <h4>MININ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
219     
220     
221     
222     
223     
224     
225     
226     
227    </h4>
228
229   
230 Allows to specify the min value we want to consider in the drawing of contour
231 helping by the keyword instead of the argument min.
232 If the argument and the keyword are specified in the same time, it is the
233 value specified by the keyword which is retained.
234
235   
236    <a name="#_plt1d_keyword_MAXIN"></a>
237    <h4>MAXIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
238     
239     
240     
241     
242     
243     
244     
245     
246    </h4>
247
248   
249 Allows to specify the max value we want to consider in the drawing of contour
250 helping by the keyword instead of the argument max.
251 If the argument and the keyword are specified in the same time, it is the
252 value specified by the keyword which is retained.
253
254   
255    <a name="#_plt1d_keyword_TYPEIN"></a>
256    <h4>TYPEIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
257     
258     
259     
260     
261     
262     
263     
264     
265    </h4>
266
267   
268 allows to specify the type of hovmoeller we want to do
269             'xt','yt','zt','t'
270 with help of a keyword rather than the argument type. If the argument and the
271 keyword are specified in the same time, it is the value specified by the
272 keyword which is retained.
273
274   
275    <a name="#_plt1d_keyword_ENDPOINTS"></a>
276    <h4>ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
277     
278     
279     
280     
281     
282     
283     
284     
285    </h4>
286
287   
288 keyword specifying that we want to make a vertical cut in diagonal.
289 Then coordinated of extremities of these ones are defined by the 4 elements
290 of the vector ENDPOINTS: [x1,y1,x2,y2] which are coordinates.
291
292   
293    <a name="#_plt1d_keyword_COL1D"></a>
294    <h4>COL1D&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
295     
296     
297     
298     
299     
300     
301     
302     
303    </h4>
304
305   
306  --OBSOLETE--Color number when we make a trace 1d by default, 0.
307 It is better to use the keyword COLOR used by plot.
308
309   
310    <a name="#_plt1d_keyword_STY1D"></a>
311    <h4>STY1D&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
312     
313     
314     
315     
316     
317     
318     
319     
320    </h4>
321
322   
323 --OBSOLETE--
324 Number of the style used when we make a 1d drawing. We should better use the
325 keyword LINESTYLE which is tho one of the plot. Beware, this keyword is still
326 useful if we want to d bars instead of curves, put sty1d='bar'
327
328   
329    <a name="#_plt1d_keyword_OV1D"></a>
330    <h4>OV1D&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
331     
332     
333     
334     
335     
336     
337     
338     
339    </h4>
340
341   
342 Allow the double exposure of an 1d curve to a precedent 1d trace.
343
344   
345    <a name="#_plt1d_keyword_X"></a>
346    <h4>X&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
347     
348     
349     
350     
351     
352     
353     
354     
355    </h4>
356
357   
358   
359    <a name="#_plt1d_keyword_Y"></a>
360    <h4>Y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
361     
362     
363     
364     
365     
366     
367     
368     
369    </h4>
370
371   
372   
373    <a name="#_plt1d_keyword_Z"></a>
374    <h4>Z&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
375     
376     
377     
378     
379     
380     
381     
382     
383    </h4>
384
385   
386   
387    <a name="#_plt1d_keyword_TT"></a>
388    <h4>TT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
389     
390     
391     
392     
393     
394     
395     
396     
397    </h4>
398
399   
400   
401    <a name="#_plt1d_keyword_REVERSE_X"></a>
402    <h4>REVERSE_X&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
403     
404     
405     
406     
407     
408     
409     
410     
411    </h4>
412
413   
414 To invert the x axis (so as the drawing)
415
416   
417    <a name="#_plt1d_keyword_REVERSE_Y"></a>
418    <h4>REVERSE_Y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
419     
420     
421     
422     
423     
424     
425     
426     
427    </h4>
428
429   
430 To invert the y axis (so as the drawing)
431
432   
433    <a name="#_plt1d_keyword_SWITCHXY"></a>
434    <h4>SWITCHXY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
435     
436     
437     
438     
439     
440     
441     
442     
443    </h4>
444
445   
446   
447    <a name="#_plt1d_keyword__EXTRA"></a>
448    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
449     
450     
451     
452     
453     
454     
455     
456     
457    </h4>
458
459   
460 Used to pass keywords
461
462   
463   
464
465   
466    </pre><h3>Version history</h3>
467   
468    <h4>Version</h4>
469 $Id: plt1d.pro 378 2008-08-12 12:35:46Z pinsard $
470
471    <h4>History</h4>
472 creation 24/6/99 Eric Guilyardi
473 (a partir routine pltt de Sebastien Masson)
474 8/7/1999 Sebastien Masson (smasson@lodyc.jussieu.fr)
475 inspection des travaux finis
476 8/2/2000 Sebastien Masson: checkfield
477
478   
479
480   
481   
482   
483   
484   
485
486   
487   
488   
489   
490   
491   
492   
493
494    <font size="-3"><p>&nbsp;</p></font>
495    <hr size="1" color="#CCCCCC"/>
496     
497
498   
499
500    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
501
502  </body>
503</html>
Note: See TracBrowser for help on using the repository browser.