Pileus Git - ~andy/rsl/blob - doc/RSL_volume_to_cube.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_volume_to_cube</h1>
  10
  11 <hr>
  12
  13 <h3>Synopsis</h3>
  14 <b>#include &quot;rsl.h&quot;</b> <br>
  15 <a href=RSL_cube_struct.html>Cube</a> *RSL_volume_to_cube(<a href=RSL_volume_struct.html>Volume</a> *v, float dx, float dy, float dz, int nx, int ny, int nz, float grnd_r, int radar_x, int radar_y, int radar_z)
  16
  17 <h3>
  18 <hr>Description</h3>
  19 Convert polar coordinate Volume v into cube cartesean coordinates. This routine allocates space for the cube header and an array of pointers to carpi's. The routine <a href=RSL_volume_to_carpi.html>RSL_volume_to_carpi</a> is called for each <b>dz</b>.
  20
  21 <p><b>dx</b>, <b>dy</b>, <b>dz</b> specify the kilometer resolution of each cubic cell.<br>
  22 <b>nx</b>, <b>ny</b>, <b>nz</b> specify the cube dimensions.<br>
  23 <b>grnd_r</b> specifies the maximum ground range to load from the volume.<br>
  24 <b>radar_x</b>, <b>radar_y</b>, <b>radar_z</b> specify the location within the cube for the radar. Typically, <b>radar_z</b> equals 0 as there is no data below the radar. Specify dx/2 and dy/2 for radar_x and radar_y to center the radar within the cube.
  25 <hr>
  26
  27 <h3>Return value</h3>
  28 Upon successful completion, a pointer to the appropriate structure is returned. Otherwise, a NULL pointer is returned and errno is set.
  29 <hr>
  30
  31 <h3>See also</h3>
  32 <a href=RSL_get_slice_from_cube.html>RSL_get_slice_from_cube</a>, <a href=RSL_volume_to_carpi.html>RSL_volume_to_carpi</a>
  33
  34 <p>
  35 <hr>Author: <a href=mike.kolander.html>Mike Kolander</a>
  36 </body>