1 | |
---|
2 | |
---|
3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
---|
4 | <head> |
---|
5 | <title>ncdf_getatt.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=""><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="ncdf_getaxis.html"><img src="./../next.gif" border="0" alt="Next"></a></td> |
---|
53 | </tr> |
---|
54 | </table> |
---|
55 | |
---|
56 | |
---|
57 | <h1><font size="-2">ReadWrite/</font></h1> |
---|
58 | <h2>ncdf_getatt.pro</h2> |
---|
59 | |
---|
60 | <dl> |
---|
61 | </dl> |
---|
62 | |
---|
63 | |
---|
64 | Get variable attibutes from a NetCDF file |
---|
65 | |
---|
66 | |
---|
67 | |
---|
68 | |
---|
69 | |
---|
70 | <a name="#_ncdf_getatt"></a> |
---|
71 | |
---|
72 | <h2>ncdf_getatt <font size="-1" color="#006633"> |
---|
73 | Read NetCDF file |
---|
74 | </font></h2> |
---|
75 | |
---|
76 | <p><font face="Courier">ncdf_getatt<i>, <a href="#_ncdf_getatt_keyword_fileid">fileid</a>, <a href="#_ncdf_getatt_keyword_varid">varid</a></i>, <a href="#_ncdf_getatt_keyword_ADD_OFFSET">ADD_OFFSET</a>=<i>ADD_OFFSET</i>, <a href="#_ncdf_getatt_keyword_SCALE_FACTOR">SCALE_FACTOR</a>=<i>SCALE_FACTOR</i>, <a href="#_ncdf_getatt_keyword_MISSING_VALUE">MISSING_VALUE</a>=<i>MISSING_VALUE</i>, <a href="#_ncdf_getatt_keyword_UNITS">UNITS</a>=<i>UNITS</i>, <a href="#_ncdf_getatt_keyword_CALENDAR">CALENDAR</a>=<i>CALENDAR</i>, <a href="#_ncdf_getatt_keyword_LONG_NAME">LONG_NAME</a>=<i>LONG_NAME</i>, <a href="#_ncdf_getatt_keyword_STANDARD_NAME">STANDARD_NAME</a>=<i>STANDARD_NAME</i>, <a href="#_ncdf_getatt_keyword_DOUBLE">DOUBLE</a>=<i>1 or 0</i>, <a href="#_ncdf_getatt_keyword__extra">_extra</a>=<i>_extra</i></font></p> |
---|
77 | |
---|
78 | |
---|
79 | |
---|
80 | |
---|
81 | |
---|
82 | |
---|
83 | |
---|
84 | <h3>Parameters</h3> |
---|
85 | |
---|
86 | |
---|
87 | <a name="#_ncdf_getatt_keyword_fileid"></a> |
---|
88 | <h4>fileid |
---|
89 | <font size="-1" color="#006633">in</font> |
---|
90 | |
---|
91 | |
---|
92 | <font size="-1" color="#006633">required</font> |
---|
93 | |
---|
94 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>salar string or long</i></font> |
---|
95 | |
---|
96 | |
---|
97 | </h4> |
---|
98 | |
---|
99 | |
---|
100 | if fileid is a scalar string then it is the name of the file (with |
---|
101 | the full path) to be opened (in that case, the file will be opened |
---|
102 | and closed within ncdf_getatt). |
---|
103 | if fileid is a scalar long then it is the id of the file return by a call |
---|
104 | to ncdf_open outside of ncdf_getatt (in that case, the file will |
---|
105 | NOT be opened and closed within ncdf_getatt) |
---|
106 | |
---|
107 | |
---|
108 | |
---|
109 | <a name="#_ncdf_getatt_keyword_varid"></a> |
---|
110 | <h4>varid |
---|
111 | <font size="-1" color="#006633">in</font> |
---|
112 | |
---|
113 | |
---|
114 | <font size="-1" color="#006633">required</font> |
---|
115 | |
---|
116 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>salar string or long</i></font> |
---|
117 | |
---|
118 | |
---|
119 | </h4> |
---|
120 | |
---|
121 | |
---|
122 | The netCDF variable ID, returned from a previous call to NCDF_VARDEF |
---|
123 | or NCDF_VARID, or the name of the variable. |
---|
124 | |
---|
125 | |
---|
126 | |
---|
127 | |
---|
128 | |
---|
129 | <h3>Keywords</h3> |
---|
130 | |
---|
131 | |
---|
132 | <a name="#_ncdf_getatt_keyword_ADD_OFFSET"></a> |
---|
133 | <h4>ADD_OFFSET |
---|
134 | |
---|
135 | |
---|
136 | |
---|
137 | |
---|
138 | |
---|
139 | |
---|
140 | |
---|
141 | |
---|
142 | </h4> |
---|
143 | |
---|
144 | |
---|
145 | Set this keyword to a named variable in which the value of |
---|
146 | add_offset attribute is returned. Return 0. if this attribute |
---|
147 | doesn't exist. |
---|
148 | |
---|
149 | |
---|
150 | <a name="#_ncdf_getatt_keyword_SCALE_FACTOR"></a> |
---|
151 | <h4>SCALE_FACTOR |
---|
152 | |
---|
153 | |
---|
154 | |
---|
155 | |
---|
156 | |
---|
157 | |
---|
158 | |
---|
159 | |
---|
160 | </h4> |
---|
161 | |
---|
162 | |
---|
163 | Set this keyword to a named variable in which the value of |
---|
164 | scale_factor attribute is returned. Return 0. if this attribute |
---|
165 | doesn't exist. |
---|
166 | |
---|
167 | |
---|
168 | <a name="#_ncdf_getatt_keyword_MISSING_VALUE"></a> |
---|
169 | <h4>MISSING_VALUE |
---|
170 | |
---|
171 | |
---|
172 | |
---|
173 | |
---|
174 | |
---|
175 | |
---|
176 | |
---|
177 | |
---|
178 | </h4> |
---|
179 | |
---|
180 | |
---|
181 | Set this keyword to a named variable in which the value of |
---|
182 | missing_value or _fillvalue attribute is returned. Return the scalar |
---|
183 | 'no' if this attribute doesn't exist. |
---|
184 | |
---|
185 | |
---|
186 | <a name="#_ncdf_getatt_keyword_UNITS"></a> |
---|
187 | <h4>UNITS |
---|
188 | |
---|
189 | |
---|
190 | |
---|
191 | |
---|
192 | |
---|
193 | |
---|
194 | |
---|
195 | |
---|
196 | </h4> |
---|
197 | |
---|
198 | |
---|
199 | Set this keyword to a named variable in which the value of |
---|
200 | units attribute is returned. Return the empty string '' if this attribute |
---|
201 | doesn't exist. |
---|
202 | |
---|
203 | |
---|
204 | <a name="#_ncdf_getatt_keyword_CALENDAR"></a> |
---|
205 | <h4>CALENDAR |
---|
206 | |
---|
207 | |
---|
208 | |
---|
209 | |
---|
210 | |
---|
211 | |
---|
212 | |
---|
213 | |
---|
214 | </h4> |
---|
215 | |
---|
216 | |
---|
217 | Set this keyword to a named variable in which the value of |
---|
218 | calendar attribute is returned. Return the string 'greg' if this attribute |
---|
219 | doesn't exist. |
---|
220 | |
---|
221 | |
---|
222 | <a name="#_ncdf_getatt_keyword_LONG_NAME"></a> |
---|
223 | <h4>LONG_NAME |
---|
224 | |
---|
225 | |
---|
226 | |
---|
227 | |
---|
228 | |
---|
229 | |
---|
230 | |
---|
231 | |
---|
232 | </h4> |
---|
233 | |
---|
234 | |
---|
235 | Set this keyword to a named variable in which the value of |
---|
236 | long_name is returned. Return empty string if this attribute |
---|
237 | does not exist. |
---|
238 | |
---|
239 | |
---|
240 | <a name="#_ncdf_getatt_keyword_STANDARD_NAME"></a> |
---|
241 | <h4>STANDARD_NAME |
---|
242 | |
---|
243 | |
---|
244 | |
---|
245 | |
---|
246 | |
---|
247 | |
---|
248 | |
---|
249 | |
---|
250 | </h4> |
---|
251 | |
---|
252 | |
---|
253 | Set this keyword to a named variable in which the value of |
---|
254 | standard_name (CF convention) is returned. Return empty string |
---|
255 | if this attribute does not exist. |
---|
256 | |
---|
257 | |
---|
258 | <a name="#_ncdf_getatt_keyword_DOUBLE"></a> |
---|
259 | <h4>DOUBLE |
---|
260 | |
---|
261 | |
---|
262 | |
---|
263 | |
---|
264 | |
---|
265 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1 or 0</i></font> |
---|
266 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> |
---|
267 | |
---|
268 | </h4> |
---|
269 | |
---|
270 | |
---|
271 | activate to force double-precision floating-point value of |
---|
272 | add_offset and scale_factor |
---|
273 | |
---|
274 | |
---|
275 | <a name="#_ncdf_getatt_keyword__extra"></a> |
---|
276 | <h4>_extra |
---|
277 | |
---|
278 | |
---|
279 | |
---|
280 | |
---|
281 | |
---|
282 | |
---|
283 | |
---|
284 | |
---|
285 | </h4> |
---|
286 | |
---|
287 | |
---|
288 | defined only to be able to call <a href="..//ReadWrite/ncdf_getatt.html">ncdf_getatt</a> with the |
---|
289 | _EXTRA keyword |
---|
290 | |
---|
291 | |
---|
292 | |
---|
293 | |
---|
294 | <h3>Examples</h3><pre> |
---|
295 | |
---|
296 | IDL> ncdf_getatt, cdfid, 'sst', add_offset = add_offset, scale_factor = scale_factor, units = units |
---|
297 | |
---|
298 | </pre><h3>Version history</h3> |
---|
299 | |
---|
300 | <h4>Version</h4> |
---|
301 | $Id: ncdf_getatt.pro 396 2009-04-08 16:14:31Z smasson $ |
---|
302 | |
---|
303 | <h4>History</h4> |
---|
304 | August 2007: Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
305 | |
---|
306 | |
---|
307 | |
---|
308 | |
---|
309 | |
---|
310 | |
---|
311 | |
---|
312 | |
---|
313 | |
---|
314 | |
---|
315 | |
---|
316 | |
---|
317 | |
---|
318 | |
---|
319 | |
---|
320 | |
---|
321 | |
---|
322 | <font size="-3"><p> </p></font> |
---|
323 | <hr size="1" color="#CCCCCC"/> |
---|
324 | |
---|
325 | |
---|
326 | |
---|
327 | |
---|
328 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
---|
329 | |
---|
330 | </body> |
---|
331 | </html> |
---|