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

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

update documentation
File size: 6.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>ncdf_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="ncdf_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//ncdf_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="litchamp.html">&lt;&lt;prev file</a> | <a href="read_ftp.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="ncdf_lec.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">ncdf_lec.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Give informations on a file netcdf and allows to recuperate
91 variables which are written in it.
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_ncdf_lec">
106
107          <h2><a class="top" href="#container">top</a>ncdf_lec <span class="categories">
108 Reading
109</span></h2>
110       
111          <p class="header">
112            <span class="result">result = </span>ncdf_lec(<span class="result"><a href="#_ncdf_lec_param_nom">nom</a></span>, <a href="#_ncdf_lec_keyword_ATT">ATT</a>=<span class="result">ATT</span>, <a href="#_ncdf_lec_keyword_DIM">DIM</a>=<span class="result">DIM</span>, <a href="#_ncdf_lec_keyword_VAR">VAR</a>=<span class="result">VAR</span>, <a href="#_ncdf_lec_keyword_IODIR">IODIR</a>=<span class="result">IODIR</span>, <a href="#_ncdf_lec_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
113       
114          <div class="comments">
115</div>
116
117          <h3>Return value</h3><div class="preformat">
118 -1 (except if var='nom de variable', then the function send back the variable).
119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_ncdf_lec_param_nom">nom&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126              <span class="attr">in</span>
127             
128             
129              <span class="attr">required</span>
130             
131             
132             
133             
134            </h4>
135       
136          <div class="comments">
137 Name of a file netcdf located in the directory stipulated by iodir.
138</div>
139           
140
141         
142
143         
144
145            <h3>Keywords</h3>
146           
147            <h4 id="_ncdf_lec_keyword_ATT">ATT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
148             
149             
150             
151             
152             
153             
154             
155             
156            </h4>
157       
158            <div class="comments">
159 'global' or the name of a variable. Allows to see all attributes
160 associated to variable
161</div>
162           
163            <h4 id="_ncdf_lec_keyword_DIM">DIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
164             
165             
166             
167             
168             
169             
170             
171             
172            </h4>
173       
174            <div class="comments">
175 Give the list of dimensions.
176</div>
177           
178            <h4 id="_ncdf_lec_keyword_VAR">VAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
179             
180             
181             
182             
183             
184             
185             
186             
187            </h4>
188       
189            <div class="comments">
190       1) /var: Give the list of dimensions.
191       2) var='name_of_a_variable': in this case the function send back the variable.
192</div>
193           
194            <h4 id="_ncdf_lec_keyword_IODIR">IODIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
195             
196             
197             
198             
199             
200             
201             
202             
203            </h4>
204       
205            <div class="comments">
206 String containing the directory containing the file to be read
207</div>
208           
209            <h4 id="_ncdf_lec_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
210             
211             
212             
213             
214             
215             
216             
217             
218            </h4>
219       
220            <div class="comments">
221 Used to pass keywords defined by IDL to functions NETCDF (especially OFFSET
222 and COUNT in <a href="/Applications/itt/idl64/help/online_help/NCDF_VARGET.html">NCDF_VARGET</a>)
223</div>
224           
225         
226
227         
228          <h3>Version history</h3>
229         
230          <h4>Version</h4><div class="preformat">
231 $Id: ncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $
232</div>
233          <h4>History</h4><div class="preformat">
234 Sebastien Masson (smasson@lodyc.jussieu.fr)
235                       4/1/98
236</div>
237         
238         
239          <h3>Known issues</h3>
240         
241         
242         
243          <h4>Restrictions</h4><div class="preformat">
244 Variables's names of the program are similar to these used by the IDL manual
245 'scientific data formats'
246</div>
247       
248         
249         
250         
251         
252         
253         
254         
255       
256          <h3>Statistics</h3>
257          <table class="statistics">
258            <tr><td>McCabe cyclic</td><td>          21</td></tr>
259            <tr><td>McCabe essential</td><td>           8</td></tr>
260            <tr><td>McCabe modular design</td><td>           1</td></tr>
261          </table>
262         
263       
264        </div>
265       
266      </div>
267
268     
269
270      <div id="tagline">Produced by IDLdoc 2.0.</div>
271
272    </div>
273
274  </body>
275</html>
Note: See TracBrowser for help on using the repository browser.