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

   1 <HTML>
   2 <HEAD>
   3    <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
   4    <META NAME="GENERATOR" CONTENT="Mozilla/4.01b6C [en] (X11; I; Linux 2.0.28 i686) [Netscape]">
   5 </HEAD>
   6 <BODY>
   7 <A HREF="index.html"><IMG SRC="rsl.gif" HEIGHT=100 WIDTH=100></A><A HREF="index.html">&nbsp;</A>
   8 <HR>
   9 <BR>&nbsp;
  10 <BR>&nbsp;
  11 <H1>
  12 RSL_read_these_sweeps</H1>
  13
  14 <HR>
  15 <H3>
  16 Synopsis</H3>
  17 <B>#include "rsl.h"</B>
  18 <BR><B>void RSL_read_these_sweeps(char *sweep#, [char *sweep#...], NULL);</B>
  19 <BR>
  20 <HR>
  21 <H3>
  22 Description</H3>
  23 Call this routine prior to any ingest routine and only the sweeps specified
  24 will be stored in memory.&nbsp; This drastically reduces memory requirements
  25 and speeds up the ingest, especially, if you're only interesed in a few
  26 sweeps.&nbsp; This function is useful, for instance, when you're making
  27 images of the base sweeps.&nbsp; Why bother reading the entire file when
  28 you only need the first sweep? By default, all sweeps are ingested.&nbsp;
  29 The sweep# is a character string representing the sweep number, "4" for
  30 instance.&nbsp; Order does not matter.&nbsp; Specify NULL as the last argument.
  31 This signals this routine when to stop parsing&nbsp; for sweep numbers.&nbsp;
  32 The first sweep is "0".
  33
  34 <P>The list of possible sweep numbers is: "all", "none", "0", "1", ...
  35
  36 <P>Action or side-effects: A second call to this function over-rides any
  37 previous settings. In other words, multiple calls are not additive.&nbsp;
  38 Therefore, you must list all the sweeps you want in a single call.
  39
  40 <P>RSL_read_these_sweeps("1", "2", NULL);
  41
  42 <P>which&nbsp; reads the second and third sweep is not the same as:
  43
  44 <P>RSL_read_these_sweeps("1", NULL);
  45 <BR>RSL_read_these_sweeps("2", NULL);
  46
  47 <P>wherein, only the third (index 2) sweep is ingested.
  48 <BR>&nbsp;
  49
  50 <P>
  51 <HR>
  52 <H3>
  53 Return value</H3>
  54 Upon successful completion, RSL_read_these_sweeps silently sets a hidden
  55 array that each of the specific radar format ingest routines access.
  56 <BR>
  57 <HR>
  58 <H3>
  59 See also</H3>
  60 <A HREF="RSL_anyformat_to_radar.html">RSL_anyformat_to_radar</A>.
  61 <BR>
  62 <HR>Author: <A HREF="john.merritt.html">John H. Merritt</A>.
  63 </BODY>
  64 </HTML>