Pileus Git - ~andy/rsl/blob - doc/RSL_get_volume.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_get_volume</h1>
  10
  11 <hr>
  12
  13 <h3>Synopsis</h3>
  14 <b>#include &quot;rsl.h&quot;</b> <br>
  15 <b><a href=RSL_volume_struct.html>Volume</a> *RSL_get_volume(<a href=RSL_radar_struct.html><a href=RSL_radar_struct.html>Radar</a></a> *r, int type_wanted);</b>
  16
  17 <h3>
  18 <hr>Description</h3>
  19 <b>RSL_get_volume</b> extracts the desired volume from the <b>Radar</b> *<b>r</b>. <b>type_wanted</b> can be one of: DZ_INDEX, VR_INDEX, SW_INDEX, CZ_INDEX, ZT_INDEX, DR_INDEX or LR_INDEX. Only the pointer is copied for the returned value. If you want to optain a seperate copy of the volume, from the Radar *r, for modification purposes, then use <a href=RSL_copy.html>RSL_copy_volume</a>. The different indexes are described as follows:
  20
  21 <pre> DZ        Reflectivity (dBZ), may contain some    DZ_INDEX
  22         signal-processor level QC and/or
  23         filters. This field would contain
  24         Darwin's CZ, or WSR88D's standard
  25         reflectivity. In other words, unless
  26         the field is described otherwise, it
  27         should always go here. In essence, this
  28         is the &quot;cleanest&quot; reflectivity field
  29         for a radar.
  30
  31  VR     Radial Velocity (m/s)           VR_INDEX
  32
  33  SW     Spectral Width (m2/s2)          SW_INDEX
  34
  35  CZ     QC Reflectivity (dBZ), contains
  36         post-processed QC'd data                CZ_INDEX
  37
  38  ZT     Total Reflectivity (dBZ)                ZT_INDEX
  39         May be uncommon, but important
  40
  41  DR     Differential reflectivity               DR_INDEX
  42         DR and LR are for dual-polarization
  43         radars only. Unitless or in dB.
  44
  45  LR     Another form of differential ref        LR_INDEX
  46         called LDR, not sure of units
  47
  48 </pre>This function is a one line C function. Observe the following:
  49
  50 <pre>Radar *radar;
  51 Volume *v;
  52 /* The following two lines are identical. */
  53 v = Vget_volume(radar, DZ_INDEX);
  54 v = radar-&gt;v[DZ_INDEX];
  55 </pre>
  56 <hr>
  57
  58 <h3>Return value</h3>
  59 Upon successful completion, a pointer to the Volume structure is returned; only the pointer is copyied.
  60 <hr>
  61
  62 <h3>See also</h3>
  63 <a href=RSL_get_sweep.html>RSL_get_sweep</a>, <a href=RSL_get_ray.html>RSL_get_ray</a><br>
  64 <a href=RSL_copy.html>RSL_copy_volume</a>, <a href=RSL_copy.html>RSL_copy_sweep</a>, <a href=RSL_copy.html>RSL_copy_ray</a><br>
  65 <a href=RSL_free.html>RSL_free_volume</a>, <a href=RSL_free.html>RSL_free_sweep</a>, <a href=RSL_free.html>RSL_free_ray</a>
  66 <hr>
  67
  68 <p>Author: <a href=john.merritt.html>John H. Merritt</a>
  69 </body>