vlafillerfromtape

Convert VLA archive data from a tape to a measurement set

Synopsis
vlafillerfromtape(msname, device, files, project, start, stop, bandname, source, overwrite, verbose, async, host)

Description

This global function prevents users from having to explicitly use the vlafiller tool by packaging its functions so they perform a common task ie., copying VLA archive data from tape to a measurement set.

There are only two arguments which the user must supply in order to successfully use this function, these are the device and msname arguments. These arguments specify the name of the tape device and the output measurement set. All other arguments are optional. See the tapeinput & output functions for more details.

A number of arguments control what data is copied to the output measurement set. These are:

project: See the selectproject function.
start & stop: See the selecttime function.
bandname: See the selectband function.
source: See the selectsource function^1.6.

The remaining arguments control details of the filling process. The overwrite argument specifies whether the output measurement set is deleted prior to copying the data. See the output function for more details.

The files argument controls which files on tape are to be read. The first file containing astronomical data is numbered file one and a number of files can be specified using a vector of increasing integers eg., files=[1,2,10]. See the tapeinput function for more details.

The verbose argument controls how much status information is sent to the logger and the async argument controls whether the function should run in the background. See the fill function for more details.

The host argument controls which machine this filler process is run on. This allows remote tape drives to be used. Unless you have done this before it is recommended you read the full description of this mechanism described in the vlafiller constructor.

This function returns T is everything went well and F otherwise.

Arguments

msname	The measurement set name.
	Allowed:	string
	Default:	no default
device	The tape device.
	Allowed:	string
	Default:	no default
files	The files to read.
	Allowed:	vector of integers
	Default:	[1]
project	The observing project name.
	Allowed:	string
	Default:	unset
start	The beginning of the time range.
	Allowed:	string
	Default:	unset
stop	The end of the time range.
	Allowed:	string
	Default:	unset
bandname	The frequency band to select.
	Allowed:	string
	Default:	unset
source	The source name.
	Allowed:	string
	Default:	unset
overwrite	Overwrite an existing file.
	Allowed:	Boolean
	Default:	F
verbose	Send messages when copying each record.
	Allowed:	Boolean
	Default:	F
async	Run this function asynchronously.
	Allowed:	Boolean
	Default:	T
host	The host on which the vlafiller should be run
	Allowed:	string
	Default:	unset

Returns
T or F

Example

      include 'vlafiller.g'
      vlafillerfromtape('ab123.ms', '/dev/rmt/0ln', files=[1,2], project='ab123');

This example creates the measurement set called 'ab123.ms' from all the records in the first two files of the tape that come from the observing project called 'AB123'.

Next: vlafillerfromdisk - Function Up: vla - Module Previous: vlafiller.done - Function Contents Index

	Package	nrao
	Module	vla

vlafillerfromtape - Function