AIPS HELP file for UVRMS in 31DEC24
As of Sat Apr 20 7:53:47 2024
UVRMS: Computes 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 Stokes of output
TIMERANG Time range to use
SELBAND Bandwidth to select (kHz)
SELFREQ Frequency to select (MHz)
FREQID Freq. ID to select.
ANTENNAS Antennas to include 0=>all
BASELINE Baselines with ANTENNAS
UVRANGE UV range in kilolambda.
SUBARRAY 0.0 1000.0 Sub-array, 0=>all
BIF Low IF number included
EIF Highest IF number included
BCHAN 0.0 First channel included
ECHAN 0.0 last channel included
DOCALIB -1.0 101.0 > 0 calibrate data & weights
> 99 do NOT calibrate weights
GAINUSE CL (or SN) table to apply
DOPOL -1.0 10.0 If >0.5 correct polarization.
PDVER PD table to apply (DOPOL>0)
BLVER BL table to apply.
FLAGVER Flag table version
DOBAND -1.0 10.0 If >0.5 apply bandpass cal.
Method used depends on value
of DOBAND (see HELP file).
BPVER Bandpass table version
SMOOTH Smoothing function. See
HELP SMOOTH for details.
OPTYPE Desired parameter: AMP,
PHAS, REAL, IMAG, AUTO,
SAMP
DOWEIGHT > 0 use weights when
averaging over baselines
SOLINT Averaging time (min)
DOPLOT 1,3 => plot the histogram
2,3 => plot vs time
NBOXES Number boxes in histogram
PIXRANGE Range of values in histogram
FUNCTYPE 'LG' use LOG10 in hist. plot
APARM (1,2) Plot range of time plot
DOTV > 0 -> plot on TV, else make
a plot file
GRCHAN Graphics channel to use
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
PIXAVG @ Mean pixel value
PIXSTD @ RMS about mean pixel value
HELP SECTION
UVRMS
Task: This task applies calibration to a selected subset of a uv
data file and then averages all included data over the
stated averaging time. The resulting list of values is
analyzed for various statistical properties: mean, rms,
median, median absolute deviation, max, min, and more.
Note that this combines data from different baselines,
sources, channels, etc. unless limited by the adverb
values.
The task returns the mean and standard deviation in adverbs
PIXAVG and PIXSTD.
It is strongly recommended to generate also a plot of the
histogram with DOPLOT = 1 or 3. The statistics will look
reasonable, but the histogram may show multiple peaks not
related to simple statistics. The locations of the median
and 1st and 3rd quartiles are indicated on the plot.
DOPLOT = 2 or 3 requests a plot of the values versus time.
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.....Specifies which STOKES parameter is included.
'I','Q','U','V', 'RR','LL', 'RL', 'LR',
'VV','HH', 'VH', 'HV'
Note: only 1 Stokes allowed.
TIMERANG...Time range of the data to be included. In order: Start day,
hour, min. sec, end day, hour, min. sec. Days relative to
ref. date.
SELBAND....Bandwidth of data to be selected. If more than one IF is
present SELBAND is the width of the first IF required.
Units = kHz. For data which contain multiple
bandwidths/frequencies the task will insist that some form
of selection be made by frequency or bandwidth.
SELFREQ....Frequency of data to be selected. If more than one IF is
present SELFREQ is the frequency of the first IF required.
Units = MHz.
FREQID.....Frequency identifier to select (you may determine which is
applicable from the OPTYPE='SCAN' listing produced by
LISTR). If either SELBAND or SELFREQ are set, their values
override that of FREQID. However, setting SELBAND and
SELFREQ may result in an ambiguity. In that case, the task
will request that you use FREQID.
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.
BASELINE...Baselines between antennas named in ANTENNAS and those
named in BASELINE are selected.. There are four possible
combinations of ANTENNAS and BASELINE:
1. ANTENNAS = 0; BASELINE = 0.
All possible baselines are selected.
2. ANTENNAS <>0; BASELINE = 0.
a)All ANTENNAS > 0
Baselines including an antenna in the ANTENNAS list
are selected;
b)Some ANTENNAS < 0
All baselines NOT including an antenna in the ANTENNAS
list are selected;
3. ANTENNAS = 0; BASELINE <> 0.
a)All BASELINE > 0
Baselines including an antenna in the BASELINE list
are selected;
b)Some BASELINE < 0
All baselines NOT including an antenna in the BASELINE
list are selected;
4. ANTENNAS <> 0; BASELINE <> 0.
a)All ANTENNAS>0 and all BASELINE>0
Baselines between antennas named in ANTENNAS and those
named in BASELINE are selected.
b)Some ANTENNAS<0 .OR. some BASELINE<0
Baselines between antennas named in ANTENNAS and
those named in BASELINE are DE-selected, all others
are selected.
UVRANGE....Range of projected spacings to be plotted in 1000's of
wavelengths. 0 => 1, 1.E10
SUBARRAY...Sub-array number to include. 0=>all.
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
DOCALIB....If true (>0), calibrate the data using information in the
specified Cal (CL) table for multi-source or SN table for
single-source data. Also calibrate the weights unless
DOCALIB > 99 (use this for old non-physical weights).
GAINUSE....version number of the CL table to apply to multi-source
files or the SN table for single source files.
0 => highest.
DOPOL......If > 0 then correct data for instrumental polarization as
represented in the AN or PD table. This correction is
only useful if PCAL has been run or feed polarization
parameters have been otherwise obtained. See HELP DOPOL
for available correction modes: 1 is normal, 2 and 3 are
for VLBI. 1-3 use a PD table if available; 6, 7, 8 are
the same but use the AN (continuum solution) even if a PD
table is present.
PDVER......PD table to apply if PCAL was run with SPECTRAL true and
0 < DOPOL < 6. <= 0 => highest.
BLVER......Version number of the baseline based calibration (BL) table
to apply. <0 => apply no BL table, 0 => highest.
FLAGVER....specifies the version of the flagging table to be applied.
0 => highest numbered table.
<0 => no flagging to be applied.
DOBAND.....If true (>0) then correct the data for the shape of the
antenna bandpasses using the BP table specified by BPVER.
The correction has five modes:
(a) if DOBAND=1 all entries for an antenna in the table
are averaged together before correcting the data.
(b) if DOBAND=2 the entry nearest in time (including
solution weights) is used to correct the data.
(c) if DOBAND=3 the table entries are interpolated in
time (using solution weights) and the data are then
corrected.
(d) if DOBAND=4 the entry nearest in time (ignoring
solution weights) is used to correct the data.
(e) if DOBAND=5 the table entries are interpolated in
time (ignoring solution weights) and the data are then
corrected.
IMAGR uses DOBAND as the nearest integer; 0.1 is therefore
"false".
BPVER......Specifies the version of the BP table to be applied
0 => highest numbered table.
<0 => no bandpass correction 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.
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).
OPTYPE.....Type of data examined: 'AMP', 'PHAS', 'REAL', 'IMAG',
'SAMP' (scalar amplitude between baselines, times)
'AUTO' (autocorrelations only) else 'AMP'
Vector averaging with weights is used in averaging over
channels and IFs in each visibility. 'SAMP' selects
scalar averaging and 'AMP selects vector averaging over
all baselines and times in the data sample.
DOWEIGHT...Data weights are used when averaging a single visibility
record over channels and IFs. If DOWEIGHT > 0, they
are also used when averaging multiple baselines and times.
If DOWEIGHT <= 0, the task treats each baseline and time
as having the same weight.
SOLINT.....Averaging time in minutes: 0 -> 0.007
DOPLOT.....1 or 3 => plot the histogram of the data samples using
the following adverbs
2 or 4 => plot the averaged values versus time
NBOXES.....Number boxes in histogram: 16 - 1024. < 16 -> 256.
PIXRANGE...Range of values in histogram. 0 -> min to max
FUNCTYPE...'LG' use log of histogram value in plot
APARM......Plot range of values in time plot. APARM(2) <= APARM(1)
-> self scale.
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.....Graphics channel to use. 0 -> multiple
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