source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/xncdf_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: 14.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>xncdf_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="xncdf_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="../../../../ToBeReviewed/LECTURE//xncdf_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="read_ncdf_varget.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="xncdf_lec.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&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">xncdf_lec.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Reading of a Net Cdf file with widgets !
91
92
93 Procedure called by xmanager when we press on a button of a second widget created by wid_var.
94 
95
96 This procedure manage the second created whiget when we call xncdf_lec.
97 This widget concern the reading of the variable.
98
99
100 Procedure called by xmanager when we press a button of the first widget
101 created by par xncdf_lec
102 </div>
103
104     
105
106     
107
108     
109
110     
111      <div id="routine_summary">               
112        <h2>Routine summary</h2>
113       
114        <dl>
115         
116          <dt><p><a href="#_xncdf_lec"><span class="result">result = </span>xncdf_lec(<span class="result">[name]</span>, ATT=<span class="result">ATT</span>, COUNT=<span class="result">vector</span>, GROUP=<span class="result">GROUP</span>, OFFSET=<span class="result">vector</span>, IODIR=<span class="result">string</span>, SHIFT=<span class="result">vector</span>, STRIDE=<span class="result">vector</span>, VAR=<span class="result">VAR</span>)</a></p><dt>
117          <dd> </dd>   
118         
119          <dt><p><a href="#_wid_var_event">wid_var_event<span class="result">, event</span></a></p><dt>
120          <dd></dd>     
121         
122          <dt><p><a href="#_wid_var">wid_var<span class="result">, widid_pere</span></a></p><dt>
123          <dd></dd>     
124         
125          <dt><p><a href="#_xncdf_lec_event">xncdf_lec_event<span class="result">, event</span></a></p><dt>
126          <dd></dd>     
127               
128        </dl>
129      </div>
130     
131
132      <div id="routine_details">
133       
134
135        <div class="routine_details" id="_xncdf_lec">
136
137          <h2><a class="top" href="#container">top</a>xncdf_lec <span class="categories"> 
138 Widget
139</span></h2>
140       
141          <p class="header">
142            <span class="result">result = </span>xncdf_lec(<span class="result">[<a href="#_xncdf_lec_param_name">name</a>]</span>, <a href="#_xncdf_lec_keyword_ATT">ATT</a>=<span class="result">ATT</span>, <a href="#_xncdf_lec_keyword_COUNT">COUNT</a>=<span class="result">vector</span>, <a href="#_xncdf_lec_keyword_GROUP">GROUP</a>=<span class="result">GROUP</span>, <a href="#_xncdf_lec_keyword_OFFSET">OFFSET</a>=<span class="result">vector</span>, <a href="#_xncdf_lec_keyword_IODIR">IODIR</a>=<span class="result">string</span>, <a href="#_xncdf_lec_keyword_SHIFT">SHIFT</a>=<span class="result">vector</span>, <a href="#_xncdf_lec_keyword_STRIDE">STRIDE</a>=<span class="result">vector</span>, <a href="#_xncdf_lec_keyword_VAR">VAR</a>=<span class="result">VAR</span>)</p>
143       
144          <div class="comments">
145</div>
146
147          <h3>Return value</h3><div class="preformat">
148  2 different cases:
149       1) None attribute has been selected. In this case, res is the array we
150       wanted to read.
151       2) Some attributes has been selected. In this case, res is a structure
152       whose the first element having the name of the variable is the values
153       array and the other arguments are the select arguments.
154</div>
155
156         
157            <h3>Parameters</h3>
158       
159           
160            <h4 id="_xncdf_lec_param_name">name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
161              <span class="attr">in</span>
162             
163              <span class="attr">optional</span>
164             
165             
166              <span class="attr">type:</span> <span class="value">string</span>
167             
168             
169            </h4>
170       
171          <div class="comments"> 
172 It give the name of the file to be opened. If NAME
173 does not contain the separating character of directories ('/' under
174 unix for example), the file will be looked for in the current directory.
175</div>
176           
177
178         
179
180         
181
182            <h3>Keywords</h3>
183           
184            <h4 id="_xncdf_lec_keyword_ATT">ATT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
185             
186             
187             
188             
189             
190             
191             
192             
193            </h4>
194       
195            <div class="comments"></div>
196           
197            <h4 id="_xncdf_lec_keyword_COUNT">COUNT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
198             
199             
200             
201             
202             
203              <span class="attr">type:</span> <span class="value">vector</span>
204             
205             
206            </h4>
207       
208            <div class="comments">
209 An optional vector containing the counts to be used in
210 reading Value. COUNT is a 1-based vector with an element for
211 each dimension of the data to be written.The default matches
212 the size of the variable so that all data is written out.
213</div>
214           
215            <h4 id="_xncdf_lec_keyword_GROUP">GROUP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
216             
217             
218             
219             
220             
221             
222             
223             
224            </h4>
225       
226            <div class="comments">
227 The widget ID of the widget that calls XNCDF_LEC. When
228 this ID is specified, a death of the caller results in a death
229 of XNCDF_LEC.
230</div>
231           
232            <h4 id="_xncdf_lec_keyword_OFFSET">OFFSET&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
233             
234             
235             
236             
237             
238              <span class="attr">type:</span> <span class="value">vector</span>
239              <span class="attr">default:</span> <span class="value">[0, 0,...]</span>
240             
241            </h4>
242       
243            <div class="comments">
244 An optional vector containing the starting position
245 for the read. The default start position is [0, 0, ...].
246</div>
247           
248            <h4 id="_xncdf_lec_keyword_IODIR">IODIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
249             
250             
251             
252             
253             
254              <span class="attr">type:</span> <span class="value">string</span>
255             
256             
257            </h4>
258       
259            <div class="comments">
260 It contains the directory where to go look for the file to be read.
261 If NAME does not contain the separating character of directories ('/' under
262 unix for example), the file will be called iodir+nom_fichier.
263</div>
264           
265            <h4 id="_xncdf_lec_keyword_SHIFT">SHIFT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
266             
267             
268             
269             
270             
271              <span class="attr">type:</span> <span class="value">vector</span>
272              <span class="attr">default:</span> <span class="value">[0, 0,...]</span>
273             
274            </h4>
275       
276            <div class="comments">
277 A vector of integers, specifying for each dimension how much we have to shift it.
278 By default, it is [0,0,...]. See the function shift for more explanations. BEWARE,
279 the shift is done on the biggest array before a possible reduction determined
280 by OFFSET and COUNT. On the other hand, it is done after the possible extraction
281 created by the STRIDE.
282</div>
283           
284            <h4 id="_xncdf_lec_keyword_STRIDE">STRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
285             
286             
287             
288             
289             
290              <span class="attr">type:</span> <span class="value">vector</span>
291              <span class="attr">default:</span> <span class="value">[1, 1,...]</span>
292             
293            </h4>
294       
295            <div class="comments">
296 An optional vector containing the strides, or sampling
297 intervals, between accessed values of the netCDF variable. The
298 default stride vector is that for a contiguous read, [1, 1,...].
299</div>
300           
301            <h4 id="_xncdf_lec_keyword_VAR">VAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
302             
303             
304             
305             
306             
307             
308             
309             
310            </h4>
311       
312            <div class="comments"></div>
313           
314         
315
316          <h3>Examples</h3><div class="preformat">
317 help, xncdf_lec()
318</div>
319          <h3>Version history</h3>
320         
321          <h4>Version</h4><div class="preformat">
322 $Id: xncdf_lec.pro 163 2006-08-29 12:59:46Z navarro $</div>
323          <h4>History</h4><div class="preformat">
324 Sebastien Masson (smasson@lodyc.jussieu.fr)
325                      24/8/1999
326</div>
327         
328         
329         
330         
331         
332         
333         
334       
335          <h3>Other attributes</h3>
336         
337         
338          <h4>Uses routines</h4><div class="preformat">
339 wididbase, infovariable, resultat, motcle
340</div>
341         
342         
343          <h4>Common blocks used</h4><div class="preformat">wididbase
344infovariable
345resultat
346motcle</div>
347       
348          <h3>Statistics</h3>
349          <table class="statistics">
350            <tr><td>McCabe cyclic</td><td>          23</td></tr>
351            <tr><td>McCabe essential</td><td>           1</td></tr>
352            <tr><td>McCabe modular design</td><td>           1</td></tr>
353          </table>
354         
355       
356        </div>
357       
358
359        <div class="routine_details" id="_wid_var_event">
360
361          <h2><a class="top" href="#container">top</a>wid_var_event </h2>
362       
363          <p class="header">
364            wid_var_event<span class="result">, <a href="#_wid_var_event_param_event">event</a></span></p>
365       
366          <div class="comments"></div>
367
368         
369
370         
371            <h3>Parameters</h3>
372       
373           
374            <h4 id="_wid_var_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
375              <span class="attr">in</span>
376             
377             
378              <span class="attr">required</span>
379             
380             
381             
382             
383            </h4>
384       
385          <div class="comments">
386 A structure caracterizing the type of event which arrive to a widget number1 2
387</div>
388           
389
390         
391
392         
393
394         
395          <h3>Version history</h3>
396         
397          <h4>Version</h4><div class="preformat">
398 $Id: xncdf_lec.pro 163 2006-08-29 12:59:46Z navarro $</div>
399         
400         
401         
402         
403         
404         
405         
406         
407       
408          <h3>Other attributes</h3>
409         
410         
411          <h4>Uses routines</h4><div class="preformat">
412 wididbase,resultat,infovariable,indicewid,motcle
413 </div>
414         
415         
416          <h4>Common blocks used</h4><div class="preformat">wididbase
417resultat
418infovariable
419indicewid_var
420motcle</div>
421       
422          <h3>Statistics</h3>
423          <table class="statistics">
424            <tr><td>McCabe cyclic</td><td>          34</td></tr>
425            <tr><td>McCabe essential</td><td>           1</td></tr>
426            <tr><td>McCabe modular design</td><td>           1</td></tr>
427          </table>
428         
429       
430        </div>
431       
432
433        <div class="routine_details" id="_wid_var">
434
435          <h2><a class="top" href="#container">top</a>wid_var </h2>
436       
437          <p class="header">
438            wid_var<span class="result">, <a href="#_wid_var_param_widid_pere">widid_pere</a></span></p>
439       
440          <div class="comments"></div>
441
442         
443
444         
445            <h3>Parameters</h3>
446       
447           
448            <h4 id="_wid_var_param_widid_pere">widid_pere&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
449              <span class="attr">in</span>
450             
451             
452              <span class="attr">required</span>
453             
454              <span class="attr">type:</span> <span class="value">scalar</span>
455             
456             
457            </h4>
458       
459          <div class="comments">
460 It contains the identity of the father widget which was
461 created by xncdf_lec and which has allowed to select the variable to be read.
462
463 OUTPUTS: indirectement res (le tableau ou la structure resultat)
464</div>
465           
466
467         
468
469         
470
471         
472          <h3>Version history</h3>
473         
474          <h4>Version</h4><div class="preformat">
475 $Id: xncdf_lec.pro 163 2006-08-29 12:59:46Z navarro $</div>
476         
477         
478         
479         
480         
481         
482         
483         
484       
485          <h3>Other attributes</h3>
486         
487         
488          <h4>Uses routines</h4><div class="preformat"> 
489 resultat,infovariable,indicewid_var,motcle
490</div>
491         
492         
493          <h4>Common blocks used</h4><div class="preformat">resultat
494infovariable
495indicewid_var
496motcle</div>
497       
498          <h3>Statistics</h3>
499          <table class="statistics">
500            <tr><td>McCabe cyclic</td><td>           7</td></tr>
501            <tr><td>McCabe essential</td><td>           1</td></tr>
502            <tr><td>McCabe modular design</td><td>           1</td></tr>
503          </table>
504         
505       
506        </div>
507       
508
509        <div class="routine_details" id="_xncdf_lec_event">
510
511          <h2><a class="top" href="#container">top</a>xncdf_lec_event </h2>
512       
513          <p class="header">
514            xncdf_lec_event<span class="result">, <a href="#_xncdf_lec_event_param_event">event</a></span></p>
515       
516          <div class="comments"></div>
517
518         
519
520         
521            <h3>Parameters</h3>
522       
523           
524            <h4 id="_xncdf_lec_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
525             
526             
527             
528             
529             
530             
531             
532             
533            </h4>
534       
535          <div class="comments">
536 A structure caracterising the event type which arrive at the widget number 1.
537</div>
538           
539
540         
541
542         
543
544         
545          <h3>Version history</h3>
546         
547          <h4>Version</h4><div class="preformat">
548 $Id: xncdf_lec.pro 163 2006-08-29 12:59:46Z navarro $</div>
549         
550         
551         
552         
553         
554         
555         
556         
557       
558          <h3>Other attributes</h3>
559         
560         
561          <h4>Uses routines</h4><div class="preformat">
562 resultat, infovariable, motcle
563</div>
564         
565         
566          <h4>Common blocks used</h4><div class="preformat">resultat
567infovariable
568motcle</div>
569       
570          <h3>Statistics</h3>
571          <table class="statistics">
572            <tr><td>McCabe cyclic</td><td>           5</td></tr>
573            <tr><td>McCabe essential</td><td>           1</td></tr>
574            <tr><td>McCabe modular design</td><td>           1</td></tr>
575          </table>
576         
577       
578        </div>
579       
580      </div>
581
582     
583
584      <div id="tagline">Produced by IDLdoc 2.0.</div>
585
586    </div>
587
588  </body>
589</html>
Note: See TracBrowser for help on using the repository browser.