Pileus Git - ~andy/rsl/blob - doc/RSL_uf_to_radar.html

   1 <head>
   2 </head>
   3
   4 <body>
   5 <a HREF="index.html"> <IMG SRC="rsl.gif"> </a>
   6 <hr>
   7
   8
   9 <h1>RSL_uf_to_radar</h1>
  10
  11
  12 <h1>RSL_uf_to_radar_fp</h1>
  13
  14 <hr>
  15
  16 <h3>Synopsis</h3>
  17 <b>#include &quot;rsl.h&quot;</b><br>
  18 <b><a href=RSL_radar_struct.html>Radar</a> *RSL_uf_to_radar(char *infile);</b> <br>
  19 <b><a href=RSL_radar_struct.html>Radar</a> *RSL_uf_to_radar_fp(FILE *fp);</b>
  20 <hr>
  21
  22 <h3>Description</h3>
  23 Read a UF (Universal Format) file and return a pointer to the structure <b>Radar</b>. The input file is specified by the string <b>infile</b>. <b>RSL_uf_to_radar</b> calls <b>RSL_uf_to_radar_fp</b> which is provided as a means of constructing filter programs -- reading stdio, for instance. If <b>infile</b> is NULL, then <b>stdin</b> is used. <b>RSL_uf_to_radar_fp</b> checks the UF magic information to ensure that a valid UF file is being read. The input file may be compressed. If the data is compressed, it is passed through the GNU <b>gunzip</b> filter. Thus, compressed data can be any format that <b>gzip</b> understands. It can handle true UF files, as well as, UF files with 2 and 4 byte Fortran record delimeters. These routines work on big and little endian machines, provided that the input UF file is in big endian format. <a href=RSL_radar_to_uf.html>RSL_radar_to_uf</a> creates UF files in big endian format when run on either big or little endian machines; by definition UF files are in big endian format.
  24
  25 <p>The radar structure is, essentially, an array of Volumes. The number and type of volumes allocated is automatically determined from the input UF file. No UF library needed; the UF code is part of RSL.
  26 <hr>
  27
  28 <h3>Return value</h3>
  29 Upon successful completion, RSL_uf_to_radar returns a pointer to the structure <b>Radar</b>. Otherwise, NULL is returned and errno is set.
  30 <hr>
  31
  32 <h3>See also</h3>
  33 <a href=RSL_anyformat_to_radar.html>RSL_anyformat_to_radar</a>, <a href=RSL_radar_to_uf.html>RSL_radar_to_uf</a>
  34 <hr>
  35
  36 <p>Author: <a href=john.merritt.html>John H. Merritt</a>.
  37 </body>