Ignore:
Timestamp:
03/20/08 23:06:02 (16 years ago)
Author:
smasson
Message:

update documentation

Location:
trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite
Files:
17 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/idl-NetCDF/ncdf_quickread/ncdf_quickread_helper.html

    r249 r338  
    168168     
    169169    <h4>Version</h4> 
    170  $Id: ncdf_quickread_helper.pro 226 2007-03-16 09:22:26Z pinsard $ 
     170 $Id: ncdf_quickread_helper.pro 325 2007-12-06 10:04:53Z pinsard $ 
    171171    <h4>History</h4> 
    172172 
    … …  
    237237     
    238238    <h4>Version</h4> 
    239  $Id: ncdf_quickread_helper.pro 226 2007-03-16 09:22:26Z pinsard $ 
     239 $Id: ncdf_quickread_helper.pro 325 2007-12-06 10:04:53Z pinsard $ 
    240240    <h4>History</h4> 
    241241 
    … …  
    307307     
    308308    <h4>Version</h4> 
    309  $Id: ncdf_quickread_helper.pro 226 2007-03-16 09:22:26Z pinsard $ 
     309 $Id: ncdf_quickread_helper.pro 325 2007-12-06 10:04:53Z pinsard $ 
    310310    <h4>History</h4> 
    311311 
    … …  
    444444     
    445445    <h4>Version</h4> 
    446  $Id: ncdf_quickread_helper.pro 226 2007-03-16 09:22:26Z pinsard $ 
     446 $Id: ncdf_quickread_helper.pro 325 2007-12-06 10:04:53Z pinsard $ 
    447447 
    448448    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/idl-NetCDF/ncdf_quickwrite/ncdf_quickwrite_helper2.html

    r249 r338  
    136136     
    137137    <h4>Version</h4> 
    138  $Id: ncdf_quickwrite_helper2.pro 163 2006-08-29 12:59:46Z navarro $ 
     138 $Id: ncdf_quickwrite_helper2.pro 325 2007-12-06 10:04:53Z pinsard $ 
    139139 
    140140    <h4>History</h4> 
    … …  
    226226     
    227227    <h4>Version</h4> 
    228  $Id: ncdf_quickwrite_helper2.pro 163 2006-08-29 12:59:46Z navarro $ 
     228 $Id: ncdf_quickwrite_helper2.pro 325 2007-12-06 10:04:53Z pinsard $ 
    229229 
    230230    <h4>History</h4> 
    … …  
    330330     
    331331    <h4>Version</h4> 
    332  $Id: ncdf_quickwrite_helper2.pro 163 2006-08-29 12:59:46Z navarro $ 
     332 $Id: ncdf_quickwrite_helper2.pro 325 2007-12-06 10:04:53Z pinsard $ 
    333333 
    334334    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/ncdf_getatt.html

    r290 r338  
    7474</font></h2> 
    7575 
    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></font></p> 
     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> 
    7777 
    7878     
    … …  
    130130 
    131131     
    132     <a name="#_ncdf_getatt_keyword_add_offset"></a> 
    133     <h4>add_offset&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     132    <a name="#_ncdf_getatt_keyword_ADD_OFFSET"></a> 
     133    <h4>ADD_OFFSET&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    134134       
    135135       
    … …  
    148148 
    149149     
    150     <a name="#_ncdf_getatt_keyword_scale_factor"></a> 
    151     <h4>scale_factor&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     150    <a name="#_ncdf_getatt_keyword_SCALE_FACTOR"></a> 
     151    <h4>SCALE_FACTOR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    152152       
    153153       
    … …  
    166166 
    167167     
    168     <a name="#_ncdf_getatt_keyword_missing_value"></a> 
    169     <h4>missing_value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     168    <a name="#_ncdf_getatt_keyword_MISSING_VALUE"></a> 
     169    <h4>MISSING_VALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    170170       
    171171       
    … …  
    184184 
    185185     
    186     <a name="#_ncdf_getatt_keyword_units"></a> 
    187     <h4>units&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     186    <a name="#_ncdf_getatt_keyword_UNITS"></a> 
     187    <h4>UNITS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    188188       
    189189       
    … …  
    202202 
    203203     
    204     <a name="#_ncdf_getatt_keyword_calendar"></a> 
    205     <h4>calendar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     204    <a name="#_ncdf_getatt_keyword_CALENDAR"></a> 
     205    <h4>CALENDAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    206206       
    207207       
    … …  
    220220 
    221221     
     222    <a name="#_ncdf_getatt_keyword_LONG_NAME"></a> 
     223    <h4>LONG_NAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     277       
     278       
     279       
     280       
     281       
     282       
     283       
     284       
     285    </h4> 
     286 
     287     
     288 defined only to be able to call ncdf_getatt with the _extra keyword 
     289 
     290     
    222291     
    223292 
    … …  
    228297     
    229298    <h4>Version</h4> 
    230  $Id: ncdf_getatt.pro 272 2007-08-30 12:51:26Z smasson $ 
     299 $Id: ncdf_getatt.pro 334 2008-03-07 14:39:18Z smasson $ 
    231300 
    232301    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/ncdf_getaxis.html

    r290 r338  
    8787    <a name="#_ncdf_getaxis_keyword_fileid"></a> 
    8888    <h4>fileid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    89        
    90        
    91        
    92        
    93        
    94        
    95        
    96        
    97     </h4> 
    98  
    99      
     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>scalar</i></font> 
     95       
     96       
     97    </h4> 
     98 
     99     
     100 the id of the netcdf file 
     101 
    100102     
    101103 
    … …  
    315317     
    316318    <h4>Version</h4> 
    317  $Id: ncdf_getaxis.pro 271 2007-08-30 12:44:23Z smasson $ 
     319 $Id: ncdf_getaxis.pro 327 2007-12-13 16:22:35Z pinsard $ 
    318320    <h4>History</h4> 
    319321 March 2007: Sebastien Masson (smasson@locean-ipsl.upmc.fr) 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/ncdf_getmask.html

    r321 r338  
    230230     
    231231    <h4>Version</h4> 
    232  $Id: ncdf_getmask.pro 306 2007-10-26 14:51:22Z smasson $ 
     232 $Id: ncdf_getmask.pro 327 2007-12-13 16:22:35Z pinsard $ 
    233233 
    234234    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/ncdf_gettime.html

    r321 r338  
    204204     
    205205    <h4>Version</h4> 
    206  $Id: ncdf_gettime.pro 297 2007-09-25 15:09:12Z pinsard $ 
     206 $Id: ncdf_gettime.pro 327 2007-12-13 16:22:35Z pinsard $ 
    207207    <h4>History</h4> 
    208208 August 2007: Sebastien Masson (smasson@lodyc.jussieu.fr) 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/ncdf_timeget.html

    r321 r338  
    163163 
    164164     
    165     </pre></pre></pre><h3>Version history</h3> 
     165    </pre></pre></pre></pre><h3>Version history</h3> 
    166166     
    167167    <h4>Version</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/read_grads.html

    r290 r338  
    7575</font></h2> 
    7676 
    77       <p><font face="Courier"><i>result = </i>read_grads(<i><a href="#_read_grads_keyword_var">var</a>, <a href="#_read_grads_keyword_date1">date1</a>[, <a href="#_read_grads_keyword_date2">date2</a>]</i>, <a href="#_read_grads_keyword_FILENAME">FILENAME</a>=<i>FILENAME</i>, <a href="#_read_grads_keyword_BOX">BOX</a>=<i>BOX</i>, <a href="#_read_grads_keyword_TIMESTEP">TIMESTEP</a>=<i>TIMESTEP</i>, <a href="#_read_grads_keyword_EVERYTHING">EVERYTHING</a>=<i>EVERYTHING</i>, <a href="#_read_grads_keyword_NOSTRUCT">NOSTRUCT</a>=<i>NOSTRUCT</i>, <a href="#_read_grads_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> 
    78  
    79      
    80  
    81  
    82      
     77      <p><font face="Courier"><i>result = </i>read_grads(<i><a href="#_read_grads_keyword_var">var</a>, <a href="#_read_grads_keyword_date1">date1</a>[, <a href="#_read_grads_keyword_date2">date2</a>]</i>, <a href="#_read_grads_keyword_FILENAME">FILENAME</a>=<i>FILENAME</i>, <a href="#_read_grads_keyword_BOX">BOX</a>=<i>A 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1, depth2]</i>, <a href="#_read_grads_keyword_TIMESTEP">TIMESTEP</a>=<i>TIMESTEP</i>, <a href="#_read_grads_keyword_EVERYTHING">EVERYTHING</a>=<i>EVERYTHING</i>, <a href="#_read_grads_keyword_NOSTRUCT">NOSTRUCT</a>=<i>NOSTRUCT</i>, <a href="#_read_grads_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> 
     78 
     79     
     80 
     81 
     82    <h3>Return value</h3> 
     83 an array 
     84 
    8385 
    8486     
    … …  
    165167       
    166168       
    167        
    168        
    169        
    170     </h4> 
    171  
    172      
     169      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>A 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1, depth2]</i></font> 
     170       
     171       
     172    </h4> 
     173 
     174     
     175 It specifies the area where data must be read 
     176 
    173177     
    174178    <a name="#_read_grads_keyword_TIMESTEP"></a> 
    … …  
    187191 to specify that the dates are time steps instead of true calendar. 
    188192 
     193 NOT yet available 
     194 
    189195     
    190196    <a name="#_read_grads_keyword_EVERYTHING"></a> 
    … …  
    201207 
    202208     
     209 
    203210     
    204211    <a name="#_read_grads_keyword_NOSTRUCT"></a> 
    … …  
    215222 
    216223     
     224 
    217225     
    218226    <a name="#_read_grads_keyword__EXTRA"></a> 
    … …  
    229237 
    230238     
    231      
    232      
    233  
    234      
    235      
    236      
    237      
    238      
    239      
    240  
    241      
    242      
    243      
    244      
    245      
    246  
    247      
    248      
    249      
    250      
     239 Used to pass keywords 
     240 
     241     
     242     
     243 
     244    <h3>Examples</h3><pre> 
     245 IDL> a=read_grads('sst',19900101,19900131,filename='outputs.ctl') 
     246 IDL> plt, a 
     247 
     248    </pre><h3>Version history</h3> 
     249     
     250    <h4>Version</h4> 
     251 $Id: read_grads.pro 327 2007-12-13 16:22:35Z pinsard $ 
     252 
     253    <h4>History</h4> 
     254 Sebastien Masson (smasson@lodyc.jussieu.fr) 
     255 
     256     
     257 
     258    <h3>Known issues</h3> 
     259     
     260     
     261     
     262    <h4>Restrictions</h4> 
     263 define all the grid parameters (defined in common.pro) 
     264 associated to the data. 
     265 
     266 this function call the procedure scanfile that use the 
     267 unix commands grep and sed 
     268 
     269 
     270    <h3>Other attributes</h3> 
     271     
     272     
     273    <h4>Uses routines</h4> 
     274 common 
     275 
    251276     
    252277     

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/read_oasis.html

    r249 r338  
    228228     
    229229    <h4>Version</h4> 
    230  $Id: read_oasis.pro 238 2007-03-27 13:43:18Z pinsard $ 
     230 $Id: read_oasis.pro 327 2007-12-13 16:22:35Z pinsard $ 
    231231 
    232232    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/readbat.html

    r249 r338  
    130130     
    131131    <h4>Version</h4> 
    132   $Id: readbat.pro 238 2007-03-27 13:43:18Z pinsard $ 
     132  $Id: readbat.pro 327 2007-12-13 16:22:35Z pinsard $ 
    133133 
    134134    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/readoldopadistcoast.html

    r249 r338  
    162162     
    163163    <h4>Version</h4> 
    164  $Id: readoldopadistcoast.pro 240 2007-03-28 12:17:24Z pinsard $ 
     164 $Id: readoldopadistcoast.pro 327 2007-12-13 16:22:35Z pinsard $ 
    165165 
    166166    <h4>History</h4> 
    … …  
    328328     
    329329    <h4>Version</h4> 
    330  $Id: readoldopadistcoast.pro 240 2007-03-28 12:17:24Z pinsard $ 
     330 $Id: readoldopadistcoast.pro 327 2007-12-13 16:22:35Z pinsard $ 
    331331 
    332332    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/readoldoparestart.html

    r290 r338  
    117117     
    118118 
    119  
    120119     
    121120 
    … …  
    159158     
    160159    <h4>Version</h4> 
    161  $Id: readoldoparestart.pro 262 2007-08-21 14:19:32Z pinsard $ 
     160 $Id: readoldoparestart.pro 327 2007-12-13 16:22:35Z pinsard $ 
     161 
    162162    <h4>History</h4> 
    163163 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    … …  
    215215     
    216216 
    217  
    218217     
    219218 
    … …  
    430429     
    431430 
    432  
    433431     
    434432    <a name="#_readoldoparestart_keyword_VB"></a> 
    … …  
    446444     
    447445 
    448  
    449446     
    450447    <a name="#_readoldoparestart_keyword_TB"></a> 
    … …  
    725722     
    726723    <h4>Version</h4> 
    727  $Id: readoldoparestart.pro 262 2007-08-21 14:19:32Z pinsard $ 
     724 $Id: readoldoparestart.pro 327 2007-12-13 16:22:35Z pinsard $ 
    728725    <h4>History</h4> 
    729726 Sebastien Masson (smasson@lodyc.jussieu.fr) 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/scanctl.html

    r249 r338  
    320320     
    321321    <h4>Version</h4> 
    322  $Id: scanctl.pro 240 2007-03-28 12:17:24Z pinsard $ 
     322 $Id: scanctl.pro 327 2007-12-13 16:22:35Z pinsard $ 
    323323 
    324324     

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/scanoasis.html

    r321 r338  
    110110     
    111111    <h4>Version</h4> 
    112  $Id: scanoasis.pro 238 2007-03-27 13:43:18Z pinsard $ 
     112 $Id: scanoasis.pro 325 2007-12-06 10:04:53Z pinsard $ 
    113113 
    114114    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/write_ncdf.html

    r321 r338  
    7777       
    7878      <dt><a href="#_writenc_str2strlc"><i>result = </i>writenc_str2strlc(<i>structa</i>)</a><dt> 
    79       <dd><font size="-1"></font></dd> 
     79      <dd><font size="-1">  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.</font></dd> 
    8080       
    8181      <dt><a href="#_writenc_strlc2str"><i>result = </i>writenc_strlc2str(<i>strwlist</i>)</a><dt> 
    82       <dd><font size="-1"></font></dd> 
     82      <dd><font size="-1">   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.</font></dd> 
    8383       
    8484      <dt><a href="#_write_ncdf">write_ncdf<i>, 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</i>[, FILENAME=<i>FILENAME</i>][, GLOBATTR=<i>GLOBATTR</i>], VARNAME=<i>VARNAME</i>, NOT_SDISV=<i>NOT_SDISV</i>, NOT_OUASSALU=<i>NOT_OUASSALU</i>, OKNAN=<i>OKNAN</i></a><dt> 
    … …  
    389389 
    390390     
     391 SUBROUTINE (2)/(3) :  
     392 
     393 on remplace la 4ieme structure de structa par une liste chainee afin 
     394 d uniformaiser les format de strd (cf prog write_ncdf) pour les 
     395 passer facilement en argument au sous-prog writenc_unlimdim_update, sous forme de tablo de structures de 
     396 meme type !!!! (utilise si writenc_unlimdim_update est utilise i.e. dans le cas ou la cle NOT_OUASSALU 
     397 est pas active, i.e. cas par defaut) 
     398 
    391399 
    392400     
    … …  
    445453 
    446454     
     455 
     456 SUBROUTINE (3)/(3) :  
     457 
     458 convertit une structure contenant une liste 
     459 chainee en structure classique utilisee par le main prog (utile pour 
     460 passer ces structures en argument au sous-prog 
     461 writenc_unlimdim_update, i.e. dans le cas ou la cle NOT_OUASSALU n 
     462 est pas activee, i.e. cas par defaut) 
     463 
     464 
    447465 
    448466     
    … …  
    11261144     
    11271145    <h4>Todo items</h4> clem  
     1146 
    11281147     
    11291148 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/write_oasis.html

    r321 r338  
    7272      <h2>write_oasis  </h2> 
    7373 
    74       <p><font face="Courier">write_oasis<i>, <a href="#_write_oasis_keyword_filename">filename</a>, <a href="#_write_oasis_keyword_varname">varname</a>, <a href="#_write_oasis_keyword_z2d">z2d</a></i>, <a href="#_write_oasis_keyword_I2">I2</a>=<i>I2</i>, <a href="#_write_oasis_keyword_I4">I4</a>=<i>I4</i>, <a href="#_write_oasis_keyword_I8">I8</a>=<i>I8</i>, <a href="#_write_oasis_keyword_R4">R4</a>=<i>R4</i>, <a href="#_write_oasis_keyword_APPEND">APPEND</a>=<i>APPEND</i></font></p> 
     74      <p><font face="Courier">write_oasis<i>, <a href="#_write_oasis_keyword_filename">filename</a>, <a href="#_write_oasis_keyword_varname">varname</a>, <a href="#_write_oasis_keyword_z2d">z2d</a></i>, <a href="#_write_oasis_keyword_I2">I2</a>=<i>I2</i>, <a href="#_write_oasis_keyword_I4">I4</a>=<i>I4</i>, <a href="#_write_oasis_keyword_I8">I8</a>=<i>I8</i>, <a href="#_write_oasis_keyword_R4">R4</a>=<i>R4</i>, <a href="#_write_oasis_keyword_APPEND">APPEND</a>=<i>APPEND</i>, <a href="#_write_oasis_keyword_RECSIZE">RECSIZE</a>=<i>RECSIZE</i>, <a href="#_write_oasis_keyword_TEMPORARY">TEMPORARY</a>=<i>TEMPORARY</i>, <a href="#_write_oasis_keyword_HEADER">HEADER</a>=<i>HEADER</i>, <a href="#_write_oasis_keyword_ENDING">ENDING</a>=<i>ENDING</i>, <a href="#_write_oasis_keyword_POSITION">POSITION</a>=<i>POSITION</i></font></p> 
    7575 
    7676     
    … …  
    214214 
    215215     
    216      
    217  
    218      
     216    <a name="#_write_oasis_keyword_RECSIZE"></a> 
     217    <h4>RECSIZE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     218       
     219       
     220       
     221       
     222       
     223       
     224       
     225       
     226    </h4> 
     227 
     228     
     229 define the size of the full data array to be written. Usefull when 
     230 you want to save memory and write the data in several write_oasis 
     231 instructions. see example 
     232 
     233     
     234    <a name="#_write_oasis_keyword_TEMPORARY"></a> 
     235    <h4>TEMPORARY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     236       
     237       
     238       
     239       
     240       
     241       
     242       
     243       
     244    </h4> 
     245 
     246     
     247 activate undefine z2d when yo write it (to save memory) -> z2d will 
     248 be lost once write_oasis is returning. 
     249 
     250     
     251    <a name="#_write_oasis_keyword_HEADER"></a> 
     252    <h4>HEADER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     253       
     254       
     255       
     256       
     257       
     258       
     259       
     260       
     261    </h4> 
     262 
     263     
     264 activate to write the header ("character*8" contained in varname) 
     265 before writting the data. Used when recsize is defined and /= 0, see example 
     266 
     267     
     268    <a name="#_write_oasis_keyword_ENDING"></a> 
     269    <h4>ENDING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     270       
     271       
     272       
     273       
     274       
     275       
     276       
     277       
     278    </h4> 
     279 
     280     
     281 activate when you write the last part of the data. Used when recsize 
     282 is defined and /= 0, see example 
     283 
     284     
     285    <a name="#_write_oasis_keyword_POSITION"></a> 
     286    <h4>POSITION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     287       
     288       
     289       
     290       
     291       
     292       
     293       
     294       
     295    </h4> 
     296 
     297     
     298 specify the position (in byte) at which you want to write the 
     299 data. Used when recsize is defined and /= 0, see example 
     300 
     301     
     302     
     303 
     304    <h3>Examples</h3><pre> 
     305 
     306   write_oasis, fa2of, 'WEIGHTS5', weig 
     307 
     308 or in several call so save memory 
     309 
     310   ysz = 100L 
     311   recsz8 = 16L * jpio * jpjo * 8L 
     312   FOR i = 0L, jpjo-1L, ysz DO BEGIN  
     313     ii = (i+ysz-1L) < (jpjo-1L) 
     314     position = (4L + 8L + 4L + 4L)*(i NE 0) + 16L * jpio * i * 8L 
     315     weig = ....  
     316     write_oasis, fa2ou, 'WEIGHTS3', temporary(weig), /temporary, append = i NE 0, header = i EQ 0 $ 
     317                  , ending = ii EQ jpjo-1, recsize = recsz8, position = position 
     318   ENDFOR 
     319 
     320 
    219321    </pre><h3>Version history</h3> 
    220322     
    221323    <h4>Version</h4> 
    222  $Id: write_oasis.pro 238 2007-03-27 13:43:18Z pinsard $ 
     324 $Id: write_oasis.pro 332 2008-02-11 16:48:24Z smasson $ 
    223325 
    224326    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/writebat.html

    r249 r338  
    126126     
    127127    <h4>Version</h4> 
    128  $Id: writebat.pro 238 2007-03-27 13:43:18Z pinsard $ 
     128 $Id: writebat.pro 325 2007-12-06 10:04:53Z pinsard $ 
    129129 
    130130    <h4>History</h4> 
Note: See TracChangeset for help on using the changeset viewer.