bimams.namespwid - Function

Assign a name to a spectral window by specifying its id

Synopsis
namespwid(spwid, name)

Description
Assign a name to a spectral window (that is, insert a value into the NAME column of the specified window's row in the SPECTRAL_WINDOWS table) by specifying the window's id (ie, row number in the SPECTRAL_WINDOWS table). After assigning a name, other functions can be used to retrieve information on spectral windows by specifying their names. BIMA vertical integration tools require that user-specified spectral window names be unique (this is not a requirement of the measurement set specification, however). Therefore, this function will not assign a name to a spectral window if another window different from the specified one already has that name. In this case, this function will fail.

Arguments

spwid	The 1-based id of the spectral window (ie, the row number of the window in the SPECTRAL_WINDOWS table)
	Allowed:	Integer > = 1 and < = number of spectral windows
name	the name to assign to this window
	Allowed:	String

Returns
Boolean: T if naming was successful.

Example

# construct a bimams tool and assign it to a Glish variable named bms
bms := bimams('neptune.ms');
# name window number 3 CS
bms.namespw(spwid=3, name='CS');
# The result of the previous command is T if there is no window already
# named CS. If there is, the function will fail.

Next: bimams.nchans - Function Up: bimams - Tool Previous: bimams.namespw - Function Contents Index

	Package	bima
	Module	bimams
	Tool	bimams