Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1488

News	FAQ
Search	Home

bimams.namespw - Function

	Package	bima
	Module	bimams
	Tool	bimams

Assign a name to a spectral window.

Synopsis
namespw(sb, type, mcn, 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). 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

sb		The sideband in which the window is located.
		Allowed:	'u' (usb) or 'l' (lsb)
type		type of spectral window
		Allowed:	's' (sibeband average), 'c' (multi-channel data), or 'a' (multi-channel average)
mcn		the 1-based location of this window in the SPECTRAL_WINDOWS table with respect to other windows of the same type and sideband (usually NOT the same as its row number in this table). Not used if type='s'
		Allowed:	Integer from 1 to the number of spectral windows of the specified type in the specified sideband
		Default:	1
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 the third multichannel data window in the lower sideband HCN
bms.namespw(sb='l', type='c', mcn=3, name='HCN');
# The result of the previous command is T if there is no window already
# named HCN. If there is, the function will fail.

# Now get the spectral window id of the window just named by using its 
# name

bms.spwidsbyname('HCN');

# the result of the previous command is the spectral window id (the
# row number of the spectral window in the SPECTRAL_WINDOWS table. For 
# example, 22.