Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1488

News	FAQ
Search	Home

bimams.stokesid - Function

	Package	bima
	Module	bimams
	Tool	bimams

Get the system-defined id for the specified stokes parameter.

Synopsis
stokesid(stokes)

Description
Get the system-defined id for the specified stokes parameter as defined in aips/implement/Measures/Stokes.h.

Arguments

stokes		The stokes parameter (e.g., 'YY', 'I', etc.)
		Allowed:	String: a stokes parameter

Returns
Integer: The system defined stokes id (see aips/implement/Measures/Stokes.h
) or -1 if the stokes parameter is not recognized

Example

# construct a bimams tool and assign it to a Glish variable named bms
bms := bimams('neptune.ms');
# get the stokes id for stokes parameter YY
bms.stokesid('YY');

The last command returns 12.