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

Last change on this file since 242 was 242, checked in by pinsard, 17 years ago

improvements/corrections of some *.pro headers + replace some message by some report

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