1.3.2.0 msmetadata.spwsfornames

NRAO Home > CASA > CASA Toolkit Reference Manual

msmetadata.spwsfornames - Function

1.3.2 Get the IDs of the specified spw names.

Description

Get the IDs of the specified spw(s). Returns a dictionary where the keys are the requested spectral window names that are present in the data set and the values are arrays of the spectral window IDs corresponding to the name. If a specified name is not present, a warning message is logged and that name is not included in the returned dictionary. Specifying no names results in a dictionary containing the name to spw ID mapping for the entire data set.

Arguments


Inputs
spwids	Names of the spws for which IDs are needed (string or string array). Unspecified will return all spw names.
	allowed:	any
	Default:	variant

Returns
record

Example

    msmd.open("my.ms")
    # get the IDs for spws named "CO" and "HCN"
    spw_ids = msmd.spwsfornames(["CO", "HCN"])
    # get the complete spw name to ID map
    spw_names_to_ids = msmd.spwsfornames()
    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