Pileus Git - ~andy/rsl/blob - doc/RSL_prune.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_prune_...</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_prune_ray(<a href=RSL_ray_struct.html>Ray</a> *ray);<br>
  16 <a href=RSL_sweep_struct.html>Sweep</a> *RSL_prune_sweep(<a href=RSL_sweep_struct.html>Sweep</a> *s);<br>
  17 <a href=RSL_volume_struct.html>Volume</a> *RSL_prune_volume(<a href=RSL_volume_struct.html>Volume</a> *v</b><b>);</b><br>
  18 <b><a href=RSL_radar_struct.html>Radar</a> *RSL_prune_radar(<a href=RSL_radar_struct.html>Radar</a> *radar);</b>
  19
  20 <h3>
  21 <hr>Description</h3>
  22 These routines eliminates dataless substructures. A search is conducted for any substructures that contain only header information and, when found, are set to NULL. During the initial allocation step for ingest of a data format, substructure header information is minimially filled. It is not generally known if, for instance, a volume is NULL until it can be determined if there have been no rays assigned to it. In such a case, all sweep pointers have been allocated but no ray pointers assigned. Pruning this volume will result in setting the volume to NULL. A ray is pruned if <b>h.nbins</b> is 0. A sweep is pruned if <b>h.nrays</b> is 0. A volume is pruned if <b>h.nsweeps</b> is 0. A radar is pruned if <b>h.nvolumes</b> is 0.
  23 <hr>
  24
  25 <h3>Return value</h3>
  26 Upon successful completion, a pointer to the appropriate structure is returned. Otherwise, a NULL pointer is returned.
  27 <hr>
  28
  29 <h3>See also</h3>
  30 <a href=RSL_new.html>RSL_new_radar</a>, <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>, <a href=RSL_copy.html><br>
  31 RSL_copy_volume</a>, <a href=RSL_copy.html>RSL_copy_sweep</a>, <a href=RSL_copy.html>RSL_copy_ray</a>
  32 <hr>
  33
  34 <p>Author: <a href=john.merritt.html>John H. Merritt</a>
  35 </body>