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>initncdf.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="initncdf.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?format=raw" title="Overview of library">Overview</a></td> |
---|
36 | |
---|
37 | |
---|
38 | |
---|
39 | <td >Directory</td> |
---|
40 | |
---|
41 | |
---|
42 | |
---|
43 | <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td> |
---|
44 | |
---|
45 | |
---|
46 | |
---|
47 | <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td> |
---|
48 | |
---|
49 | |
---|
50 | |
---|
51 | <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td> |
---|
52 | |
---|
53 | |
---|
54 | <td id="selected">File</td> |
---|
55 | |
---|
56 | |
---|
57 | <td >Source</td> |
---|
58 | |
---|
59 | |
---|
60 | |
---|
61 | <td><a href="./../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td> |
---|
62 | |
---|
63 | |
---|
64 | <td >Etc</td> |
---|
65 | |
---|
66 | <td id="flexible">Developer documentation</td> |
---|
67 | </tr> |
---|
68 | </table> |
---|
69 | |
---|
70 | </div> |
---|
71 | |
---|
72 | <div id="secondary_navbar"> |
---|
73 | |
---|
74 | << prev file | <a href="initncdfxxx.html">next file >></a> <a href="initncdf.html" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" target="_TOP">view frames</a> summary: fields | routine 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?format=raw">ToBeReviewed/INIT/</a></h1> |
---|
82 | <h2 class="pro_file">initncdf.pro</h2> |
---|
83 | |
---|
84 | <div id="file_attr"> |
---|
85 | <dl> |
---|
86 | </dl> |
---|
87 | </div> |
---|
88 | |
---|
89 | <div id="file_comments"></div> |
---|
90 | |
---|
91 | |
---|
92 | |
---|
93 | |
---|
94 | |
---|
95 | |
---|
96 | |
---|
97 | |
---|
98 | |
---|
99 | <div id="routine_details"> |
---|
100 | |
---|
101 | |
---|
102 | <div class="routine_details" id="_initncdf"> |
---|
103 | |
---|
104 | <h2><a class="top" href="#container">top</a>initncdf </h2> |
---|
105 | |
---|
106 | <p class="header"> |
---|
107 | initncdf<span class="result">, <a href="#_initncdf_param_ncfilein">ncfilein</a></span>, <a href="#_initncdf_keyword_XAXISNAME">XAXISNAME</a>=<span class="result">XAXISNAME</span>, <a href="#_initncdf_keyword_YAXISNAME">YAXISNAME</a>=<span class="result">YAXISNAME</span>, <a href="#_initncdf_keyword_ZAXISNAME">ZAXISNAME</a>=<span class="result">ZAXISNAME</span>, <a href="#_initncdf_keyword_MASKNAME">MASKNAME</a>=<span class="result">MASKNAME</span>, <a href="#_initncdf_keyword_INVMASK">INVMASK</a>=<span class="result">INVMASK</span>, <a href="#_initncdf_keyword_USEASMASK">USEASMASK</a>=<span class="result">USEASMASK</span>, <a href="#_initncdf_keyword_MISSING_VALUE">MISSING_VALUE</a>=<span class="result">MISSING_VALUE</span>, <a href="#_initncdf_keyword_START1">START1</a>=<span class="result">START1</span>, <a href="#_initncdf_keyword_XYINDEX">XYINDEX</a>=<span class="result">XYINDEX</span>, <a href="#_initncdf_keyword_ZINDEX">ZINDEX</a>=<span class="result">ZINDEX</span>, <a href="#_initncdf_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> |
---|
108 | |
---|
109 | <div class="comments"> |
---|
110 | NAME:initncdf |
---|
111 | |
---|
112 | PURPOSE:initfile for Netcdf file. define all the grid parameters |
---|
113 | |
---|
114 | CATEGORY: |
---|
115 | |
---|
116 | CALLING SEQUENCE:initncdf, ncfilename |
---|
117 | |
---|
118 | INPUTS:ncfilename: a string giving the name of the NetCdf file |
---|
119 | |
---|
120 | KEYWORD PARAMETERS: |
---|
121 | |
---|
122 | GLAMBOUNDARY:a 2 elements vector, {lon1,lon2], the longitute |
---|
123 | boundaries that should be used to visualize the data. |
---|
124 | lon2 > lon1 |
---|
125 | lon2 - lon1 le 360 |
---|
126 | key_shift will be defined according to GLAMBOUNDARY. |
---|
127 | |
---|
128 | /INVMASK: to inverse the mask: mask = 1-mask |
---|
129 | |
---|
130 | IODIRECTORY;a string giving the name of iodirectory (see |
---|
131 | isafile.pro for all possibilities). default value is common |
---|
132 | variable iodir |
---|
133 | |
---|
134 | MASKNAME: a string giving the name of the variable in the file |
---|
135 | that contains the land/sea mask |
---|
136 | |
---|
137 | MISSING_VALUE: to define (or redifine if the attribute is |
---|
138 | already existing) the missing values used with USEASMASK |
---|
139 | keyword |
---|
140 | |
---|
141 | /start1: index the axis from 1 instead of 0 when using |
---|
142 | /xyindex and/or zindex |
---|
143 | |
---|
144 | USEASMASK: a string giving the name of the variable in the file |
---|
145 | that will be used to build the land/sea mask. In this case the |
---|
146 | mask is based on the first record (if record dimension |
---|
147 | exists). The mask is build according to : |
---|
148 | 1 the keyword missing_value if existing |
---|
149 | 2 the attribute 'missing_value' if existing |
---|
150 | 3 NaN values if existing |
---|
151 | |
---|
152 | [XYZ]AXISNAME= a string giving the name of the variable in the file |
---|
153 | that contains the [xyz]axis. |
---|
154 | for X axis, default name must be 'x', 'longitude', 'nav_lon' or 'lon'. |
---|
155 | for Y axis, default name must be 'y', 'latitude', 'nav_lat' or 'lat'. |
---|
156 | for Z axis, default name must be 'z', 'level', 'lev', 'depth...' |
---|
157 | |
---|
158 | [XYZ]MINMESH: to define the common variables i[xyz]minmesh |
---|
159 | used to define the grid only in a zoomed part of the original |
---|
160 | grid. Defaut values are 0L |
---|
161 | |
---|
162 | [XYZ]MAXMESH: to define the common variables i[xyz]maxmesh |
---|
163 | used to define the grid only in a zoomed part of the original |
---|
164 | grid. Defaut values are jp[ijk]glo-1 |
---|
165 | |
---|
166 | /xyindex: to define the x/y axis with index instead of using |
---|
167 | the values contained in X/YAXISNAME. |
---|
168 | x/yaxis = keyword_set(start1) + findgen(jpi/jpj) |
---|
169 | this forces key_onearth = 0 |
---|
170 | |
---|
171 | /zindex: to define the z axis with index instead of using |
---|
172 | the values contained in ZAXISNAME. |
---|
173 | zaxis = keyword_set(start1) + findgen(jpk) |
---|
174 | |
---|
175 | OUTPUTS:none, except the grid parameters of the common.pro |
---|
176 | |
---|
177 | COMMON BLOCKS:common.pro |
---|
178 | |
---|
179 | SIDE EFFECTS:change the grid parameters of the common.pro |
---|
180 | |
---|
181 | RESTRICTIONS: |
---|
182 | the file must contain an x and an y axis. (1 ou 2 dimentional array) |
---|
183 | |
---|
184 | EXAMPLE: IDL> initncdf,'toto.nc',glam=[-180,180] |
---|
185 | </div> |
---|
186 | |
---|
187 | |
---|
188 | |
---|
189 | |
---|
190 | <h3>Parameters</h3> |
---|
191 | |
---|
192 | |
---|
193 | <h4 id="_initncdf_param_ncfilein">ncfilein |
---|
194 | |
---|
195 | |
---|
196 | |
---|
197 | |
---|
198 | |
---|
199 | |
---|
200 | |
---|
201 | |
---|
202 | </h4> |
---|
203 | |
---|
204 | <div class="comments"></div> |
---|
205 | |
---|
206 | |
---|
207 | |
---|
208 | |
---|
209 | |
---|
210 | |
---|
211 | <h3>Keywords</h3> |
---|
212 | |
---|
213 | <h4 id="_initncdf_keyword_XAXISNAME">XAXISNAME |
---|
214 | |
---|
215 | |
---|
216 | |
---|
217 | |
---|
218 | |
---|
219 | |
---|
220 | |
---|
221 | |
---|
222 | </h4> |
---|
223 | |
---|
224 | <div class="comments"></div> |
---|
225 | |
---|
226 | <h4 id="_initncdf_keyword_YAXISNAME">YAXISNAME |
---|
227 | |
---|
228 | |
---|
229 | |
---|
230 | |
---|
231 | |
---|
232 | |
---|
233 | |
---|
234 | |
---|
235 | </h4> |
---|
236 | |
---|
237 | <div class="comments"></div> |
---|
238 | |
---|
239 | <h4 id="_initncdf_keyword_ZAXISNAME">ZAXISNAME |
---|
240 | |
---|
241 | |
---|
242 | |
---|
243 | |
---|
244 | |
---|
245 | |
---|
246 | |
---|
247 | |
---|
248 | </h4> |
---|
249 | |
---|
250 | <div class="comments"></div> |
---|
251 | |
---|
252 | <h4 id="_initncdf_keyword_MASKNAME">MASKNAME |
---|
253 | |
---|
254 | |
---|
255 | |
---|
256 | |
---|
257 | |
---|
258 | |
---|
259 | |
---|
260 | |
---|
261 | </h4> |
---|
262 | |
---|
263 | <div class="comments"></div> |
---|
264 | |
---|
265 | <h4 id="_initncdf_keyword_INVMASK">INVMASK |
---|
266 | |
---|
267 | |
---|
268 | |
---|
269 | |
---|
270 | |
---|
271 | |
---|
272 | |
---|
273 | |
---|
274 | </h4> |
---|
275 | |
---|
276 | <div class="comments"></div> |
---|
277 | |
---|
278 | <h4 id="_initncdf_keyword_USEASMASK">USEASMASK |
---|
279 | |
---|
280 | |
---|
281 | |
---|
282 | |
---|
283 | |
---|
284 | |
---|
285 | |
---|
286 | |
---|
287 | </h4> |
---|
288 | |
---|
289 | <div class="comments"></div> |
---|
290 | |
---|
291 | <h4 id="_initncdf_keyword_MISSING_VALUE">MISSING_VALUE |
---|
292 | |
---|
293 | |
---|
294 | |
---|
295 | |
---|
296 | |
---|
297 | |
---|
298 | |
---|
299 | |
---|
300 | </h4> |
---|
301 | |
---|
302 | <div class="comments"></div> |
---|
303 | |
---|
304 | <h4 id="_initncdf_keyword_START1">START1 |
---|
305 | |
---|
306 | |
---|
307 | |
---|
308 | |
---|
309 | |
---|
310 | |
---|
311 | |
---|
312 | |
---|
313 | </h4> |
---|
314 | |
---|
315 | <div class="comments"></div> |
---|
316 | |
---|
317 | <h4 id="_initncdf_keyword_XYINDEX">XYINDEX |
---|
318 | |
---|
319 | |
---|
320 | |
---|
321 | |
---|
322 | |
---|
323 | |
---|
324 | |
---|
325 | |
---|
326 | </h4> |
---|
327 | |
---|
328 | <div class="comments"></div> |
---|
329 | |
---|
330 | <h4 id="_initncdf_keyword_ZINDEX">ZINDEX |
---|
331 | |
---|
332 | |
---|
333 | |
---|
334 | |
---|
335 | |
---|
336 | |
---|
337 | |
---|
338 | |
---|
339 | </h4> |
---|
340 | |
---|
341 | <div class="comments"></div> |
---|
342 | |
---|
343 | <h4 id="_initncdf_keyword__EXTRA">_EXTRA |
---|
344 | |
---|
345 | |
---|
346 | |
---|
347 | |
---|
348 | |
---|
349 | |
---|
350 | |
---|
351 | |
---|
352 | </h4> |
---|
353 | |
---|
354 | <div class="comments"></div> |
---|
355 | |
---|
356 | |
---|
357 | |
---|
358 | |
---|
359 | |
---|
360 | |
---|
361 | |
---|
362 | |
---|
363 | |
---|
364 | |
---|
365 | |
---|
366 | |
---|
367 | |
---|
368 | |
---|
369 | |
---|
370 | |
---|
371 | |
---|
372 | |
---|
373 | |
---|
374 | |
---|
375 | |
---|
376 | |
---|
377 | |
---|
378 | |
---|
379 | |
---|
380 | |
---|
381 | </div> |
---|
382 | |
---|
383 | </div> |
---|
384 | |
---|
385 | |
---|
386 | |
---|
387 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
388 | |
---|
389 | </div> |
---|
390 | |
---|
391 | </body> |
---|
392 | </html> |
---|