1.3.2.0 msmetadata.antennaids

NRAO Home > CASA > CASA Toolkit Reference Manual

msmetadata.antennaids - Function

1.3.2 Get the zero-based antenna ID for the specfied antenna name.

Description

Get the zero-based antenna IDs for the specfied antenna names and the specified diameter range for the specified observation ID. An array of unique IDs in order of the specified names is returned. Note that if a specified name is listed mulitple times in the ANTENNA table, the largest ID is returned, unless the observation ID is specified to be non-negative, in which case, the returned IDs are filtered based on the specified observation ID. If no names and no diameter range is specified, all IDs are returned.

Arguments


Inputs
name	Antenna names (string or string array) for which to get the corresponding IDs. Note that * matches any number of characters of all character classes.
	allowed:	any
	Default:	variant
mindiameter	Minimum antenna diameter, expressed as a quantity.
	allowed:	any
	Default:	variant 0m
maxdiameter	Maximum antenna diameter, expressed as a quantity.
	allowed:	any
	Default:	variant 1pc
obsid	Observation ID. If negative, all observation IDs are considered.
	allowed:	int
	Default:	-1

Returns
intArray

Example

    msmd.open("my.ms")
    # get the zero-based antenna IDs for the antenna named "VB2"
    antenna_id = msmd.antennaids("VB2")[0]
    # get the zero-based antenna IDs for all antennas with diameters between 9m and 11m
    antenna_ids = msmd.antennaids(mindiameter="9m", maxdiameter=qa.quantity("11m"))
    msmd.done()

__________________________________________________________________

[next] [prev] [prev-tail] [front] [up]

More information about CASA may be found at the CASA web page

This code is available under the terms of the GNU General Public Lincense