Pileus Git - ~andy/rsl/blob - doc/RSL_sort.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_sort_...</h1>
  10
  11 <hr>
  12
  13 <h3>Synopsis</h3>
  14 <b>#include &quot;rsl.h&quot;</b><br>
  15 <b><a href=RSL_radar_struct.html>Radar</a> *RSL_sort_radar(<a href=RSL_radar_struct.html>Radar</a> *r);<br>
  16 <a href=RSL_volume_struct.html>Volume</a> *RSL_sort_sweeps_in_volume(<a href=RSL_volume_struct.html>Volume</a> *v);<br>
  17 <a href=RSL_volume_struct.html>Volume</a> *RSL_sort_volume(<a href=RSL_volume_struct.html>Volume</a> *v); <br>
  18 <a href=RSL_sweep_struct.html>Sweep</a> *RSL_sort_rays_by_time(<a href=RSL_sweep_struct.html>Sweep</a> *s);</b><b><a href=RSL_sweep_struct.html><br>
  19 Sweep</a> *RSL_sort_rays_in_sweep(<a href=RSL_sweep_struct.html>Sweep</a> *s);<br>
  20 <a href=RSL_volume_struct.html>Volume</a> *RSL_sort_rays_in_volume(<a href=RSL_volume_struct.html>Volume</a> *v);</b>
  21
  22 <h3>
  23 <hr>Description</h3>
  24 <b>RSL_sort_radar</b> calls RSL_sort_volume for the number of volumes.
  25
  26 <p><b>RSL_sort_volume</b> calls RSL_sort_sweeps_in_volume, then calls RSL_sort_rays_in_volume. This yields a completely sorted, by elevation angle and by azimuth angle, volume.
  27
  28 <p><b>RSL_sort_sweeps_in_volume</b> only orders the sweeps by elevation angle. It does not sort the rays by azimuth angle.
  29
  30 <p><b>RSL_sort_rays_in_sweep</b> orders the rays by azimuth angle: 0 through 360 degrees.<br>
  31 <b>RSL_sort_rays_in_volume</b> orders the rays in each sweep by calling sort_rays_in_sweep for the number of sweeps. <b>RSL_sort_rays_in_sweep</b> sorts the rays by azimuth angle placing the the smallest azimuth angle first. The input volume or sweep structure is <i>modified</i> and a pointer to the newly organized structure is returned.
  32
  33 <p><b>RSL_sort_rays_by_time</b> orders the rays in a sweep by time.
  34 <hr>
  35
  36 <h3>Return value</h3>
  37 Upon successful completion, a pointer to the appropriate structure is returned. Otherwise, a NULL pointer is returned and errno is set.
  38 <hr>
  39
  40 <p>Author: <a href=dennis.flanigan.html>Dennis Flanigan Jr.</a>
  41 </body>