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

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

update documentation
File size: 9.0 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" 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="../../../../ToBeReviewed/LECTURE//litchamp.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="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" 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">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">
90 Allows to read an array or a structure corresponding to a field.
91 If we have in input:
92   - an array, litchamp send back the array.
93   - a structure, litchamp send back the first element of the structure
94   which must be the field in an array.
95 litchamp profit of this to look other elements of the structure and
96 update if needed global variables which refer to the field:
97 vargrid, varname, varunit, vardate, varexp , valmask et time
98</div>
99
100     
101
102     
103
104     
105
106     
107
108      <div id="routine_details">
109       
110
111        <div class="routine_details" id="_litchamp">
112
113          <h2><a class="top" href="#container">top</a>litchamp <span class="categories">
114 Graphics
115</span></h2>
116       
117          <p class="header">
118            <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>
119       
120          <div class="comments">
121</div>
122
123          <h3>Return value</h3><div class="preformat">
124 It is the array containing the field.
125</div>
126
127         
128            <h3>Parameters</h3>
129       
130           
131            <h4 id="_litchamp_param_struct">struct&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
132              <span class="attr">in</span>
133             
134             
135              <span class="attr">required</span>
136             
137              <span class="attr">type:</span> <span class="value">array or structure</span>
138             
139             
140            </h4>
141       
142          <div class="comments">
143  If STRUCT is a structure, it must follow following rules:
144        -the first element is the array containing the field.
145        -other elements are strings containing informations on the field except
146        for the one about the date. This one can be either a string to designate
147        a particular date (ex: 'August 1999') or a vector of julian days (of IDL)
148        corresponding  to the calendar to be associated with the field if it is a
149        temporal series.
150        -the order of elements (except the first) has not any importance.
151        -the other elements (except the first) are optional.
152        -they are recognized by the first letter of their names:
153             g  to update vargrid,
154             u  to update varunit,
155             e  to update varexp,
156             d  to update vardate,
157             n  to update varname,
158             m  to update valmask
159</div>
160           
161
162         
163
164         
165
166            <h3>Keywords</h3>
167           
168            <h4 id="_litchamp_keyword_GRID">GRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
169             
170             
171             
172             
173             
174             
175             
176             
177            </h4>
178       
179            <div class="comments">
180 We activate this keyword if we want litchamp to send back the variable
181 associated with the element of the structure starting by 'g' if it exist
182 and '' if it does not.
183</div>
184           
185            <h4 id="_litchamp_keyword_NAME">NAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
186             
187             
188             
189             
190             
191             
192             
193             
194            </h4>
195       
196            <div class="comments">
197 We activate this keyword if we want litchamp to send back the variable
198 associated with the element of the structure starting by 'n' if it exist
199 and '' if it does not.
200</div>
201           
202            <h4 id="_litchamp_keyword_UNIT">UNIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
203             
204             
205             
206             
207             
208             
209             
210             
211            </h4>
212       
213            <div class="comments">
214 We activate this keyword if we want litchamp to send back the variable
215 associated with the element of the structure starting by 'u' if it exist
216 and '' if it does not.
217</div>
218           
219            <h4 id="_litchamp_keyword_EXP">EXP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
220             
221             
222             
223             
224             
225             
226             
227             
228            </h4>
229       
230            <div class="comments">
231 We activate this keyword if we want litchamp to send back the variable
232 associated with the element of the structure starting by 'u' if it exist
233 and '' if it does not.
234</div>
235           
236            <h4 id="_litchamp_keyword_DATE">DATE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
237             
238             
239             
240             
241             
242             
243             
244             
245            </h4>
246       
247            <div class="comments">
248 We activate this keyword if we want litchamp to send back the variable
249 associated with the element of the structure starting by 'd' if it exist
250 and '' if it does not.
251</div>
252           
253            <h4 id="_litchamp_keyword_LEVEL">LEVEL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
254             
255             
256             
257             
258             
259             
260             
261             
262            </h4>
263       
264            <div class="comments">
265 We activate this keyword if we want litchamp to send back the variable
266 associated with the element of the structure starting by 'l' if it exist
267 and -1 if it does not.
268</div>
269           
270            <h4 id="_litchamp_keyword_MASK">MASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
271             
272             
273             
274             
275             
276             
277             
278             
279            </h4>
280       
281            <div class="comments">
282 We activate this keyword if we want litchamp to send back the variable
283 associated with the element of the structure starting by 'm' if it exist
284 and -1 if it does not.
285</div>
286           
287         
288
289          <h3>Examples</h3><div class="preformat">
290
291   IDL> print, vargrid,', ', varname,', ', varunit,', ', vardate,', ', varexp
292    T,  ,  , 0,
293   IDL> help, litchamp({a:indgen(5), u:'C', name:'toto'})
294    <Expression>    INT       = Array[5]
295   IDL> print, vargrid,', ', varname,', ', varunit,', ', vardate,', ', varexp
296    T, toto, C, 0,
297   IDL> help, litchamp({a:indgen(5), da:'1999'})
298    <Expression>    INT       = Array[5]
299   IDL> print, vargrid,', ', varname,', ', varunit,', ', vardate,', ', varexp
300    T, toto, C, 1999,
301
302</div>
303          <h3>Version history</h3>
304         
305          <h4>Version</h4><div class="preformat">
306 $Id: litchamp.pro 371 2008-08-07 09:32:02Z pinsard $
307</div>
308          <h4>History</h4><div class="preformat">
309 Sebastien Masson (smasson@lodyc.jussieu.fr)
310                       28/5/1999
311</div>
312         
313         
314          <h3>Known issues</h3>
315         
316         
317         
318          <h4>Restrictions</h4><div class="preformat">
319 Update if needed global variables vargrid,
320 varname, varunit, vardate, varexp, valmask and time.
321</div>
322       
323          <h3>Other attributes</h3>
324         
325         
326          <h4>Uses routines</h4><div class="preformat">
327 <a href="../..//Obsolete/common.html">common</a>
328</div>
329         
330         
331         
332       
333          <h3>Statistics</h3>
334          <table class="statistics">
335            <tr><td>McCabe cyclic</td><td>          41</td></tr>
336            <tr><td>McCabe essential</td><td>           1</td></tr>
337            <tr><td>McCabe modular design</td><td>           1</td></tr>
338          </table>
339         
340       
341        </div>
342       
343      </div>
344
345     
346
347      <div id="tagline">Produced by IDLdoc 2.0.</div>
348
349    </div>
350
351  </body>
352</html>
Note: See TracBrowser for help on using the repository browser.