source: trunk/SRC/Documentation/idldoc_html_output/Obsolete/lec.html

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

update documentation

File size: 9.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>lec.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="lec.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="../../../Obsolete//lec.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&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="juldate.html">&lt;&lt;prev file</a> | <a href="lect.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="lec.html" target="_TOP">view single page</a> | <a href="./../index.html" 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">Obsolete/</a></h1>
82      <h2 class="pro_file">lec.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 lit les fichiers Vairmer en sort:
91 un tableau 2d ou 3d en fonction de nomchamp qui est le nom
92 du champ a extraire (2d s'il commence par SO et 3d s'il commence par VO)
93 cette fonction modifie aussi les variables globales:
94 varname: trois lettres: nom de l'experience
95 vargrid: nom de la grille
96 vardate: date (yy)yymmdd
97 varexp: nom Vairmer du champ a tracer
98</div>
99
100     
101
102     
103
104     
105
106     
107
108      <div id="routine_details">
109       
110
111        <div class="routine_details" id="_lec">
112
113          <h2><a class="top" href="#container">top</a>lec <span class="warning">obsolete</span> <span class="categories">
114 Graphics, Reading
115</span></h2>
116       
117          <p class="header">
118            <span class="result">result = </span>lec(<span class="result"><a href="#_lec_param_nomchamp">nomchamp</a>[, <a href="#_lec_param_date">date</a>][, <a href="#_lec_param_nomexp">nomexp</a>]</span>, <a href="#_lec_keyword_ECRIT">ECRIT</a>=<span class="result">ECRIT</span>, <a href="#_lec_keyword_ANOM">ANOM</a>=<span class="result">ANOM</span>, <a href="#_lec_keyword_BOITE">BOITE</a>=<span class="result">BOITE</span>, <a href="#_lec_keyword_EXPANOM">EXPANOM</a>=<span class="result">EXPANOM</span>, <a href="#_lec_keyword_TOUT">TOUT</a>=<span class="result">TOUT</span>, <a href="#_lec_keyword_GRID">GRID</a>=<span class="result">GRID</span>, <a href="#_lec_keyword_NAME">NAME</a>=<span class="result">NAME</span>, <a href="#_lec_keyword_filename">filename</a>=<span class="result">filename</span>)</p>
119       
120          <div class="comments">
121</div>
122
123          <h3>Return value</h3><div class="preformat">
124 un tableau 2d ou 3d. sans le mot cle /TOUT, sa taille est
125 celle du sous domaine definit par <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a>(nx,ny,nz). avec /TOUT le
126 champ a la taille du  domaine qui a etait selectionne pour la
127 cession en cours (jpi,jpj,jpk).
128 pour les sous domaines cf:
129        <a href="http://www.ipsl.jussieu.fr/~smlod/sousdomaine.html">
130 Retourne -1 en cas d'erreur.
131</div>
132
133         
134            <h3>Parameters</h3>
135       
136           
137            <h4 id="_lec_param_nomchamp">nomchamp&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
138              <span class="attr">in</span>
139             
140             
141              <span class="attr">required</span>
142             
143             
144             
145             
146            </h4>
147       
148          <div class="comments">
149 2 choix possibles:
150             1) nom de champ Vairmer (chaine de 8 caracteres en majuscule ou
151 minuscule commencant par vo ou so). Dans cette methode on saute directement
152 d'en-tete en en-tete jusqu'a trouver le bon fichier.
153             2) chaine de caracteres commencant par vo ou so suivit du
154 numero de champ a aller chercher (par ex 'vo5'). Cette methode est un peu
155 plus rapide car elle va directement chercher le fichier qui nous interesse.
156</div>
157           
158            <h4 id="_lec_param_date">date&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
159              <span class="attr">in</span>
160             
161              <span class="attr">optional</span>
162             
163             
164             
165             
166             
167            </h4>
168       
169          <div class="comments">
170 nombres de 6 ou 8 chiffres (anneemoisjour, par ex:19980507)
171</div>
172           
173            <h4 id="_lec_param_nomexp">nomexp&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
174              <span class="attr">in</span>
175             
176              <span class="attr">optional</span>
177             
178             
179             
180             
181             
182            </h4>
183       
184          <div class="comments">
185 trois lettres designant le nom de l'experience
186</div>
187           
188
189         
190
191         
192
193            <h3>Keywords</h3>
194           
195            <h4 id="_lec_keyword_ECRIT">ECRIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
196              <span class="attr">in</span>
197             
198             
199             
200             
201             
202             
203             
204            </h4>
205       
206            <div class="comments">
207 permet d'imprimer tous les noms vairmer que contient le fichier.
208 ds ce cas en input on met seulement 'vo' ou 'so' la fonction retourne le
209 nombre de fichiers lus.
210</div>
211           
212            <h4 id="_lec_keyword_ANOM">ANOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
213              <span class="attr">in</span>
214             
215             
216             
217             
218             
219             
220             
221            </h4>
222       
223            <div class="comments">
224 type du fichier vairmer par rapport auquel on doit calculer
225             l'anomalie ('EX','AN','SE','MO','')
226</div>
227           
228            <h4 id="_lec_keyword_BOITE">BOITE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
229             
230             
231             
232             
233             
234             
235             
236             
237            </h4>
238       
239            <div class="comments">
240</div>
241           
242            <h4 id="_lec_keyword_EXPANOM">EXPANOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
243              <span class="attr">in</span>
244             
245             
246             
247             
248             
249             
250             
251            </h4>
252       
253            <div class="comments">
254 si on calcule l'anom par rapport a une exper differente
255</div>
256           
257            <h4 id="_lec_keyword_TOUT">TOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
258             
259             
260             
261             
262             
263             
264             
265             
266            </h4>
267       
268            <div class="comments">
269 oblige lec a lire le champ sur tout le domaine qui a
270 etait selectionne pour la cession en cours (jpi,jpj,jpk)
271</div>
272           
273            <h4 id="_lec_keyword_GRID">GRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
274             
275             
276             
277             
278             
279             
280             
281             
282            </h4>
283       
284            <div class="comments">
285 lorsque ce mot clef est active, lec retourne la liste
286 des types de grilles (T, U...) auxquelles se rapportent les
287 variables. ds ce cas en input on met seulement 'vo' ou 'so'.
288</div>
289           
290            <h4 id="_lec_keyword_NAME">NAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
291             
292             
293             
294             
295             
296             
297             
298             
299            </h4>
300       
301            <div class="comments">
302 lorsque ce mot clef est active, lec retourne la liste
303 des noms des variables. ds ce cas en input on met seulement
304 'vo' ou 'so'.
305</div>
306           
307            <h4 id="_lec_keyword_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
308             
309             
310             
311             
312             
313             
314             
315             
316            </h4>
317       
318            <div class="comments">
319 string pour passer directement le nom du champ sans
320 utiliser les inputs: nom_Vairmer',date,'nom_experience'. Rq si
321 ces inputs sont qd meme donnes ils ne sont pas modifies par
322 filename.
323</div>
324           
325         
326
327          <h3>Examples</h3><div class="preformat">
328
329   IDL> resultat=lec('nom_Vairmer'[,date[,'nom_experience']])
330</div>
331          <h3>Version history</h3>
332         
333          <h4>Version</h4><div class="preformat">
334 $Id: lec.pro 378 2008-08-12 12:35:46Z pinsard $
335</div>
336          <h4>History</h4><div class="preformat">
337 Sebastien Masson (smasson@lodyc.jussieu.fr)
338                        26/5/98
339                       Jerome Vialard : adaptation au format vairmer
340                                        keyword anom et expanom
341                        1/7/98
342                       Sebastien Masson (masque des terres)
343                        14/8/98
344                       Sebastien Masson (decoupe pour les sous domaines...)
345                        2/99
346</div>
347         
348         
349          <h3>Known issues</h3>
350          <h4>Obsolete</h4><div class="preformat">
351</div>
352         
353         
354         
355       
356          <h3>Other attributes</h3>
357         
358         
359          <h4>Uses routines</h4><div class="preformat">
360 <a href="..//Obsolete/common.html">common</a>
361 <a href="..//ToBeReviewed/STRING/isnumber.html">isnumber</a>
362 <a href="..//Obsolete/ficdate.html">ficdate</a>
363</div>
364         
365         
366         
367       
368          <h3>Statistics</h3>
369          <table class="statistics">
370            <tr><td>McCabe cyclic</td><td>          70</td></tr>
371            <tr><td>McCabe essential</td><td>           4</td></tr>
372            <tr><td>McCabe modular design</td><td>           1</td></tr>
373          </table>
374         
375       
376        </div>
377       
378      </div>
379
380     
381
382      <div id="tagline">Produced by IDLdoc 2.0.</div>
383
384    </div>
385
386  </body>
387</html>
Note: See TracBrowser for help on using the repository browser.