bimams.spwids - Function

Get a list of spectral window ids by specifying a type of spectral window and, optionally, a sideband

Synopsis
spwids(type, sb)

Description
Get a 1-based vector of spectral window ids (row numbers) from the SPECTRAL_WINDOW subtable by specifying a type of spectral window (sideband average, multi-channel data, multi-channel average) and, optionally, a sideband. A vector of integers of the ids of all windows of the specified type in the specified sideband is returned.

Arguments

type	The spectral window type
	Allowed:	String: 'A' (all types), 'a' (multi-channel average), 'c' (multi-channel data), or 's' (sideband average)
sb	The sideband. Not used if type='s'
	Allowed:	String: 'b' (both), 'l' (lsb), 'u' (usb)
	Default:	'b'

Returns
Vector of integers: the ids (row numbers) of all the windows of the specified type.

Example

# construct a bimams tool and assign it to a Glish variable named bms
bms := bimams('neptune.ms');
# get the a list of ids of all the multi-channel data windows in both
# sidebands 
bms.spwids(type='c', sb='b');
# The previous command returns a vector of integers representing the
# ids of all the multi-channel data windows, e.g., [4 6 8 10 12 14 16 18
# 20 22 24 26].

# get the ids for the multi-channel data windows from the upper
# sideband only
bms.spwids(type='c', sb='u');
# the previous command returns [16 18 20 22 24 26]

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

	Package	bima
	Module	bimams
	Tool	bimams