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

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

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 9.3 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 extaire (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 tarcer
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"></div>
121
122          <h3>Return value</h3><div class="preformat"> un tableau 2 ou 3d. sans le mot cle /TOUT, sa taille est
123 celle du sous domaine definit par domdef (nx,ny,nz). avec /TOUT le
124 champ a la taille du  domaine qui a etait selectionne pour la
125 cession en cours (jpi,jpj,jpk).
126 pour les sous domaines cf:
127        http://www.ipsl.jussieu.fr/~smlod/sousdomaine.html
128 Retourne -1 en cas d'erreur.
129</div>
130
131         
132            <h3>Parameters</h3>
133       
134           
135            <h4 id="_lec_param_nomchamp">nomchamp&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
136              <span class="attr">in</span>
137             
138             
139              <span class="attr">required</span>
140             
141             
142             
143             
144            </h4>
145       
146          <div class="comments"> 2 choix possibles:
147             1) nom de champ Vairmer (chaine de 8 caracteres en majuscule ou
148 minuscule commencant par vo ou so). Dans cette methode on saute directement
149 d'en-tete en en-tete jusqu'a trouver le bon fichier.
150             2) chaine de characteres commencant par vo ou so suivit du
151 numero de champ a aller chercher (par ex 'vo5'). Cette methode est un peu
152 plus rapide car elle va directement chercher le fichier qui nous interesse.
153</div>
154           
155            <h4 id="_lec_param_date">date&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
156              <span class="attr">in</span>
157             
158              <span class="attr">optional</span>
159             
160             
161             
162             
163             
164            </h4>
165       
166          <div class="comments"> nombres de 6 ou 8 chiffres (anneemoisjour, par ex:19980507)
167</div>
168           
169            <h4 id="_lec_param_nomexp">nomexp&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
170              <span class="attr">in</span>
171             
172              <span class="attr">optional</span>
173             
174             
175             
176             
177             
178            </h4>
179       
180          <div class="comments"> trois lettres designant le nom de l'experience
181
182</div>
183           
184
185         
186
187         
188
189            <h3>Keywords</h3>
190           
191            <h4 id="_lec_keyword_ECRIT">ECRIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
192              <span class="attr">in</span>
193             
194             
195             
196             
197             
198             
199             
200            </h4>
201       
202            <div class="comments"> permet d'imprimer tous les noms vairmer que contient le fichier.
203 ds ce cas en input on met seulement 'vo' ou 'so' la fonction retourne le
204 nombre de fichiers lus.
205</div>
206           
207            <h4 id="_lec_keyword_ANOM">ANOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
208              <span class="attr">in</span>
209             
210             
211             
212             
213             
214             
215             
216            </h4>
217       
218            <div class="comments"> type du fichier vairmer par rapport auquel on doit calculer
219             l'anomalie ('EX','AN','SE','MO','')
220</div>
221           
222            <h4 id="_lec_keyword_BOITE">BOITE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
223             
224             
225             
226             
227             
228             
229             
230             
231            </h4>
232       
233            <div class="comments">
234</div>
235           
236            <h4 id="_lec_keyword_EXPANOM">EXPANOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
237              <span class="attr">in</span>
238             
239             
240             
241             
242             
243             
244             
245            </h4>
246       
247            <div class="comments"> si on calcule l'anom par rapport a une exper
248       differente
249</div>
250           
251            <h4 id="_lec_keyword_TOUT">TOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
252             
253             
254             
255             
256             
257             
258             
259             
260            </h4>
261       
262            <div class="comments">  oblige lec a lire le champ sur tout le domaine qui a
263       etait selectionne pour la cession en cours (jpi,jpj,jpk)
264</div>
265           
266            <h4 id="_lec_keyword_GRID">GRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
267             
268             
269             
270             
271             
272             
273             
274             
275            </h4>
276       
277            <div class="comments"> lorsque ce mot clef est active, lec retourne la liste
278       des types de grilles (T, U...) auxquelles se rapportent les
279       variables. ds ce cas en input on met seulement 'vo' ou 'so'.
280</div>
281           
282            <h4 id="_lec_keyword_NAME">NAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
283             
284             
285             
286             
287             
288             
289             
290             
291            </h4>
292       
293            <div class="comments"> lorsque ce mot clef est active, lec retourne la liste
294       des noms des variables. ds ce cas en input on met seulement
295       'vo' ou 'so'.
296</div>
297           
298            <h4 id="_lec_keyword_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
299             
300             
301             
302             
303             
304             
305             
306             
307            </h4>
308       
309            <div class="comments"> string pour passer directement le nom du champ sans
310       utiliser les inputs: nom_Vairmer',date,'nom_experience'. Rq si
311       ces inputs sont qd meme donnes ils ne sont pas modifies par
312       filename.
313</div>
314           
315         
316
317          <h3>Examples</h3><div class="preformat">
318 IDL> resultat=lec('nom_Vairmer'[,date[,'nom_experience']])
319</div>
320          <h3>Version history</h3>
321         
322          <h4>Version</h4><div class="preformat"> $Id: lec.pro 157 2006-08-21 09:01:50Z navarro $
323
324;-</div>
325          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr)
326                        26/5/98
327                       Jerome Vialard : adaptation au format vairmer
328                                        keyword anom et expanom
329                        1/7/98
330                       Sebastien Masson (masque des terres)
331                        14/8/98
332                       Sebastien Masson (decoupe pour les sous domaines...)
333                        2/99
334</div>
335         
336         
337          <h3>Known issues</h3>
338          <h4>Obsolete</h4><div class="preformat">
339</div>
340         
341         
342         
343       
344          <h3>Other attributes</h3>
345         
346         
347          <h4>Uses routines</h4><div class="preformat"> common.pro isnumber.pro fivardate.pro
348</div>
349         
350         
351         
352       
353          <h3>Statistics</h3>
354          <table class="statistics">
355            <tr><td>McCabe cyclic</td><td>          70</td></tr>
356            <tr><td>McCabe essential</td><td>           4</td></tr>
357            <tr><td>McCabe modular design</td><td>           1</td></tr>
358          </table>
359         
360       
361        </div>
362       
363      </div>
364
365     
366
367      <div id="tagline">Produced by IDLdoc 2.0.</div>
368
369    </div>
370
371  </body>
372</html>
Note: See TracBrowser for help on using the repository browser.