Source
<description>Optional time, expressed as a measures epoch dictionary, if associated field has a polynomial in time reference direction or an ephemerides table attached it. Default value means evaluate at the origin TIME in the FIELD table</description>
<casaxml xmlns="http://casa.nrao.edu/schema/psetTypes.html"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://casa.nrao.edu/schema/casa.xsd
file:///opt/casa/code/tools/xml/casa.xsd"
>
<!--
***************************************************************************
** msmetadata.xml: defines the interface to the measurement set metadata tool.
**
** Copyright (C) 2007
** Associated Universities, Inc. Washington DC, USA.
**
** This library is free software; you can redistribute it and/or modify it
** under the terms of the GNU Library General Public License as published by
** the Free Software Foundation; either version 2 of the License, or (at your
** option) any later version.
**
** This library is distributed in the hope that it will be useful, but WITHOUT
** ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
** FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
** License for more details.
**
** You should have received a copy of the GNU Library General Public License
** along with this library; if not, write to the Free Software Foundation,
** Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
**
** Correspondence concerning AIPS++ should be addressed as follows:
** Internet email: aips2-request@nrao.edu.
** Postal address: AIPS++ Project Office
** National Radio Astronomy Observatory
** 520 Edgemont Road
** Charlottesville, VA 22903-2475 USA
**
***************************************************************************
-->
<tool name="msmetadata" module="msmd">
<shortdescription>Operations to retrieve metadata from a measurment set</shortdescription>
<keyword>ms</keyword>
<code>
<include>tools/ms/msmetadata_forward.h</include>
<private>
<include>tools/ms/msmetadata_private.h</include>
</private>
</code>
<description>
The msmd tool provides methods to retrieve metadata from measurement sets.
\medskip\noindent\textbf{Attaching to a Measurement Set}
The simplest and most common way to attach an msmd tool to a
measurement set is to use the <link
anchor="ms:msmd.open">msmd.open</link> method which requires that
you specify the name of the measurement set table.
NOTE: Any modifications to an MS while an associated msmd tool is open
will not be reflected in the msmd tool. You must close and reopen the tool
if you want to capture changes made to metadata of an MS if such a change
occurs.
<example>
\begin{verbatim}
Example:
msmd.open("3C273XC1.MS")
# get the number of spectral windows
nspw = msmd.nspw()
msmd.done()
\end{verbatim}
We open the tool by querying the MS for its metadata. We then get the number of spectral
windows in the dataset and close the tool.
</example>
</description>
<method type="constructor" name="msmetadata">
<shortdescription></shortdescription>
<description></description>
<input></input>
<example></example>
</method>
<method type="function" name="almaspws">
<shortdescription>Get a list of spectral window IDs with ALMA-specific attributes.</shortdescription>
<input>