Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1488

News	FAQ
Search	Home

bimams.ddid - Function

	Package	bima
	Module	bimams
	Tool	bimams

get the DATA_DESCRIPTION ID (row number) associated with a specified spectral window id and a polarization or polarization id.

Synopsis
ddid(spwid, stokes, polid)

Description
Retrieve the (1-based) DATA_DESCRIPTION ID (row number) based on the SPECTRAL_WINDOW ID and stokes parameter or polarization id. Returns -1 if the specified description doesn't exist in the table.

Arguments

spwid		The 1-based id (row number) of the spectral window in the SPECTRAL_WINDOWS subtable
		Allowed:	Integer
stokes		The stokes parameter associated with the data description. Not used if polid is specified
		Allowed:	String representation of a valid stokes parameter.
		Default:	YY
polid		The 1-based id (row number) of the desired polarization in the POLARIZATION subtable. If specified, stokes is ignored.
		Allowed:	Integer > 0

Returns
Integer (-1 if requested id does not exist)

Example

# get a data description id based on a spectral window id and a stokes
# parameter
# construct a bimams tool and assign it to a Glish variable named bms
bms := bimams('neptune.ms');
#  get the data description id associated with spectral window id 10
# a stokes parameter of YY
bms.ddid(spwid=10,stokes='YY');

The result is 10.