Changeset 402 for trunk/SRC/Documentation/idldoc_html_output/ReadWrite/write_ncdf.html

Timestamp:

07/23/09 11:18:49 (15 years ago)

Author:

smasson

Message:

update documentation

File:

• trunk/SRC/Documentation/idldoc_html_output/ReadWrite/write_ncdf.html (modified) (10 diffs)

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

@@ -115 +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>    
           
-          <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>
+          <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>
           <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>  
                 
@@ -555 +555 @@
         
           <p class="header">
-            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>
+            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>
         
           <div class="comments">
@@ -570 +570 @@
 </div>
 
-          
+          <h3>Return value</h3><div class="preformat">
+ a netcdf file containing the variable in the format specified
+ through keywords and variables 
+</div>
 
           
@@ -1026 +1029 @@
             
             <h4 id="_write_ncdf_keyword_VARNAME">VARNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              <span class="attr">in</span>
+              
+              <span class="attr">optional</span>
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments"> 
+  - an array of char, same number of elements as the number of given
+    var
+  - if specified, it gives the names of the variables as an array for
+    the default name values (if one of the var is structure and also has
+    the name field given, then the latter will be the one chosen and not namevquick)
+</div>
+            
+            <h4 id="_write_ncdf_keyword_NOT_SDISV">NOT_SDISV&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
               
               
@@ -1038 +1060 @@
             <div class="comments"></div>
             
-            <h4 id="_write_ncdf_keyword_NOT_SDISV">NOT_SDISV&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+            <h4 id="_write_ncdf_keyword_NOT_OUASSALU">NOT_OUASSALU&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
               
               
@@ -1051 +1073 @@
             <div class="comments"></div>
             
-            <h4 id="_write_ncdf_keyword_NOT_OUASSALU">NOT_OUASSALU&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+            <h4 id="_write_ncdf_keyword_OKNAN">OKNAN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
               
               
@@ -1064 +1086 @@
             <div class="comments"></div>
             
-            <h4 id="_write_ncdf_keyword_OKNAN">OKNAN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-            <div class="comments"></div>
-            
           
 
@@ -1082 +1091 @@
 
  1)
- write_ncdf, vvsst, btoa
+   IDL> write_ncdf, vvsst, btoa
 
  2)
- write_ncdf, a1, {var:a2,name:'rain'}, ['up','down','fix'], a4, a5, {var:a6,unlim:1,name:'sst',dname:['x','y','z','time']}
+   IDL> write_ncdf, a1, {var:a2,name:'rain'}, ['up','down','fix'], a4, a5, {var:a6,unlim:1,name:'sst',dname:['x','y','z','time']}
 
  3)
- write_ncdf,v031tr,msf031dn,msf031up,v031,vmaskloc,btoa,runame,titplo1,vargrid,nytt                                    $
+   IDL> write_ncdf,v031tr,msf031dn,msf031up,v031,vmaskloc,btoa,runame,titplo1,vargrid,nytt                                    $
            ,varname = ['v031tr','msf031dn','msf031up','v031','vmaskloc','btoa','runame','titplo1','vargrid','nytt'] $
            ,filename = iodir+'IDL_DATA/'+'waza3.nc'
 
  4)
- fileoutnc = iodir+'OBS/TRMM/'+'trmm_1d_'+iyystr+'0101_'+iyystr+'1231_reg0.25.nc'
- vv1 = {var:xaxis,name:'nav_lon',dname:'x',at1:{a:'units',b:'degrees_east'},at2:{a:'title',b:'longitude'}}
- vv2 = {var:yaxis,name:'nav_lat',dname:'y',at1:{a:'units',b:'degrees_north'},at2:{a:'title',b:'latitude'}}
- vv3 = {var:ttt,name:'time',dname:'time_counter',unlim:1,at1:{a:'units',b:timeunit},at2:{a:'title',b:'julian days'}  $
- vv4 = {var:rain_i2, name:'rain'                                                                     $
-        ,at1:{a:'units',b:'mm/day'}                                                                  $
+   IDL> fileoutnc = iodir+'OBS/TRMM/'+'trmm_1d_'+iyystr+'0101_'+iyystr+'1231_reg0.25.nc'
+   IDL> vv1 = {var:xaxis,name:'nav_lon',dname:'x',at1:{a:'units',b:'degrees_east'},at2:{a:'title',b:'longitude'}}
+   IDL> vv2 = {var:yaxis,name:'nav_lat',dname:'y',at1:{a:'units',b:'degrees_north'},at2:{a:'title',b:'latitude'}}
+   IDL> vv3 = {var:ttt,name:'time',dname:'time_counter',unlim:1,at1:{a:'units',b:timeunit},at2:{a:'title',b:'julian days'}  $
+   IDL> vv4 = {var:rain_i2, name:'rain' $
+        ,at1:{a:'units',b:'mm/day'} $
         ,at2:{a:'title',b:'trmm daily accumulated rainfall derived from the 3-hourly product (mm)'}  $
-        ,at3:{a:'scale_factor',b:scala_factor}                                                       $
-        ,at4:{a:'add_offset',b:adda_offset}                                                          $
-        ,at5:{a:'missing_value',b:missaval_i2}                                                       $
+        ,at3:{a:'scale_factor',b:scala_factor} $
+        ,at4:{a:'add_offset',b:adda_offset}    $
+        ,at5:{a:'missing_value',b:missaval_i2} $
        }
- glbatt={  gb1:{a:'File_Name', b:'trmm_1d_'+iyystr+'0101_'+iyystr+'1231_reg0.25.nc'}                                               $
-          ,gb2:{a:'Model_Name', b:'TRMM 3B42_V6 derived product'}                                                                  $
+   IDL> glbatt={  gb1:{a:'File_Name', b:'trmm_1d_'+iyystr+'0101_'+iyystr+'1231_reg0.25.nc'} $
+          ,gb2:{a:'Model_Name', b:'TRMM 3B42_V6 derived product'} $
           ,gb3:{a:'Source_File',b:'ftp://disc2.nascom.nasa.gov/data/TRMM/Gridded/Derived_Products/3B42_V6/Daily/'+iyystr+'/*.bin'} $</div>
           <h3>Version history</h3>
@@ -1118 +1127 @@
           
           
-          <h4>Todo items</h4><div class="preformat"> clem 
+          <h4>Todo items</h4><div class="preformat"> 
+ clem 
 </div>
           
@@ -1126 +1136 @@
           
           <h4>Uses routines</h4><div class="preformat">
- cm_general --> pour la var iodir
+ <a href="..//Commons/cm_general.html">cm_general</a> for iodir variable
 </div>