source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/xncdf_lec.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 13.9 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 NetCdf 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 widget 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 <proidl>shift</proidl> 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 IDL> help, xncdf_lec()
318</div>
319          <h3>Version history</h3>
320         
321          <h4>Version</h4><div class="preformat">
322 $Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $
323</div>
324          <h4>History</h4><div class="preformat">
325 Sebastien Masson (smasson@lodyc.jussieu.fr)
326                      24/8/1999
327</div>
328         
329         
330         
331         
332         
333         
334         
335       
336          <h3>Other attributes</h3>
337         
338         
339          <h4>Uses routines</h4><div class="preformat">
340 wididbase, infovariable, resultat, motcle
341</div>
342         
343         
344          <h4>Common blocks used</h4><div class="preformat">wididbase
345infovariable
346resultat
347motcle</div>
348       
349          <h3>Statistics</h3>
350          <table class="statistics">
351            <tr><td>McCabe cyclic</td><td>          23</td></tr>
352            <tr><td>McCabe essential</td><td>           1</td></tr>
353            <tr><td>McCabe modular design</td><td>           1</td></tr>
354          </table>
355         
356       
357        </div>
358       
359
360        <div class="routine_details" id="_wid_var_event">
361
362          <h2><a class="top" href="#container">top</a>wid_var_event </h2>
363       
364          <p class="header">
365            wid_var_event<span class="result">, <a href="#_wid_var_event_param_event">event</a></span></p>
366       
367          <div class="comments">
368</div>
369
370         
371
372         
373            <h3>Parameters</h3>
374       
375           
376            <h4 id="_wid_var_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
377              <span class="attr">in</span>
378             
379             
380              <span class="attr">required</span>
381             
382             
383             
384             
385            </h4>
386       
387          <div class="comments">
388 A structure characterizing the type of event which arrive to a widget number1 2
389</div>
390           
391
392         
393
394         
395
396         
397          <h3>Version history</h3>
398         
399          <h4>Version</h4><div class="preformat">
400 $Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $
401</div>
402         
403         
404         
405         
406         
407         
408         
409         
410       
411          <h3>Other attributes</h3>
412         
413         
414          <h4>Uses routines</h4><div class="preformat">
415 wididbase,resultat,infovariable,indicewid,motcle
416</div>
417         
418         
419          <h4>Common blocks used</h4><div class="preformat">wididbase
420resultat
421infovariable
422indicewid_var
423motcle</div>
424       
425          <h3>Statistics</h3>
426          <table class="statistics">
427            <tr><td>McCabe cyclic</td><td>          34</td></tr>
428            <tr><td>McCabe essential</td><td>           1</td></tr>
429            <tr><td>McCabe modular design</td><td>           1</td></tr>
430          </table>
431         
432       
433        </div>
434       
435
436        <div class="routine_details" id="_wid_var">
437
438          <h2><a class="top" href="#container">top</a>wid_var </h2>
439       
440          <p class="header">
441            wid_var<span class="result">, <a href="#_wid_var_param_widid_pere">widid_pere</a></span></p>
442       
443          <div class="comments">
444</div>
445
446         
447
448         
449            <h3>Parameters</h3>
450       
451           
452            <h4 id="_wid_var_param_widid_pere">widid_pere&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
453              <span class="attr">in</span>
454             
455             
456              <span class="attr">required</span>
457             
458              <span class="attr">type:</span> <span class="value">scalar</span>
459             
460             
461            </h4>
462       
463          <div class="comments">
464 It contains the identity of the father widget which was
465 created by xncdf_lec and which has allowed to select the variable to be read.
466</div>
467           
468
469         
470
471         
472
473         
474          <h3>Version history</h3>
475         
476          <h4>Version</h4><div class="preformat">
477 $Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $</div>
478         
479         
480         
481         
482         
483         
484         
485         
486       
487          <h3>Other attributes</h3>
488         
489         
490          <h4>Uses routines</h4><div class="preformat">
491 resultat,infovariable,indicewid_var,motcle
492</div>
493         
494         
495          <h4>Common blocks used</h4><div class="preformat">resultat
496infovariable
497indicewid_var
498motcle</div>
499       
500          <h3>Statistics</h3>
501          <table class="statistics">
502            <tr><td>McCabe cyclic</td><td>           7</td></tr>
503            <tr><td>McCabe essential</td><td>           1</td></tr>
504            <tr><td>McCabe modular design</td><td>           1</td></tr>
505          </table>
506         
507       
508        </div>
509       
510
511        <div class="routine_details" id="_xncdf_lec_event">
512
513          <h2><a class="top" href="#container">top</a>xncdf_lec_event </h2>
514       
515          <p class="header">
516            xncdf_lec_event<span class="result">, <a href="#_xncdf_lec_event_param_event">event</a></span></p>
517       
518          <div class="comments">
519</div>
520
521         
522
523         
524            <h3>Parameters</h3>
525       
526           
527            <h4 id="_xncdf_lec_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
528             
529             
530             
531             
532             
533             
534             
535             
536            </h4>
537       
538          <div class="comments">
539 A structure characterising the event type which arrive at the widget number 1.
540</div>
541           
542
543         
544
545         
546
547         
548          <h3>Version history</h3>
549         
550          <h4>Version</h4><div class="preformat">
551 $Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $
552</div>
553         
554         
555         
556         
557         
558         
559         
560         
561       
562          <h3>Other attributes</h3>
563         
564         
565          <h4>Uses routines</h4><div class="preformat">
566 resultat, infovariable, motcle
567</div>
568         
569         
570          <h4>Common blocks used</h4><div class="preformat">resultat
571infovariable
572motcle</div>
573       
574          <h3>Statistics</h3>
575          <table class="statistics">
576            <tr><td>McCabe cyclic</td><td>           5</td></tr>
577            <tr><td>McCabe essential</td><td>           1</td></tr>
578            <tr><td>McCabe modular design</td><td>           1</td></tr>
579          </table>
580         
581       
582        </div>
583       
584      </div>
585
586     
587
588      <div id="tagline">Produced by IDLdoc 2.0.</div>
589
590    </div>
591
592  </body>
593</html>
Note: See TracBrowser for help on using the repository browser.