bimams.spwid - Function

Get a spectral window id

Synopsis
spwid(sb, type, mcn)

Description
Get a 1-based spectral window id (row number) from the SPECTRAL_WINDOW subtable by specifying a sideband, spectral window type, and the position of the desired spectral window relative to other windows of the same type in the same sideband. If no window matching the specified parameters is found, -1 is returned.

Arguments

sb	The sideband in which the desired window is located
	Allowed:	String: 'l' (lsb) or 'u' (usb)
type	The type of window
	Allowed:	String: 's' (sideband average), 'c' (multi-channel data), or 'a' (multi-channel average)
mcn	The 1-based position of the desired window with respect to other windows of the same type in the same sideband. Usually NOT the same as the row number in the SPECTRAL_WINDOWS table
	Allowed:	Integer: > = 1 and < = the total number of windows of the specified type in the specified sideband. Not used if type='s'
	Default:	1

Returns
Integer: the id of the specified window or -1 if not found

Example

# construct a bimams tool and assign it to a Glish variable named bms
bms := bimams('neptune.ms');
# get the spectral window id of the the third multi-channel average
# window in the upper sideband
bms.spwid(sb='u',type='a',mcn=3);

The last command will return the corresponding row in the SPECTRAL_WINDOWS subtable, for example 7 or -1 if the specified window does not exist.

Next: bimams.spwidsbyname - Function Up: bimams - Tool Previous: bimams.sourcetable - Function Contents Index

	Package	bima
	Module	bimams
	Tool	bimams