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

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

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