source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DESSINE/plt1d.html @ 89

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago

add idldoc html output. see Documentation/idldoc_html_output/index.html

File size: 12.8 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>plt1d.pro (IDLdoc API 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="plt1d.pro (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="plt.html">&lt;&lt;prev file</a> | <a href="pltbase.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="plt1d.html" target="_TOP">view single page</a> | <a href="./../../../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;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?format=raw">ToBeReviewed/PLOTS/DESSINE/</a></h1>
82      <h2 class="pro_file">plt1d.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_plt1d">
103
104          <h2><a class="top" href="#container">top</a>plt1d </h2>
105       
106          <p class="header">
107            plt1d<span class="result">, <a href="#_plt1d_param_tab">tab</a>, <a href="#_plt1d_param_giventype">giventype</a>, <a href="#_plt1d_param_givenmin">givenmin</a>, <a href="#_plt1d_param_givenmax">givenmax</a></span>, <a href="#_plt1d_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_plt1d_keyword_SIN">SIN</a>=<span class="result">SIN</span>, <a href="#_plt1d_keyword_MININ">MININ</a>=<span class="result">MININ</span>, <a href="#_plt1d_keyword_MAXIN">MAXIN</a>=<span class="result">MAXIN</span>, <a href="#_plt1d_keyword_TYPEIN">TYPEIN</a>=<span class="result">TYPEIN</span>, <a href="#_plt1d_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_plt1d_keyword_COL1D">COL1D</a>=<span class="result">COL1D</span>, <a href="#_plt1d_keyword_STY1D">STY1D</a>=<span class="result">STY1D</span>, <a href="#_plt1d_keyword_OV1D">OV1D</a>=<span class="result">OV1D</span>, <a href="#_plt1d_keyword_X">X</a>=<span class="result">X</span>, <a href="#_plt1d_keyword_Y">Y</a>=<span class="result">Y</span>, <a href="#_plt1d_keyword_Z">Z</a>=<span class="result">Z</span>, <a href="#_plt1d_keyword_TT">TT</a>=<span class="result">TT</span>, <a href="#_plt1d_keyword_REVERSE_X">REVERSE_X</a>=<span class="result">REVERSE_X</span>, <a href="#_plt1d_keyword_REVERSE_Y">REVERSE_Y</a>=<span class="result">REVERSE_Y</span>, <a href="#_plt1d_keyword_SWITCHXY">SWITCHXY</a>=<span class="result">SWITCHXY</span>, <a href="#_plt1d_keyword__extra">_extra</a>=<span class="result">_extra</span></p>
108       
109          <div class="comments">
110 NAME:
111        PLT1D
112
113 PURPOSE:
114        trace des graphes 1d
115
116 CATEGORY:
117       Graphics, trace des graphes 1d: x,y,z (ou t mais ds ce cas, on
118       rapelle directement pltt)
119
120 CALLING SEQUENCE:
121        plt1d, champ,type [,min[, max]]
122
123 INPUTS:
124        champ: le champ dont on veut faire le hovmoller champ
125        peut etre de 2 types:
126        1) un tableu qui peut etre:
127          * 2d, 3d ou 4d:  tableau xy, xyz. xyt ou xyzt. dans ce cas,
128            le tableau va passer dans moyenne ou grossemoyenne pour
129            etre moyennee et devenir un tableau 1 1d.
130          * 1d:type doit qd meme etre specifie pour qu''on sache de
131          quel trace il sagit. Pour avoir une legende correcte,
132          respecifier la zone d''extraction via BOXZOOM
133       2) une structure repondant aux critaires specifies par
134       litchamp.pro. cf. IDL> xhelp,'litchamp'. Le tableau contennu ds
135       la structure repondant aux criteres du cas 1) cf. ci-dessus
136
137       TYPE: un string: type de plot 1d que l''on veut faire:
138       trace suivant: 'x','y','z' 
139
140 ces arguments ne sont pas obligatoires:
141 
142        MAX: valeur maximum que l'on veut prendre en compte dans le trace
143 du plot. Par defaut on prend le max de tableau (sur les pts mer)
144
145        MIN: valeur minimum que l'on veut prendre en compte dans le trace
146 du plot. Par defaut on prend le min de tableau (sur les pts mer)
147
148 KEYWORD PARAMETERS:
149
150        BOXZOOM:vecteur indiquant la zone geographique (3d) sur laquelle doit
151 etre fait l''extraction du champ pour faire le hovmoeller.
152 Si BOXZOOM a :
153 1 element : l''extraction est faite sur [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
154 2 elements: l''extraction est faite sur [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
155 4 elements: l''extraction est faite sur [Boxzoom, vert1, vert2]
156 5 elements: l''extraction est faite sur [Boxzoom[0:3], 0, Boxzoom[4]]
157 6 elements: l''extraction est faite sur Boxzoom
158
159 Ou lon1, lon2,lat1,lat2,vert1,vert2 sont les variables globales
160 definies lors du dernier domdef!
161
162       COL1d: --OBSOLETE--numero de la couleur qd on fait un trace 1d
163       par defaut, 0. il faut mieux utiliser le mot cle COLOR utilise
164       par plot
165
166       ENDPOINTS: mot clef specifiant que l'on veut faire une coupe
167       verticale en diagonale. les coordonnees des extremites de
168       celle-ci sont alors definies les 4 elements du vecteur
169       ENDPOINTS: [x1,y1,x2,y2] qui sont les coordonnees
170
171        /LANDSCAPE: oblige la feuille ou le fenetre a l''ecran a etre
172        en position "allongee".
173       
174       MAXIN: permet de specifier la valeur maximum que l''on veut
175       prendre en compte dans le trace des contours a l''aide d''un
176       mot cle plutot que par l''argument max. Si l''argument et le
177       mot cle sont specifies en meme temps, c''est la valeur
178       specifiee par le mot cle qui est retenue.
179
180       MININ: permet de specifier la valeur minimum que l''on veut
181       prendre en compte dans le trace des contours a l''aide d''un
182       mot cle plutot que par l''argument min. Si l''argument et le
183       mot cle sont specifies en meme temps, c''est la valeur
184       specifiee par le mot cle qui est retenue.
185
186       /NOERASE: activer pour faire un dessin a l''ecran sans creer
187 une nouvelle fenetre. Rq: activer ds le cas d''un Postscript de
188 plusieurs traces de type 't' pour ne pas faire un Postscript de
189 plusieurs pages
190
191       /OV1D:permet de surimprimer un courbe 1d a un precedent trace 1d.
192
193        PETITDESSIN: vecteur de 3 ou 4 elements, applique pour faire un
194 dessin sur une petite portion de feuille ou d''ecran. il delimite
195 la zone ds laquelle va etre fait le dessin
196 si il a 4 elements:
197       il est alors constitute des coordonnees -exprime en cm reperes par
198       rapport au coin en bas a gauche de la feuille ou de la fenetre
199       (en portrait comme en landscape)- du coin en bas a
200       gauche et du coin en haut a droite  de la zone de dessin.
201 si il a 3 elements:
202       Ds ce cas, on divise la fenetre ou l''ecran en PETITDESSIN[0]
203       colonnes, en PETITDESSIN[1] lignes le dessin se faisant ds la
204       case numero PETITDESSIN[2].La numerotation commencant en haut
205       a gauche par le numero 1 et suivant apres dans le sens de
206       l''ecriture.
207 Par defaut on fait un dessin occupant la plus grande place possible
208 tout en concervant le rapport d''aspect (sauf qd REMPLI est active)
209
210        /PORTRAIT: oblige la feuille ou la fenetre a etre en position "debout".
211
212        /POST: faire une sortie postscript. Ne marche que si on fait
213        un seul dessin sur la feuille. Si on fait plusieurs dessins,</div>
214
215         
216
217         
218            <h3>Parameters</h3>
219       
220           
221            <h4 id="_plt1d_param_tab">tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
222             
223             
224             
225             
226             
227             
228             
229             
230            </h4>
231       
232          <div class="comments"></div>
233           
234            <h4 id="_plt1d_param_giventype">giventype&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
235             
236             
237             
238             
239             
240             
241             
242             
243            </h4>
244       
245          <div class="comments"></div>
246           
247            <h4 id="_plt1d_param_givenmin">givenmin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
248             
249             
250             
251             
252             
253             
254             
255             
256            </h4>
257       
258          <div class="comments"></div>
259           
260            <h4 id="_plt1d_param_givenmax">givenmax&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
261             
262             
263             
264             
265             
266             
267             
268             
269            </h4>
270       
271          <div class="comments"></div>
272           
273
274         
275
276         
277
278            <h3>Keywords</h3>
279           
280            <h4 id="_plt1d_keyword_BOXZOOM">BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
281             
282             
283             
284             
285             
286             
287             
288             
289            </h4>
290       
291            <div class="comments"></div>
292           
293            <h4 id="_plt1d_keyword_SIN">SIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
294             
295             
296             
297             
298             
299             
300             
301             
302            </h4>
303       
304            <div class="comments"></div>
305           
306            <h4 id="_plt1d_keyword_MININ">MININ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
307             
308             
309             
310             
311             
312             
313             
314             
315            </h4>
316       
317            <div class="comments"></div>
318           
319            <h4 id="_plt1d_keyword_MAXIN">MAXIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
320             
321             
322             
323             
324             
325             
326             
327             
328            </h4>
329       
330            <div class="comments"></div>
331           
332            <h4 id="_plt1d_keyword_TYPEIN">TYPEIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
333             
334             
335             
336             
337             
338             
339             
340             
341            </h4>
342       
343            <div class="comments"></div>
344           
345            <h4 id="_plt1d_keyword_ENDPOINTS">ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
346             
347             
348             
349             
350             
351             
352             
353             
354            </h4>
355       
356            <div class="comments"></div>
357           
358            <h4 id="_plt1d_keyword_COL1D">COL1D&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
359             
360             
361             
362             
363             
364             
365             
366             
367            </h4>
368       
369            <div class="comments"></div>
370           
371            <h4 id="_plt1d_keyword_STY1D">STY1D&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
372             
373             
374             
375             
376             
377             
378             
379             
380            </h4>
381       
382            <div class="comments"></div>
383           
384            <h4 id="_plt1d_keyword_OV1D">OV1D&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
385             
386             
387             
388             
389             
390             
391             
392             
393            </h4>
394       
395            <div class="comments"></div>
396           
397            <h4 id="_plt1d_keyword_X">X&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
398             
399             
400             
401             
402             
403             
404             
405             
406            </h4>
407       
408            <div class="comments"></div>
409           
410            <h4 id="_plt1d_keyword_Y">Y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
411             
412             
413             
414             
415             
416             
417             
418             
419            </h4>
420       
421            <div class="comments"></div>
422           
423            <h4 id="_plt1d_keyword_Z">Z&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
424             
425             
426             
427             
428             
429             
430             
431             
432            </h4>
433       
434            <div class="comments"></div>
435           
436            <h4 id="_plt1d_keyword_TT">TT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
437             
438             
439             
440             
441             
442             
443             
444             
445            </h4>
446       
447            <div class="comments"></div>
448           
449            <h4 id="_plt1d_keyword_REVERSE_X">REVERSE_X&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
450             
451             
452             
453             
454             
455             
456             
457             
458            </h4>
459       
460            <div class="comments"></div>
461           
462            <h4 id="_plt1d_keyword_REVERSE_Y">REVERSE_Y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
463             
464             
465             
466             
467             
468             
469             
470             
471            </h4>
472       
473            <div class="comments"></div>
474           
475            <h4 id="_plt1d_keyword_SWITCHXY">SWITCHXY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
476             
477             
478             
479             
480             
481             
482             
483             
484            </h4>
485       
486            <div class="comments"></div>
487           
488            <h4 id="_plt1d_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
489             
490             
491             
492             
493             
494             
495             
496             
497            </h4>
498       
499            <div class="comments"></div>
500           
501         
502
503         
504         
505         
506         
507         
508         
509         
510         
511         
512         
513         
514         
515       
516         
517         
518         
519         
520         
521         
522         
523       
524         
525       
526        </div>
527       
528      </div>
529
530     
531
532      <div id="tagline">Produced by IDLdoc 2.0.</div>
533
534    </div>
535
536  </body>
537</html>
Note: See TracBrowser for help on using the repository browser.