source: trunk/SRC/Documentation/idldoc_html_output/ReadWrite/write_ncdf.html

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

update documentation

File size: 28.4 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>write_ncdf.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="write_ncdf.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="../../../ReadWrite//write_ncdf.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="scanoasis.html">&lt;&lt;prev file</a> | <a href="write_oasis.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="write_ncdf.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>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ReadWrite/</a></h1>
82      <h2 class="pro_file">write_ncdf.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"> 
90 Construct a netcdf file containing up to 30 variables of any
91 dimension (limited to 99 for now) with any attributes specified.
92 We use structures to pass the fields (var and their attributes, and
93 global attr) 
94</div>
95
96     
97
98     
99
100     
101
102     
103      <div id="routine_summary">               
104        <h2>Routine summary</h2>
105       
106        <dl>
107         
108          <dt><p><a href="#_writenc_unlimdim_update">writenc_unlimdim_update<span class="result">, dnames_imposed, unl_imposed, fmtbase, nviv, iidp1st, nn, dst, iid</span>, SUPERTABU=<span class="result">SUPERTABU</span>, DIMSIZESU=<span class="result">DIMSIZESU</span>, UNLIMTABAU=<span class="result">UNLIMTABAU</span>, UNLIMAU=<span class="result">UNLIMAU</span>, DIMIDASU=<span class="result">DIMIDASU</span>, NDIMTOTU=<span class="result">NDIMTOTU</span>, DNAMOSSU=<span class="result">DNAMOSSU</span>, DNAMAU=<span class="result">DNAMAU</span>, IMPOSE_DNM_UNLU=<span class="result">IMPOSE_DNM_UNLU</span></a></p><dt>
109          <dd></dd>     
110         
111          <dt><p><a href="#_writenc_str2strlc"><span class="result">result = </span>writenc_str2strlc(<span class="result">structa</span>)</a></p><dt>
112          <dd>  SUBROUTINE (2)/(3) :    on remplace la 4ieme structure de structa par une liste chainee afin  d uniformaiser les format de strd (cf prog write_ncdf) pour les  passer facilement en argument au sous-prog writenc_unlimdim_update, sous forme de tablo de structures de  meme type !!!! (utilise si writenc_unlimdim_update est utilise i.</dd> 
113         
114          <dt><p><a href="#_writenc_strlc2str"><span class="result">result = </span>writenc_strlc2str(<span class="result">strwlist</span>)</a></p><dt>
115          <dd>   SUBROUTINE (3)/(3) :    convertit une structure contenant une liste  chainee en structure classique utilisee par le main prog (utile pour  passer ces structures en argument au sous-prog  writenc_unlimdim_update, i.</dd>   
116         
117          <dt><p><a href="#_write_ncdf">write_ncdf<span class="result">, var01[, var02], var03, var04, var05, var06, var07, var08, var09, var10, var11, var12, var13, var14, var15, var16, var17, var18, var19, var20, var21, var22, var23, var24, var25, var26, var27, var28, var29, var30</span>[, FILENAME=<span class="result">FILENAME</span>][, GLOBATTR=<span class="result">GLOBATTR</span>][, VARNAME=<span class="result">VARNAME</span>], NOT_SDISV=<span class="result">NOT_SDISV</span>, NOT_OUASSALU=<span class="result">NOT_OUASSALU</span>, OKNAN=<span class="result">OKNAN</span></a></p><dt>
118          <dd>     pro write_ncdf, var01,var02,var03,var04,var05,var06,var07,var08,var09,var10               $                  ,var11,var12,var13,var14,var15,var16,var17,var18,var19,var20               $                 ,var21,var22,var23,var24,var25,var26,var27,var28,var29,var30               $                 ,FILENAME=filename                                                         $                  ,GLOBATTR=globattr                                                         $                 ,VARNAME=namevquick   --------------------------------------------------------------------------------------------- </dd> 
119               
120        </dl>
121      </div>
122     
123
124      <div id="routine_details">
125       
126
127        <div class="routine_details" id="_writenc_unlimdim_update">
128
129          <h2><a class="top" href="#container">top</a>writenc_unlimdim_update </h2>
130       
131          <p class="header">
132            writenc_unlimdim_update<span class="result">, <a href="#_writenc_unlimdim_update_param_dnames_imposed">dnames_imposed</a>, <a href="#_writenc_unlimdim_update_param_unl_imposed">unl_imposed</a>, <a href="#_writenc_unlimdim_update_param_fmtbase">fmtbase</a>, <a href="#_writenc_unlimdim_update_param_nviv">nviv</a>, <a href="#_writenc_unlimdim_update_param_iidp1st">iidp1st</a>, <a href="#_writenc_unlimdim_update_param_nn">nn</a>, <a href="#_writenc_unlimdim_update_param_dst">dst</a>, <a href="#_writenc_unlimdim_update_param_iid">iid</a></span>, <a href="#_writenc_unlimdim_update_keyword_SUPERTABU">SUPERTABU</a>=<span class="result">SUPERTABU</span>, <a href="#_writenc_unlimdim_update_keyword_DIMSIZESU">DIMSIZESU</a>=<span class="result">DIMSIZESU</span>, <a href="#_writenc_unlimdim_update_keyword_UNLIMTABAU">UNLIMTABAU</a>=<span class="result">UNLIMTABAU</span>, <a href="#_writenc_unlimdim_update_keyword_UNLIMAU">UNLIMAU</a>=<span class="result">UNLIMAU</span>, <a href="#_writenc_unlimdim_update_keyword_DIMIDASU">DIMIDASU</a>=<span class="result">DIMIDASU</span>, <a href="#_writenc_unlimdim_update_keyword_NDIMTOTU">NDIMTOTU</a>=<span class="result">NDIMTOTU</span>, <a href="#_writenc_unlimdim_update_keyword_DNAMOSSU">DNAMOSSU</a>=<span class="result">DNAMOSSU</span>, <a href="#_writenc_unlimdim_update_keyword_DNAMAU">DNAMAU</a>=<span class="result">DNAMAU</span>, <a href="#_writenc_unlimdim_update_keyword_IMPOSE_DNM_UNLU">IMPOSE_DNM_UNLU</a>=<span class="result">IMPOSE_DNM_UNLU</span></p>
133       
134          <div class="comments"></div>
135
136         
137
138         
139            <h3>Parameters</h3>
140       
141           
142            <h4 id="_writenc_unlimdim_update_param_dnames_imposed">dnames_imposed&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143             
144             
145             
146             
147             
148             
149             
150             
151            </h4>
152       
153          <div class="comments"></div>
154           
155            <h4 id="_writenc_unlimdim_update_param_unl_imposed">unl_imposed&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
156             
157             
158             
159             
160             
161             
162             
163             
164            </h4>
165       
166          <div class="comments"></div>
167           
168            <h4 id="_writenc_unlimdim_update_param_fmtbase">fmtbase&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
169             
170             
171             
172             
173             
174             
175             
176             
177            </h4>
178       
179          <div class="comments"></div>
180           
181            <h4 id="_writenc_unlimdim_update_param_nviv">nviv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
182             
183             
184             
185             
186             
187             
188             
189             
190            </h4>
191       
192          <div class="comments"></div>
193           
194            <h4 id="_writenc_unlimdim_update_param_iidp1st">iidp1st&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
195             
196             
197             
198             
199             
200             
201             
202             
203            </h4>
204       
205          <div class="comments"></div>
206           
207            <h4 id="_writenc_unlimdim_update_param_nn">nn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
208             
209             
210             
211             
212             
213             
214             
215             
216            </h4>
217       
218          <div class="comments"></div>
219           
220            <h4 id="_writenc_unlimdim_update_param_dst">dst&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
221             
222             
223             
224             
225             
226             
227             
228             
229            </h4>
230       
231          <div class="comments"></div>
232           
233            <h4 id="_writenc_unlimdim_update_param_iid">iid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
234             
235             
236             
237             
238             
239             
240             
241             
242            </h4>
243       
244          <div class="comments"></div>
245           
246
247         
248
249         
250
251            <h3>Keywords</h3>
252           
253            <h4 id="_writenc_unlimdim_update_keyword_SUPERTABU">SUPERTABU&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
254             
255             
256             
257             
258             
259             
260             
261             
262            </h4>
263       
264            <div class="comments"></div>
265           
266            <h4 id="_writenc_unlimdim_update_keyword_DIMSIZESU">DIMSIZESU&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
267             
268             
269             
270             
271             
272             
273             
274             
275            </h4>
276       
277            <div class="comments"></div>
278           
279            <h4 id="_writenc_unlimdim_update_keyword_UNLIMTABAU">UNLIMTABAU&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
280             
281             
282             
283             
284             
285             
286             
287             
288            </h4>
289       
290            <div class="comments"></div>
291           
292            <h4 id="_writenc_unlimdim_update_keyword_UNLIMAU">UNLIMAU&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
293             
294             
295             
296             
297             
298             
299             
300             
301            </h4>
302       
303            <div class="comments"></div>
304           
305            <h4 id="_writenc_unlimdim_update_keyword_DIMIDASU">DIMIDASU&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
306             
307             
308             
309             
310             
311             
312             
313             
314            </h4>
315       
316            <div class="comments"></div>
317           
318            <h4 id="_writenc_unlimdim_update_keyword_NDIMTOTU">NDIMTOTU&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
319             
320             
321             
322             
323             
324             
325             
326             
327            </h4>
328       
329            <div class="comments"></div>
330           
331            <h4 id="_writenc_unlimdim_update_keyword_DNAMOSSU">DNAMOSSU&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
332             
333             
334             
335             
336             
337             
338             
339             
340            </h4>
341       
342            <div class="comments"></div>
343           
344            <h4 id="_writenc_unlimdim_update_keyword_DNAMAU">DNAMAU&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
345             
346             
347             
348             
349             
350             
351             
352             
353            </h4>
354       
355            <div class="comments"></div>
356           
357            <h4 id="_writenc_unlimdim_update_keyword_IMPOSE_DNM_UNLU">IMPOSE_DNM_UNLU&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
358             
359             
360             
361             
362             
363             
364             
365             
366            </h4>
367       
368            <div class="comments"></div>
369           
370         
371
372         
373         
374         
375         
376         
377         
378         
379         
380         
381         
382         
383         
384       
385         
386         
387         
388         
389         
390         
391         
392       
393          <h3>Statistics</h3>
394          <table class="statistics">
395            <tr><td>McCabe cyclic</td><td>          62</td></tr>
396            <tr><td>McCabe essential</td><td>           1</td></tr>
397            <tr><td>McCabe modular design</td><td>           1</td></tr>
398          </table>
399         
400       
401        </div>
402       
403
404        <div class="routine_details" id="_writenc_str2strlc">
405
406          <h2><a class="top" href="#container">top</a>writenc_str2strlc </h2>
407       
408          <p class="header">
409            <span class="result">result = </span>writenc_str2strlc(<span class="result"><a href="#_writenc_str2strlc_param_structa">structa</a></span>)</p>
410       
411          <div class="comments">
412 SUBROUTINE (2)/(3) :
413
414 on remplace la 4ieme structure de structa par une liste chainee afin
415 d uniformaiser les format de strd (cf prog write_ncdf) pour les
416 passer facilement en argument au sous-prog writenc_unlimdim_update, sous forme de tablo de structures de
417 meme type !!!! (utilise si writenc_unlimdim_update est utilise i.e. dans le cas ou la cle NOT_OUASSALU
418 est pas active, i.e. cas par defaut)
419</div>
420
421         
422
423         
424            <h3>Parameters</h3>
425       
426           
427            <h4 id="_writenc_str2strlc_param_structa">structa&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
428             
429             
430             
431             
432             
433             
434             
435             
436            </h4>
437       
438          <div class="comments"></div>
439           
440
441         
442
443         
444
445         
446         
447         
448         
449         
450         
451         
452         
453         
454         
455         
456         
457       
458         
459         
460         
461         
462         
463         
464         
465       
466          <h3>Statistics</h3>
467          <table class="statistics">
468            <tr><td>McCabe cyclic</td><td>           6</td></tr>
469            <tr><td>McCabe essential</td><td>           1</td></tr>
470            <tr><td>McCabe modular design</td><td>           1</td></tr>
471          </table>
472         
473       
474        </div>
475       
476
477        <div class="routine_details" id="_writenc_strlc2str">
478
479          <h2><a class="top" href="#container">top</a>writenc_strlc2str </h2>
480       
481          <p class="header">
482            <span class="result">result = </span>writenc_strlc2str(<span class="result"><a href="#_writenc_strlc2str_param_strwlist">strwlist</a></span>)</p>
483       
484          <div class="comments">
485
486 SUBROUTINE (3)/(3) :
487
488 convertit une structure contenant une liste
489 chainee en structure classique utilisee par le main prog (utile pour
490 passer ces structures en argument au sous-prog
491 writenc_unlimdim_update, i.e. dans le cas ou la cle NOT_OUASSALU n
492 est pas activee, i.e. cas par defaut)
493
494</div>
495
496         
497
498         
499            <h3>Parameters</h3>
500       
501           
502            <h4 id="_writenc_strlc2str_param_strwlist">strwlist&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
503             
504             
505             
506             
507             
508             
509             
510             
511            </h4>
512       
513          <div class="comments"></div>
514           
515
516         
517
518         
519
520         
521         
522         
523         
524         
525         
526         
527         
528         
529         
530         
531         
532       
533         
534         
535         
536         
537         
538         
539         
540       
541          <h3>Statistics</h3>
542          <table class="statistics">
543            <tr><td>McCabe cyclic</td><td>           4</td></tr>
544            <tr><td>McCabe essential</td><td>           1</td></tr>
545            <tr><td>McCabe modular design</td><td>           1</td></tr>
546          </table>
547         
548       
549        </div>
550       
551
552        <div class="routine_details" id="_write_ncdf">
553
554          <h2><a class="top" href="#container">top</a>write_ncdf </h2>
555       
556          <p class="header">
557            write_ncdf<span class="result">, <a href="#_write_ncdf_param_var01">var01</a>[, <a href="#_write_ncdf_param_var02">var02</a>], <a href="#_write_ncdf_param_var03">var03</a>, <a href="#_write_ncdf_param_var04">var04</a>, <a href="#_write_ncdf_param_var05">var05</a>, <a href="#_write_ncdf_param_var06">var06</a>, <a href="#_write_ncdf_param_var07">var07</a>, <a href="#_write_ncdf_param_var08">var08</a>, <a href="#_write_ncdf_param_var09">var09</a>, <a href="#_write_ncdf_param_var10">var10</a>, <a href="#_write_ncdf_param_var11">var11</a>, <a href="#_write_ncdf_param_var12">var12</a>, <a href="#_write_ncdf_param_var13">var13</a>, <a href="#_write_ncdf_param_var14">var14</a>, <a href="#_write_ncdf_param_var15">var15</a>, <a href="#_write_ncdf_param_var16">var16</a>, <a href="#_write_ncdf_param_var17">var17</a>, <a href="#_write_ncdf_param_var18">var18</a>, <a href="#_write_ncdf_param_var19">var19</a>, <a href="#_write_ncdf_param_var20">var20</a>, <a href="#_write_ncdf_param_var21">var21</a>, <a href="#_write_ncdf_param_var22">var22</a>, <a href="#_write_ncdf_param_var23">var23</a>, <a href="#_write_ncdf_param_var24">var24</a>, <a href="#_write_ncdf_param_var25">var25</a>, <a href="#_write_ncdf_param_var26">var26</a>, <a href="#_write_ncdf_param_var27">var27</a>, <a href="#_write_ncdf_param_var28">var28</a>, <a href="#_write_ncdf_param_var29">var29</a>, <a href="#_write_ncdf_param_var30">var30</a></span>[, <a href="#_write_ncdf_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>][, <a href="#_write_ncdf_keyword_GLOBATTR">GLOBATTR</a>=<span class="result">GLOBATTR</span>][, <a href="#_write_ncdf_keyword_VARNAME">VARNAME</a>=<span class="result">VARNAME</span>], <a href="#_write_ncdf_keyword_NOT_SDISV">NOT_SDISV</a>=<span class="result">NOT_SDISV</span>, <a href="#_write_ncdf_keyword_NOT_OUASSALU">NOT_OUASSALU</a>=<span class="result">NOT_OUASSALU</span>, <a href="#_write_ncdf_keyword_OKNAN">OKNAN</a>=<span class="result">OKNAN</span></p>
558       
559          <div class="comments">
560
561 
562 pro write_ncdf, var01,var02,var03,var04,var05,var06,var07,var08,var09,var10               $
563                ,var11,var12,var13,var14,var15,var16,var17,var18,var19,var20               $
564                ,var21,var22,var23,var24,var25,var26,var27,var28,var29,var30               $
565                ,FILENAME=filename                                                         $
566                ,GLOBATTR=globattr                                                         $
567                ,VARNAME=namevquick
568
569 ---------------------------------------------------------------------------------------------
570</div>
571
572          <h3>Return value</h3><div class="preformat">
573 a netcdf file containing the variable in the format specified
574 through keywords and variables
575</div>
576
577         
578            <h3>Parameters</h3>
579       
580           
581            <h4 id="_write_ncdf_param_var01">var01&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
582              <span class="attr">in</span>
583             
584             
585              <span class="attr">required</span>
586             
587             
588             
589             
590            </h4>
591       
592          <div class="comments">}
593     Namely, the if vv1 is a structure it MUST follow the following points:
594       - attributes fields for the variable (at0,at1...) MUST be the last fields of the vv1 structure
595         and name of those fields (at0,at1...) are not important.
596       - attributes MUST themselves be given in the form of a 2 field structure, containing the
597         name of the attribute (a string), and its value (can be any type as the ones of variable)
598       - order of the first fields is not important but they MUST have the names:
599           'var'      : for the variable (scalar or array, of type:byte,int,long,float,double or string)
600           'name'     : for its name (a string), default value is var01,var02 etc...
601           'unlim'    : = 1 to specify that the last dim of the var must be UNLIMITED, =0 or not specified otherwise
602           'dname'    : to give the names of the dimensions of the variable, in the same order as the var dimensions.
603                        it is an array of string of dim = nbre de dim de la var. default is d01,d02 etc...
604       - the field 'var' MUST be there (a variable) but every others are optional
605       - if a missing value exists for the variable and one wants to specify it, it MUST be specified
606         somewhere in one of the attributes and the name of this attribute MUST be 'missing_value' (to be taken
607         into account in the computing of the min-max of the variable), missing_value being not case sensitive
608         (MISSING_VALUE is also ok)
609</div>
610           
611            <h4 id="_write_ncdf_param_var02">var02&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
612              <span class="attr">in</span>
613             
614              <span class="attr">optional</span>
615             
616             
617             
618             
619             
620            </h4>
621       
622          <div class="comments"> 
623 All the variables/attributes to be written in the netcdf file, in
624 the same way as the var01 (cf info above)
625</div>
626           
627            <h4 id="_write_ncdf_param_var03">var03&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
628             
629             
630             
631             
632             
633             
634             
635             
636            </h4>
637       
638          <div class="comments"></div>
639           
640            <h4 id="_write_ncdf_param_var04">var04&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
641             
642             
643             
644             
645             
646             
647             
648             
649            </h4>
650       
651          <div class="comments"></div>
652           
653            <h4 id="_write_ncdf_param_var05">var05&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
654             
655             
656             
657             
658             
659             
660             
661             
662            </h4>
663       
664          <div class="comments"></div>
665           
666            <h4 id="_write_ncdf_param_var06">var06&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
667             
668             
669             
670             
671             
672             
673             
674             
675            </h4>
676       
677          <div class="comments"></div>
678           
679            <h4 id="_write_ncdf_param_var07">var07&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
680             
681             
682             
683             
684             
685             
686             
687             
688            </h4>
689       
690          <div class="comments"></div>
691           
692            <h4 id="_write_ncdf_param_var08">var08&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
693             
694             
695             
696             
697             
698             
699             
700             
701            </h4>
702       
703          <div class="comments"></div>
704           
705            <h4 id="_write_ncdf_param_var09">var09&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
706             
707             
708             
709             
710             
711             
712             
713             
714            </h4>
715       
716          <div class="comments"></div>
717           
718            <h4 id="_write_ncdf_param_var10">var10&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
719             
720             
721             
722             
723             
724             
725             
726             
727            </h4>
728       
729          <div class="comments"></div>
730           
731            <h4 id="_write_ncdf_param_var11">var11&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
732             
733             
734             
735             
736             
737             
738             
739             
740            </h4>
741       
742          <div class="comments"></div>
743           
744            <h4 id="_write_ncdf_param_var12">var12&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
745             
746             
747             
748             
749             
750             
751             
752             
753            </h4>
754       
755          <div class="comments"></div>
756           
757            <h4 id="_write_ncdf_param_var13">var13&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
758             
759             
760             
761             
762             
763             
764             
765             
766            </h4>
767       
768          <div class="comments"></div>
769           
770            <h4 id="_write_ncdf_param_var14">var14&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
771             
772             
773             
774             
775             
776             
777             
778             
779            </h4>
780       
781          <div class="comments"></div>
782           
783            <h4 id="_write_ncdf_param_var15">var15&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
784             
785             
786             
787             
788             
789             
790             
791             
792            </h4>
793       
794          <div class="comments"></div>
795           
796            <h4 id="_write_ncdf_param_var16">var16&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
797             
798             
799             
800             
801             
802             
803             
804             
805            </h4>
806       
807          <div class="comments"></div>
808           
809            <h4 id="_write_ncdf_param_var17">var17&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
810             
811             
812             
813             
814             
815             
816             
817             
818            </h4>
819       
820          <div class="comments"></div>
821           
822            <h4 id="_write_ncdf_param_var18">var18&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
823             
824             
825             
826             
827             
828             
829             
830             
831            </h4>
832       
833          <div class="comments"></div>
834           
835            <h4 id="_write_ncdf_param_var19">var19&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
836             
837             
838             
839             
840             
841             
842             
843             
844            </h4>
845       
846          <div class="comments"></div>
847           
848            <h4 id="_write_ncdf_param_var20">var20&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
849             
850             
851             
852             
853             
854             
855             
856             
857            </h4>
858       
859          <div class="comments"></div>
860           
861            <h4 id="_write_ncdf_param_var21">var21&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
862             
863             
864             
865             
866             
867             
868             
869             
870            </h4>
871       
872          <div class="comments"></div>
873           
874            <h4 id="_write_ncdf_param_var22">var22&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
875             
876             
877             
878             
879             
880             
881             
882             
883            </h4>
884       
885          <div class="comments"></div>
886           
887            <h4 id="_write_ncdf_param_var23">var23&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
888             
889             
890             
891             
892             
893             
894             
895             
896            </h4>
897       
898          <div class="comments"></div>
899           
900            <h4 id="_write_ncdf_param_var24">var24&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
901             
902             
903             
904             
905             
906             
907             
908             
909            </h4>
910       
911          <div class="comments"></div>
912           
913            <h4 id="_write_ncdf_param_var25">var25&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
914             
915             
916             
917             
918             
919             
920             
921             
922            </h4>
923       
924          <div class="comments"></div>
925           
926            <h4 id="_write_ncdf_param_var26">var26&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
927             
928             
929             
930             
931             
932             
933             
934             
935            </h4>
936       
937          <div class="comments"></div>
938           
939            <h4 id="_write_ncdf_param_var27">var27&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
940             
941             
942             
943             
944             
945             
946             
947             
948            </h4>
949       
950          <div class="comments"></div>
951           
952            <h4 id="_write_ncdf_param_var28">var28&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
953             
954             
955             
956             
957             
958             
959             
960             
961            </h4>
962       
963          <div class="comments"></div>
964           
965            <h4 id="_write_ncdf_param_var29">var29&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
966             
967             
968             
969             
970             
971             
972             
973             
974            </h4>
975       
976          <div class="comments"></div>
977           
978            <h4 id="_write_ncdf_param_var30">var30&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
979             
980             
981             
982             
983             
984             
985             
986             
987            </h4>
988       
989          <div class="comments"></div>
990           
991
992         
993
994         
995
996            <h3>Keywords</h3>
997           
998            <h4 id="_write_ncdf_keyword_FILENAME">FILENAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
999              <span class="attr">in</span>
1000             
1001              <span class="attr">optional</span>
1002             
1003             
1004             
1005             
1006             
1007            </h4>
1008       
1009            <div class="comments"> 
1010  - a string giving the filename (including the path of the file)
1011  - if not specified, it is set to iodir+'writenclem.nc'
1012</div>
1013           
1014            <h4 id="_write_ncdf_keyword_GLOBATTR">GLOBATTR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
1015              <span class="attr">in</span>
1016             
1017              <span class="attr">optional</span>
1018             
1019             
1020             
1021             
1022             
1023            </h4>
1024       
1025            <div class="comments">}   
1026  - if not specified in globattr, default case set production='date of
1027    day' as a global attribute
1028</div>
1029           
1030            <h4 id="_write_ncdf_keyword_VARNAME">VARNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
1031              <span class="attr">in</span>
1032             
1033              <span class="attr">optional</span>
1034             
1035             
1036             
1037             
1038             
1039            </h4>
1040       
1041            <div class="comments"> 
1042  - an array of char, same number of elements as the number of given
1043    var
1044  - if specified, it gives the names of the variables as an array for
1045    the default name values (if one of the var is structure and also has
1046    the name field given, then the latter will be the one chosen and not namevquick)
1047</div>
1048           
1049            <h4 id="_write_ncdf_keyword_NOT_SDISV">NOT_SDISV&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
1050             
1051             
1052             
1053             
1054             
1055             
1056             
1057             
1058            </h4>
1059       
1060            <div class="comments"></div>
1061           
1062            <h4 id="_write_ncdf_keyword_NOT_OUASSALU">NOT_OUASSALU&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
1063             
1064             
1065             
1066             
1067             
1068             
1069             
1070             
1071            </h4>
1072       
1073            <div class="comments"></div>
1074           
1075            <h4 id="_write_ncdf_keyword_OKNAN">OKNAN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
1076             
1077             
1078             
1079             
1080             
1081             
1082             
1083             
1084            </h4>
1085       
1086            <div class="comments"></div>
1087           
1088         
1089
1090          <h3>Examples</h3><div class="preformat">
1091
1092 1)
1093   IDL> write_ncdf, vvsst, btoa
1094
1095 2)
1096   IDL> write_ncdf, a1, {var:a2,name:'rain'}, ['up','down','fix'], a4, a5, {var:a6,unlim:1,name:'sst',dname:['x','y','z','time']}
1097
1098 3)
1099   IDL> write_ncdf,v031tr,msf031dn,msf031up,v031,vmaskloc,btoa,runame,titplo1,vargrid,nytt                                    $
1100           ,varname = ['v031tr','msf031dn','msf031up','v031','vmaskloc','btoa','runame','titplo1','vargrid','nytt'] $
1101           ,filename = iodir+'IDL_DATA/'+'waza3.nc'
1102
1103 4)
1104   IDL> fileoutnc = iodir+'OBS/TRMM/'+'trmm_1d_'+iyystr+'0101_'+iyystr+'1231_reg0.25.nc'
1105   IDL> vv1 = {var:xaxis,name:'nav_lon',dname:'x',at1:{a:'units',b:'degrees_east'},at2:{a:'title',b:'longitude'}}
1106   IDL> vv2 = {var:yaxis,name:'nav_lat',dname:'y',at1:{a:'units',b:'degrees_north'},at2:{a:'title',b:'latitude'}}
1107   IDL> vv3 = {var:ttt,name:'time',dname:'time_counter',unlim:1,at1:{a:'units',b:timeunit},at2:{a:'title',b:'julian days'}  $
1108   IDL> vv4 = {var:rain_i2, name:'rain' $
1109        ,at1:{a:'units',b:'mm/day'} $
1110        ,at2:{a:'title',b:'trmm daily accumulated rainfall derived from the 3-hourly product (mm)'}  $
1111        ,at3:{a:'scale_factor',b:scala_factor} $
1112        ,at4:{a:'add_offset',b:adda_offset}    $
1113        ,at5:{a:'missing_value',b:missaval_i2} $
1114       }
1115   IDL> glbatt={  gb1:{a:'File_Name', b:'trmm_1d_'+iyystr+'0101_'+iyystr+'1231_reg0.25.nc'} $
1116          ,gb2:{a:'Model_Name', b:'TRMM 3B42_V6 derived product'} $
1117          ,gb3:{a:'Source_File',b:'ftp://disc2.nascom.nasa.gov/data/TRMM/Gridded/Derived_Products/3B42_V6/Daily/'+iyystr+'/*.bin'} $</div>
1118          <h3>Version history</h3>
1119         
1120         
1121          <h4>History</h4><div class="preformat"> 
1122 CBM 2007-09-10
1123 </div>
1124         
1125         
1126          <h3>Known issues</h3>
1127         
1128         
1129          <h4>Todo items</h4><div class="preformat"> 
1130 clem
1131</div>
1132         
1133       
1134          <h3>Other attributes</h3>
1135         
1136         
1137          <h4>Uses routines</h4><div class="preformat">
1138 <a href="..//Commons/cm_general.html">cm_general</a> for iodir variable
1139</div>
1140         
1141         
1142         
1143       
1144          <h3>Statistics</h3>
1145          <table class="statistics">
1146            <tr><td>McCabe cyclic</td><td>         168</td></tr>
1147            <tr><td>McCabe essential</td><td>          11</td></tr>
1148            <tr><td>McCabe modular design</td><td>           1</td></tr>
1149          </table>
1150         
1151       
1152        </div>
1153       
1154      </div>
1155
1156     
1157
1158      <div id="tagline">Produced by IDLdoc 2.0.</div>
1159
1160    </div>
1161
1162  </body>
1163</html>
Note: See TracBrowser for help on using the repository browser.