source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/litchamp.html @ 104

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

start to modify headers of Postscript *.pro files for better idldoc output + change the title of idldoc output in html to SAXO Documentation
File size: 8.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>litchamp.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="litchamp.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?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="inverse_binary.html">&lt;&lt;prev file</a> | <a href="ncdf_lec.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="litchamp.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/LECTURE/</a></h1>
82      <h2 class="pro_file">litchamp.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="_litchamp">
103
104          <h2><a class="top" href="#container">top</a>litchamp </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>litchamp(<span class="result"><a href="#_litchamp_param_struct">struct</a></span>, <a href="#_litchamp_keyword_GRID">GRID</a>=<span class="result">GRID</span>, <a href="#_litchamp_keyword_NAME">NAME</a>=<span class="result">NAME</span>, <a href="#_litchamp_keyword_UNIT">UNIT</a>=<span class="result">UNIT</span>, <a href="#_litchamp_keyword_EXP">EXP</a>=<span class="result">EXP</span>, <a href="#_litchamp_keyword_DATE">DATE</a>=<span class="result">DATE</span>, <a href="#_litchamp_keyword_LEVEL">LEVEL</a>=<span class="result">LEVEL</span>, <a href="#_litchamp_keyword_MASK">MASK</a>=<span class="result">MASK</span>)</p>
108       
109          <div class="comments">
110 NAME:litchamp
111
112 PURPOSE:permet de lire un simple tableau ou une structure
113 correspondant a un champ.
114 Si en entree on a :
115   -un simple tableau, litchamp renvoie le tableau
116   -une stucture, litchamp renvoie le premier element de la structure
117   qui doit obligatoirement etre le champ sous forme d''un tableau.
118   Au passage litchamp regarde les autres elements de la structure et
119   met a jour si besoin les variables globales qui se rapportent au
120   champ: vargrid, varname, varunit, vardate, varexp , valmask et time
121
122 CATEGORY:permet d''appeler plt, pltz, pltt ... avec un tableau ou une
123 structure et de mettre a jour les variables globales liees au champ.
124
125 CALLING SEQUENCE:res=litchamp(struct)
126
127 INPUTS:
128        struct: c''est soit un tableau soit une structure.
129    Si struct est une structure, elle doit suivre les regles
130    suivantes:
131        -le premier element est le tableau contenant le champ.
132        -les autres elements sont des strings qui contiennent des
133        informations sur le champ SAUF pour l''element relatif a
134        date. Ce dernier peut etre soit un string pour designer une date
135        particuliere (ex: 'August 1999') ou bien un vecteur de jours
136        juliens (d''IDL) correspondant au calendrier a associer au
137        champ si c'est une serie temporelle.
138        -l''ordre des elements (autre que le premier) n''a pas
139        d''importance.
140        -les autres elements (autre que le premier) sont tous
141        optionnels.
142        -ils sont reconnus par la premiere lettre de leur nom:
143             g  pour actualiser vargrid
144             u  pour actualiser varunit
145             e  pour actualiser varexp
146             d  pour actualiser vardate
147             n  pour actualiser varname
148             m  pour actualiser valmask
149
150 KEYWORD PARAMETERS:
151
152        /GRID: activer ce mot cle si on veut que litchamp renvoie la
153        variable associee a l''element de la structure commencant
154        par 'g' si il existe et '' dans le cas contraire.
155
156        /UNIT: activer ce mot cle si on veut que litchamp renvoie la
157        variable associee a l''element de la structure commencant
158        par 'u' si il existe et '' dans le cas contraire.
159
160        /EXP: activer ce mot cle si on veut que litchamp renvoie la
161        variable associee a l''element de la structure commencant
162        par 'e' si il existe et '' dans le cas contraire.
163
164        /DATE: activer ce mot cle si on veut que litchamp renvoie la
165        variable associee a l''element de la structure commencant
166        par 'd' si il existe et '' dans le cas contraire.
167
168        /NAME: activer ce mot cle si on veut que litchamp renvoie la
169        variable associee a l''element de la structure commencant
170        par 'n' si il existe et '' dans le cas contraire.
171
172        /LEVEL: activer ce mot cle si on veut que litchamp renvoie la
173        variable associee a l''element de la structure commencant
174        par 'l' si il existe et -1 dans le cas contraire.
175
176        /MASK: activer ce mot cle si on veut que litchamp renvoie la
177        variable associee a l''element de la structure commencant
178        par 'm' si il existe et -1 dans le cas contraire.
179
180 OUTPUTS:c''est le tableau qui continent le champ.
181
182 COMMON BLOCKS:
183        common.pro
184
185 SIDE EFFECTS: actualise au besion les variables globales vargrid,
186 varname, varunit, vardate, varexp, valmask et time.
187
188 RESTRICTIONS:
189
190 EXAMPLE:
191     
192    IDL> print, vargrid,', ', varname,', ', varunit,', ', vardate,', ', varexp     
193    T,  ,  , 0, 
194    IDL> help, litchamp({a:indgen(5), u:'C', name:'toto'})   
195    <Expression>    INT       = Array[5]
196    IDL> print, vargrid,', ', varname,', ', varunit,', ', vardate,', ', varexp     
197    T, toto, C, 0, 
198    IDL> help, litchamp({a:indgen(5), da:'1999'})   
199    <Expression>    INT       = Array[5]
200    IDL> print, vargrid,', ', varname,', ', varunit,', ', vardate,', ', varexp     
201    T, toto, C, 1999, 
202 
203</div>
204
205         
206
207         
208            <h3>Parameters</h3>
209       
210           
211            <h4 id="_litchamp_param_struct">struct&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
212             
213             
214             
215             
216             
217             
218             
219             
220            </h4>
221       
222          <div class="comments"></div>
223           
224
225         
226
227         
228
229            <h3>Keywords</h3>
230           
231            <h4 id="_litchamp_keyword_GRID">GRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
232             
233             
234             
235             
236             
237             
238             
239             
240            </h4>
241       
242            <div class="comments"></div>
243           
244            <h4 id="_litchamp_keyword_NAME">NAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
245             
246             
247             
248             
249             
250             
251             
252             
253            </h4>
254       
255            <div class="comments"></div>
256           
257            <h4 id="_litchamp_keyword_UNIT">UNIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
258             
259             
260             
261             
262             
263             
264             
265             
266            </h4>
267       
268            <div class="comments"></div>
269           
270            <h4 id="_litchamp_keyword_EXP">EXP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
271             
272             
273             
274             
275             
276             
277             
278             
279            </h4>
280       
281            <div class="comments"></div>
282           
283            <h4 id="_litchamp_keyword_DATE">DATE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
284             
285             
286             
287             
288             
289             
290             
291             
292            </h4>
293       
294            <div class="comments"></div>
295           
296            <h4 id="_litchamp_keyword_LEVEL">LEVEL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
297             
298             
299             
300             
301             
302             
303             
304             
305            </h4>
306       
307            <div class="comments"></div>
308           
309            <h4 id="_litchamp_keyword_MASK">MASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
310             
311             
312             
313             
314             
315             
316             
317             
318            </h4>
319       
320            <div class="comments"></div>
321           
322         
323
324         
325         
326         
327         
328         
329         
330         
331         
332         
333         
334         
335         
336       
337         
338         
339         
340         
341         
342         
343         
344       
345         
346       
347        </div>
348       
349      </div>
350
351     
352
353      <div id="tagline">Produced by IDLdoc 2.0.</div>
354
355    </div>
356
357  </body>
358</html>
Note: See TracBrowser for help on using the repository browser.