AIPS NRAO AIPS HELP file for VBRFI in 31DEC25



As of Mon Dec 9 12:05:31 2024


VBRFI: Plots spectral statistics of a subset of a uv data set

INPUTS

INNAME                             Input UV file name (name)
INCLASS                            Input UV file name (class)
INSEQ             0.0     9999.0   Input UV file name (seq. #)
INDISK            0.0        9.0   Input UV file disk unit #
SOURCES                            Source name
QUAL            -10.0              Calibrator qualifier -1=>all
CALCODE                            Calibrator code '    '=>all
STOKES                             'RR', 'LL', 'VV', 'HH'
                                      else HALF
TIMERANG                           Time range to include
ANTENNAS                           Antennas to include 0=>all
BIF                                Low IF number included
EIF                                Highest IF number included
BCHAN             0.0              First channel included
ECHAN             0.0              last channel included
FLAGVER                            Flag table version
SMOOTH                             Smoothing function. See
                                   HELP SMOOTH for details.
SOLINT                             Average time in minutes
                                   (does not cross scan
                                   boundaries  0 -> 10)
OUTFILE                            Printed output file
DOPLOT           -1.0              > 0 Make plots = 2 omit mean
PIXRANGE                           Range of values in plot of
                                   mean.  =-1 for full range
                                   = 0 for most of full range
APARM                              (1,2) range of values in
                                   plot of standard deviation
                                   (as PIXRANGE)
                                   (3,4) range of values in
                                   plot of rms/mean
                                   (5) > 0 -> label x with
                                   channels not frequency
                                   (6)-(9) > 0 => omit
                                   corresponding plot
                                   (10) > 0 -> flag to omit
                                   mean or max and/or min
FACTOR                             Scale points by abs(FACTOR)
                                   < 0 -> points
DOTV                               > 0 -> plot on TV, else make
                                   a plot file
GRCHAN                             > 0 use one graphics channel
                                   NOT recommended
NPLOTS          0.0         9.0    Number plots/page
LTYPE        -410.0       410.0    Type of labeling: 1 border,
                                   2 no ticks, 3 - 6 standard,
                                   7 - 10 only tick labels
                                   <0 -> no date/time
BADDISK                            Disks to avoid for scratch

HELP SECTION

VBRFI
Task:  This task reads calibrated autocorrelation data to determine
       spectral characteristics.  In each scan and polarization it
       computes the mean and rms as a function of spectral channel.
       It then sums across scans and polarizations to determine the
       mean, then mean rms, and the mean rms/mean and the max and
       min of each of these parameters.  Finally it can print a
       text file with all these data and plot the 4 plots for each
       antenna.

       If GRCHAN = 0, the first plot for each antenna is a plot of the
       mean autocorrelation in green, mean rms/mean in blue, and mean
       rms in pink.  The next three plots are the mean autocorrelation,
       the mean rms, and the mean rms/mean.  Pink is the maximum, green
       the mean, and blue the minimum over scans andpolarizations.
Adverbs:
  INNAME.....Input UV file name (name).      Standard defaults.
  INCLASS....Input UV file name (class).     Standard defaults.
  INSEQ......Input UV file name (seq. #).    0 => highest.
  INDISK.....Disk drive # of input UV file.  0 => any.
  SOURCES....Source to be included.   '  '=> all; if any starts with a
             '-' then all except ANY source named.
  QUAL.......Qualifier of source to be included. -1 => all.
  CALCODE....Calibrator code of sources to include. ' '=> all.
  STOKES.....Allowed values: 'RR', 'LL', 'VV', 'HH'.  Else it does
             'HALF' which combines polarizations which may be needed
             to do statistics.
  TIMERANG...Time range of the data to be included. In order:
             Start day, hour, min. sec, end day, hour, min. sec.
             Days relative to reference date.
  ANTENNAS...A list of the antennas to be included.  All 0 => all.
             If any number is negative then all antennas listed are NOT
             included and all others are.
  BIF........First IF to include.  0 -> 1.
  EIF........Last IF to include.   0 -> max.
  BCHAN......First channel to include. 0=>all.
  ECHAN......Highest channel to include. 0=>all higher than BCHAN
  FLAGVER....specifies the version of the flagging table to be applied.
              0 => highest numbered table.
             <0 => no flagging to be applied.
  SMOOTH.....Specifies the type of spectral smoothing to be applied to
             a uv database . The default is not to apply any smoothing.
             SMOOTH=0 IS RECOMMENDED IN VBRFI.  VBPLT will allow later
             smoothing if desired from plots.
             The elements of SMOOTH are as follows:
             SMOOTH(1) = type of smoothing to apply: 0 => no smoothing
               To smooth before applying bandpass calibration
                 1 => Hanning, 2 => Gaussian, 3 => Boxcar, 4 => Sinc
               To smooth after applying bandpass calibration
                 5 => Hanning, 6 => Gaussian, 7 => Boxcar, 8 => Sinc
             SMOOTH(2) = the "diameter" of the function, i.e. width
               between first nulls of Hanning triangle and sinc
               function, FWHM of Gaussian, width of Boxcar. Defaults
               (if < 0.1) are 4, 2, 2 and 3 channels for SMOOTH(1) =
               1 - 4 and 5 - 8, resp.
             SMOOTH(3) = the diameter over which the convolving
               function has value - in channels.  Defaults: 1,3,1,4
               times SMOOTH(2) used when input SMOOTH(3) < net
               SMOOTH(2).
  SOLINT.....Average data for SOLINT minutes or until scan boundaries.
             0 -> 10 minutes.
  OUTFILE....Text file for detailed RFI report
  DOPLOT.....> 0 -> make plots of the RFI spectra, following adverbs
             apply.  NOTE: if OUTFILE=' ' and DOPLOT<=0, nothing comes
             out of this task.  If DOPLOT >= 2.0, the mean plot line
             is not plotted.  Note that if the mean is exactly the
             average of the max and min, the line is also not plotted.
  PIXRANGE...Range of values in plot of mean.  <0 -> min to max
             Actually PIXR(2) <= PIXR(1) causes the plot to do the
             full range of values if PIXR(2) < 0.  PIXR(2) = 0 causes
             the plot to scale to omit up to 5 percent of the samples.  This
             often makes the plot show the remaining points much
             better.  The number of points in each IF that is omitted is
             plotted (twice) in each IF panel and printed.
  APARM......If APARM(2) > APARM(1), use this range when plotting the
             standard deviation.  APARM(2) = 0 is like PIXR(2) = 0
             to compress the plot range by omitting at most 5 percent of the
             points.
             If APARM(4) > APARM(3), use this range when plotting the
             standard deviation.  APARM(4) = 0 is like PIXR(2) = 0
             to compress the plot range by omitting at most 5 percent of the
             points.
             If APARM(5) > 0, the X axis is labeled with spectral
             channels rather than frequency.
             If APARM(6) > 0, omit the first plot (all 3)
             If APARM(7) > 0, omit the second plot (mean)
             If APARM(8) > 0, omit the third plot (rms)
             If APARM(9) > 0, omit the fourth plot (rms/mean)
             APARM(10) is a mask to exclude the mean (1), min (2),
             and/or max (4) curves.  Thus APARM(10)=6 excludes both
             max and min curves.
  FACTOR.....>= 0 -> Plot data with connected lines
             < 0  -> Scale plotted points by abs(FACTOR).  0 -> 1.0
  DOTV.......> 0 => plot directly on the TV device, otherwise make a
             plot file for later display on one or more devices
             (including the TV if desired).
  GRCHAN.....> 0 -> use a specific graphics channel
             0 -> use different colors for max (pink), mean (green), and
                  min (cyan) where the colors listed are the defaults
                  for graphics channels 3, 2, and 4, resp.
  NPLOTS.....Number of plots per page: 1 - 9.
  LTYPE......Labelling type, see HELP LTYPE for details:
             1 = border, 2 = no ticks, 3 or 7 = standard, 4 or 8 =
             relative to ref. pixel, 5 or 9 = relative to subimage
             (BLC, TRC) center, 6 or 10 = pixels.  7-10 all labels
             other than tick numbers and axis type are omitted.
             Less than 0 is the same except that the plot file
             version number and create time are omitted.
             Add n * 100 to alter the metric scaling.
  BADDISK....The disk numbers to avoid for scratch files (sorting
             tables mostly).

EXPLAIN SECTION


AIPS