Pileus Git - ~andy/rsl/blob - doc/RSL_read.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_read_...</h1>
  10
  11 <hr>
  12
  13 <h3>Synopsis</h3>
  14 <b>#include &quot;rsl.h&quot;</b> <br>
  15 <b><a href=RSL_ray_struct.html>Ray</a> *RSL_read_ray(FILE *fp);<br>
  16 <a href=RSL_sweep_struct.html>Sweep</a> *RSL_read_sweep(FILE *fp);</b><b><a href=RSL_volume_struct.html><br>
  17 Volume</a> *RSL_read_volume</b><b>(FILE *fp);</b>
  18
  19 <h3>
  20 <hr>Description</h3>
  21 <b>RSL_read_volume</b> reads an entire volume structure from the input stream <b>fp</b>. <b>fp</b> is usually assigned inside the routine <b>RSL_read_radar</b>, however, you can assign the stream <b>fp</b> via fopen. <b>RSL_read_volume</b> calls <b>RSL_read_sweep</b> for the number of sweeps, vol-&gt;h.nsweeps, as determined from reading <b>fp</b>. Memory is allocated via <b>RSL_new_volume</b>.
  22
  23 <p><b>RSL_read_sweep</b> reads an entire sweep structure from the input stream fp. <b>RSL_read_sweep</b> calls <b>RSL_read_ray</b> for the number of rays, sweep-&gt;h.nrays, as determined by reading <b>fp</b>. Memory is allocated via <b>RSL_new_sweep</b>.
  24
  25 <p><b>RSL_read_ray</b> reads an entire ray structure from the input stream fp. RSL_read_ray ingests an entire ray of data and sets ray-&gt;h.nbins. Memory is allocated via <b>RSL_new_ray</b>.
  26 <hr>
  27
  28 <h3>Return value</h3>
  29 Upon successful completion, a pointer to the appropriate structure is returned. Otherwise, a NULL pointer is returned and errno is set.
  30 <hr>
  31
  32 <h3>See also</h3>
  33 <a href=../examples/Example_RSL_read.c>Example</a><br>
  34 <a href=RSL_new.html>RSL_new_volume</a>, <a href=RSL_new.html>RSL_new_sweep</a>, <a href=RSL_new.html>RSL_new_ray</a>,<br>
  35 <a href=RSL_write.html>RSL_write_volume</a>, <a href=RSL_write.html>RSL_write_sweep</a>, <a href=RSL_write.html>RSL_write_ray</a>,<br>
  36 <a href=RSL_read_radar.html>RSL_read_radar</a>, <a href=RSL_write_radar.html>RSL_write_radar</a>,<br>
  37 <a href=RSL_radar_file_format.html>File format</a>.
  38 <hr>
  39
  40 <p>Author: <a href=john.merritt.html>John H. Merritt</a>
  41 </body>