mirfiller - Constructor

Construct a mirfiller tool

Synopsis
mirfiller(mirfile, preview, defpass)

Description
This creates a mirfiller tool attached to a Miriad dataset. The Miriad dataset is opened and, by default, is scanned to determine its contents. A summary of the contents is then sent to the logger, listing useful information such as the number of array configurations found, the source names, and, most importantly, the frequency setups found.

Based on what it finds in the dataset, mirfiller will determine what ``flavor'' Miriad visibility dataset it is. Currently recognized are:

Uncalibrated BIMA data: this is data that has a frequency layout in convention used by the BIMA telescope. (See ``MIRIAD Dataset Spectral Layout and its Mapping to the Measurement Set'' section of the mirfiller tool description.)
Calibrated BIMA data: Currently, this ``flavor'' is matched for any BIMA dataset that appears to be missing spectral line windows or window averages. The rationale is that this is an indication that the data has been calibrated and the undesired data have been dropped.
Generic Miriad data: This is any dataset that appears not to follow frequency layout at all.

After giving the summary, mirfiller will report which catagory above it believes this dataset belongs. Based on this determination, it will set the default window passing mode as appropriate. This mode can be overridden with via defpass parameter, either here or in the select() function. The major aim of this mode is to minimize the amount that the user must specify in terms window selection for the most common uses of the data.

Arguments

mirfile	the file name of the Miriad dataset
preview	if true, the file will be scanned in full to determine its contents. It may be helpful to set this to false for very large files. In this case, only the beginning of the file is scanned, and the default defpass value is based on the limited information read.
	Default:	T
defpass	a string indicating the default window passing mode to use. This mode affects the which kinds of windows get passed when they are not explicitly specified by the select() function.
	Allowed:	'default' - let mirfiller determine which mode to use based on what is found in the data; 'rawbima' - use a default appropriate for uncalibrated BIMA data: pass all spectral line windows and both side band averages but no window averages; 'calbima' - use a default appropriate for calibrated data: pass all spectral line windows but no wideband averages; 'all' - pass all windows and wideband channels by default; 'none' - pass no windows or wideband channels by default, require that they be specified explicitly with select().
	Default:	'default'

Returns
mirfiller tool

Example
This example attaches a mirfiller tool to the miriad dataset called 3c273 and assigns it to a Glish variable named frommir.

frommir := mirfiller('3c273')

This causes a summary to be sent to the logger which will look something like this:

Miriad UV dataset: 3c273
 Max. no. of visibility records:    990
 Max. no. of spectral line windows: 12 (Max no. of channels: 1280)
 Max. no. of wide-band channels:    14
 No. of array configurations:       1
 No. of polarizations:              1
 Time Range: 1997/11/02/19:44:55 - 1997/11/02/20:03:35
Sources:
     3C273      12:29:06.70     +02.03.08.60 (1 field)
Frequency Setup:
   Mode 6, 1280 line channels, 14 wide channels
 Window  #chans   start freq.     increment    bandwidth    rest freq.
    1      256   93.17534 GHz     -48.83 kHz   12.50 MHz    93.17378 GHz
    2       32   93.11704 GHz   -3125.00 kHz  100.00 MHz    96.41298 GHz
    3       32   93.01704 GHz   -3125.00 kHz  100.00 MHz    96.41298 GHz
    4      256   92.87483 GHz     -48.83 kHz   12.50 MHz    96.41298 GHz
    5       32   92.81705 GHz   -3125.00 kHz  100.00 MHz    96.41298 GHz
    6       32   92.71705 GHz   -3125.00 kHz  100.00 MHz    96.41298 GHz
    7      256   96.10183 GHz      48.83 kHz   12.50 MHz    96.41298 GHz
    8       32   96.16013 GHz    3125.00 kHz  100.00 MHz    96.41298 GHz 
    9       32   96.26013 GHz    3125.00 kHz  100.00 MHz    96.41298 GHz
   10      256   96.40233 GHz      48.83 kHz   12.50 MHz    96.41298 GHz
   11       32   96.46011 GHz    3125.00 kHz  100.00 MHz    96.41298 GHz
   12       32   96.56011 GHz    3125.00 kHz  100.00 MHz    96.41298 GHz
Input looks like a raw BIMA dataset; setting default defpass="rawbima"

Next: mirfiller.select - Function Up: mirfiller - Tool Previous: Polarization Contents Index

	Package	bima
	Module	mirfiller
	Tool	mirfiller