Pileus Git - ~andy/rsl/blob - doc/RSL_wsr88d_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_wsr88d_to_radar</h1>
  10
  11 <hr>
  12
  13 <h3>Synopsis</h3>
  14 <b>#include &quot;rsl.h&quot;<br>
  15 <a href=RSL_radar_struct.html>Radar</a> *RSL_wsr88d_to_radar(char *infile, char *callid_or_first_file);</b>
  16 <hr>
  17
  18 <h3>Description</h3>
  19 Reads a wsr88d (NEXRAD) file and returns a pointer to the <i>Radar</i> structure. The input file is specified by the string <i>infile</i>. If <i>infile</i> is NULL, then stdin is 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.
  20
  21 <p>The radar structure is, essentially, an array of Volumes. These volumes represent the reflectivity, velocity and spectrum width fields. The string <b>callid_or_first_file</b> contains the filename of the first extracted file from the NEXRAD tape or contains the 4 character callid (eg. KMLB). The first file on the tape is the only place where the site information is stored. A warning will be issued if it is detected that the file <b>callid_or_first_file</b> is not a proper NEXRAD tape header file.
  22 <hr>
  23
  24 <h3>Return value</h3>
  25 Upon successful completion, RSL_wsr88d_to_radar returns a pointer to the structure <b>Radar</b>. Otherwise, NULL is returned. A valid <b>Radar</b> structure will be returned if the <b>infile</b> is valid, dispite <b>callid_or_first_file</b> being invalid. Thus, it is not required to have <b>callid_or_first_file</b>.
  26 <hr>
  27
  28 <h3>See also</h3>
  29 <a href=RSL_anyformat_to_radar.html>RSL_anyformat_to_radar</a>
  30 <hr>
  31
  32 <p>Author: <a href=john.merritt.html>John H. Merritt</a>.
  33 </body>