source: trunk/SRC/Documentation/idldoc_assistant_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: 4.6 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>ncdf_lec.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="litchamp.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="read_ftp.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/LECTURE/</font></h1>
58    <h2>ncdf_lec.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Give informations on a file netcdf and allows to recuperate
65 variables which are written in it.
66
67
68   
69
70     
71      <a name="#_ncdf_lec"></a>
72
73      <h2>ncdf_lec  <font size="-1" color="#006633">
74 Reading
75</font></h2>
76
77      <p><font face="Courier"><i>result = </i>ncdf_lec(<i><a href="#_ncdf_lec_keyword_nom">nom</a></i>, <a href="#_ncdf_lec_keyword_ATT">ATT</a>=<i>ATT</i>, <a href="#_ncdf_lec_keyword_DIM">DIM</a>=<i>DIM</i>, <a href="#_ncdf_lec_keyword_VAR">VAR</a>=<i>VAR</i>, <a href="#_ncdf_lec_keyword_IODIR">IODIR</a>=<i>IODIR</i>, <a href="#_ncdf_lec_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
78
79   
80
81
82    <h3>Return value</h3>
83 -1 (except if var='nom de variable', then the function send back the variable).
84
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_ncdf_lec_keyword_nom"></a>
91    <h4>nom&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
92      <font size="-1" color="#006633">in</font>
93     
94     
95      <font size="-1" color="#006633">required</font>
96     
97     
98     
99     
100    </h4>
101
102   
103 Name of a file netcdf located in the directory stipulated by iodir.
104
105   
106   
107
108   
109    <h3>Keywords</h3>
110
111   
112    <a name="#_ncdf_lec_keyword_ATT"></a>
113    <h4>ATT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
114     
115     
116     
117     
118     
119     
120     
121     
122    </h4>
123
124   
125 'global' or the name of a variable. Allows to see all attributes
126 associated to variable
127
128   
129    <a name="#_ncdf_lec_keyword_DIM"></a>
130    <h4>DIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
131     
132     
133     
134     
135     
136     
137     
138     
139    </h4>
140
141   
142 Give the list of dimensions.
143
144   
145    <a name="#_ncdf_lec_keyword_VAR"></a>
146    <h4>VAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147     
148     
149     
150     
151     
152     
153     
154     
155    </h4>
156
157   
158       1) /var: Give the list of dimensions.
159       2) var='name_of_a_variable': in this case the function send back the variable.
160
161   
162    <a name="#_ncdf_lec_keyword_IODIR"></a>
163    <h4>IODIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
164     
165     
166     
167     
168     
169     
170     
171     
172    </h4>
173
174   
175 String containing the directory containing the file to be read
176
177   
178    <a name="#_ncdf_lec_keyword__EXTRA"></a>
179    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
180     
181     
182     
183     
184     
185     
186     
187     
188    </h4>
189
190   
191 Used to pass keywords defined by IDL to functions NETCDF (especially OFFSET
192 and COUNT in <a href="/Applications/itt/idl64/help/online_help/NCDF_VARGET.html">NCDF_VARGET</a>)
193
194   
195   
196
197   
198    </pre><h3>Version history</h3>
199   
200    <h4>Version</h4>
201 $Id: ncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $
202
203    <h4>History</h4>
204 Sebastien Masson (smasson@lodyc.jussieu.fr)
205                       4/1/98
206
207   
208
209    <h3>Known issues</h3>
210   
211   
212   
213    <h4>Restrictions</h4>
214 Variables's names of the program are similar to these used by the IDL manual
215 'scientific data formats'
216
217
218   
219   
220   
221   
222   
223   
224   
225
226    <font size="-3"><p>&nbsp;</p></font>
227    <hr size="1" color="#CCCCCC"/>
228     
229
230   
231
232    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
233
234  </body>
235</html>
Note: See TracBrowser for help on using the repository browser.