Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1488

News	FAQ
Search	Home

bimams.spwidsbyname - Function

	Package	bima
	Module	bimams
	Tool	bimams

Get a list of spectral window ids by specifying a list of spectral window names

Synopsis
spwidsbyname(names)

Description
Get a 1-based vector of spectral window ids (row numbers) from the SPECTRAL_WINDOW subtable by specifying a vector of names of the windows. A vector of integers of the same length as the input name vector is returned. For names which are not found in the spectral window table, -1 will occupy that place in the returned vector.

Arguments

names		The names of the spectral windows
		Allowed:	Vector of strings

Returns
Vector of integers: the ids (row numbers) of the specified windows (-1 for names which do not exist in the table)
.

Example

# construct a bimams tool and assign it to a Glish variable named bms
bms := bimams('neptune.ms');
# assign spectral window number 3 the name of HCN
bms.namespwid(id=3,name='HCN');
# assign spectral window number 7 the name of CS
bms.namespwid(id=7,name='CS');
# get the spectral window ids of the window named CS, HCN, and SiO
bms.spwidsbyname(names = ['CS','HCN','SiO']);

The last command returns [7, 3, -1] (the user has not yet named a window SiO, which is why the final value in the vector is -1).