Pileus Git - ~andy/rsl/blob - doc/RSL_hdf_to_radar.html

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3.2//EN">
   2 <HTML>
   3 <HEAD>
   4    <TITLE></TITLE>
   5    <META NAME="GENERATOR" CONTENT="Mozilla/3.0b5aGold (X11; I; Linux 1.3.91 i586) [Netscape]">
   6 </HEAD>
   7 <BODY>
   8 <a HREF="index.html"> <IMG SRC="rsl.gif"> </a>
   9 <hr>
  10
  11 <H1>RSL_hdf_to_radar<BR>
  12 RSL_hdf_to_radar_unQC</H1>
  13
  14 <P>
  15 <HR></P>
  16
  17 <H3>Synopsis</H3>
  18
  19 <P><B>#include &quot;rsl.h&quot; <BR>
  20 <A HREF="RSL_radar_struct.html">Radar</A> *RSL_hdf_to_radar(char *infile);</B>
  21 <BR>
  22 <B><A HREF="RSL_radar_struct.html">Radar</A> *RSL_hdf_to_radar_unQC(char
  23 *infile);</B>
  24 <HR></P>
  25
  26 <H3>Description</H3>
  27
  28 <P>Reads an HDF file and returns a pointer to the structure <I>Radar</I>.
  29 The input file is specified by the string <I>infile</I>. If <I>infile</I>
  30 is NULL, then no action is taken. This is different from other ingest routines
  31 where stdin is read. HDF files cannot be stdin, because they require seeking..
  32 The input file may <B>not</B> be compressed.</P>
  33
  34 <P><B>RSL_hdf_to_radar_unQC</B> differs from <B>RSL_hdf_to_radar</B> in
  35 that both DZ (original uncorrected reflectivity) and CZ (corrected) volumes
  36 are extracted from the HDF&nbsp;file. Normally, <B>RSL_hdf_to_radar</B>
  37 returns CZ only. Call one or the other, for ingest efficiency.</P>
  38
  39 <P>The radar structure is, essentially, an array of Volumes. The number
  40 and type of volumes allocated is automatically determined from the input
  41 HDF file.
  42 <HR></P>
  43
  44 <H3>Return value</H3>
  45
  46 <P>Upon successful completion, <B>RSL_hdf_to_radar</B> returns a pointer
  47 to the structure <B>Radar</B>. Otherwise, NULL is returned and errno is
  48 set.
  49 <HR></P>
  50
  51 <H3>See also</H3>
  52
  53 <P><A HREF="RSL_anyformat_to_radar.html">RSL_anyformat_to_radar </A>
  54 <HR></P>
  55
  56 <P>Author: <A HREF="mike.kolander.html">Mike Kolander</A>.</P>
  57
  58 </BODY>
  59 </HTML>