| 1 | |
|---|
| 2 | |
|---|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|---|
| 4 | <head> |
|---|
| 5 | <title>write_oasis.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="write_ncdf.html"><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="writebat.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>write_oasis.pro</h2> |
|---|
| 59 | |
|---|
| 60 | <dl> |
|---|
| 61 | </dl> |
|---|
| 62 | |
|---|
| 63 | |
|---|
| 64 | write an Oasis file (version < 2.5) |
|---|
| 65 | |
|---|
| 66 | |
|---|
| 67 | |
|---|
| 68 | |
|---|
| 69 | |
|---|
| 70 | <a name="#_write_oasis"></a> |
|---|
| 71 | |
|---|
| 72 | <h2>write_oasis </h2> |
|---|
| 73 | |
|---|
| 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> |
|---|
| 75 | |
|---|
| 76 | |
|---|
| 77 | |
|---|
| 78 | |
|---|
| 79 | |
|---|
| 80 | |
|---|
| 81 | |
|---|
| 82 | <h3>Parameters</h3> |
|---|
| 83 | |
|---|
| 84 | |
|---|
| 85 | <a name="#_write_oasis_keyword_filename"></a> |
|---|
| 86 | <h4>filename |
|---|
| 87 | <font size="-1" color="#006633">in</font> |
|---|
| 88 | |
|---|
| 89 | |
|---|
| 90 | <font size="-1" color="#006633">required</font> |
|---|
| 91 | |
|---|
| 92 | |
|---|
| 93 | |
|---|
| 94 | |
|---|
| 95 | </h4> |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | the filename |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | |
|---|
| 102 | <a name="#_write_oasis_keyword_varname"></a> |
|---|
| 103 | <h4>varname |
|---|
| 104 | <font size="-1" color="#006633">in</font> |
|---|
| 105 | |
|---|
| 106 | |
|---|
| 107 | <font size="-1" color="#006633">required</font> |
|---|
| 108 | |
|---|
| 109 | |
|---|
| 110 | |
|---|
| 111 | |
|---|
| 112 | </h4> |
|---|
| 113 | |
|---|
| 114 | |
|---|
| 115 | the name of the variable to be written |
|---|
| 116 | |
|---|
| 117 | |
|---|
| 118 | |
|---|
| 119 | <a name="#_write_oasis_keyword_z2d"></a> |
|---|
| 120 | <h4>z2d |
|---|
| 121 | <font size="-1" color="#006633">in</font> |
|---|
| 122 | |
|---|
| 123 | |
|---|
| 124 | <font size="-1" color="#006633">required</font> |
|---|
| 125 | |
|---|
| 126 | |
|---|
| 127 | |
|---|
| 128 | |
|---|
| 129 | </h4> |
|---|
| 130 | |
|---|
| 131 | |
|---|
| 132 | the variable (2D array) to be written |
|---|
| 133 | |
|---|
| 134 | |
|---|
| 135 | |
|---|
| 136 | |
|---|
| 137 | |
|---|
| 138 | <h3>Keywords</h3> |
|---|
| 139 | |
|---|
| 140 | |
|---|
| 141 | <a name="#_write_oasis_keyword_I2"></a> |
|---|
| 142 | <h4>I2 |
|---|
| 143 | |
|---|
| 144 | |
|---|
| 145 | |
|---|
| 146 | |
|---|
| 147 | |
|---|
| 148 | |
|---|
| 149 | |
|---|
| 150 | |
|---|
| 151 | </h4> |
|---|
| 152 | |
|---|
| 153 | |
|---|
| 154 | |
|---|
| 155 | <a name="#_write_oasis_keyword_I4"></a> |
|---|
| 156 | <h4>I4 |
|---|
| 157 | |
|---|
| 158 | |
|---|
| 159 | |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | |
|---|
| 163 | |
|---|
| 164 | |
|---|
| 165 | </h4> |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | |
|---|
| 169 | <a name="#_write_oasis_keyword_I8"></a> |
|---|
| 170 | <h4>I8 |
|---|
| 171 | |
|---|
| 172 | |
|---|
| 173 | |
|---|
| 174 | |
|---|
| 175 | |
|---|
| 176 | |
|---|
| 177 | |
|---|
| 178 | |
|---|
| 179 | </h4> |
|---|
| 180 | |
|---|
| 181 | |
|---|
| 182 | |
|---|
| 183 | <a name="#_write_oasis_keyword_R4"></a> |
|---|
| 184 | <h4>R4 |
|---|
| 185 | |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | |
|---|
| 190 | |
|---|
| 191 | |
|---|
| 192 | |
|---|
| 193 | </h4> |
|---|
| 194 | |
|---|
| 195 | |
|---|
| 196 | to change the default format (R8) of the data to be written. |
|---|
| 197 | |
|---|
| 198 | |
|---|
| 199 | <a name="#_write_oasis_keyword_APPEND"></a> |
|---|
| 200 | <h4>APPEND |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | |
|---|
| 208 | |
|---|
| 209 | </h4> |
|---|
| 210 | |
|---|
| 211 | |
|---|
| 212 | to open the file with the file pointer at the end of the file, ready for |
|---|
| 213 | data to be appended. |
|---|
| 214 | |
|---|
| 215 | |
|---|
| 216 | <a name="#_write_oasis_keyword_RECSIZE"></a> |
|---|
| 217 | <h4>RECSIZE |
|---|
| 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 |
|---|
| 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 |
|---|
| 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 |
|---|
| 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 |
|---|
| 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 | |
|---|
| 321 | </pre><h3>Version history</h3> |
|---|
| 322 | |
|---|
| 323 | <h4>Version</h4> |
|---|
| 324 | $Id: write_oasis.pro 332 2008-02-11 16:48:24Z smasson $ |
|---|
| 325 | |
|---|
| 326 | <h4>History</h4> |
|---|
| 327 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
|---|
| 328 | July 01, 2002 |
|---|
| 329 | |
|---|
| 330 | |
|---|
| 331 | <h3>Known issues</h3> |
|---|
| 332 | |
|---|
| 333 | |
|---|
| 334 | |
|---|
| 335 | <h4>Restrictions</h4> |
|---|
| 336 | varname is automatically written as a "character*8" |
|---|
| 337 | by default z2d is written as an R8 array |
|---|
| 338 | |
|---|
| 339 | |
|---|
| 340 | |
|---|
| 341 | |
|---|
| 342 | |
|---|
| 343 | |
|---|
| 344 | |
|---|
| 345 | |
|---|
| 346 | |
|---|
| 347 | |
|---|
| 348 | <font size="-3"><p> </p></font> |
|---|
| 349 | <hr size="1" color="#CCCCCC"/> |
|---|
| 350 | |
|---|
| 351 | |
|---|
| 352 | |
|---|
| 353 | |
|---|
| 354 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
|---|
| 355 | |
|---|
| 356 | </body> |
|---|
| 357 | </html> |
|---|
