Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 803

News	FAQ
Search	Home

Modules

After writing module documentation you need to include the module in the existing package .help file adding your module with the line:

\input{mypackage.help}

This example of module documentation comes from code/trial/apps/table/table.help.

\begin{ahmodule}{table}{Glish interface to table system}

\ahinclude{"table.g"}

\begin{ahdescription}
table allows creation of table objects inside Glish. The resulting
objects can be operated on in various ways:
\begin{itemize}
\item Creation of new tables,
\item Opening, deletion, cloning, copying of existing tables,
\item Set and put of table information strings,
\item Get and put of table cells, columns and keywords,
\item Iteration by subtables,
\item Access via table rows,
\item Browsing of tables,
\item Printing of a summary of a table,
\end{itemize}
In addition this module contains a number of global functions
related to tables.
\end{ahdescription}

\begin{ahexample}
\begin{verbatim}
include "table.g"
vis:=table("3C273XC1.MS", readonly=T);
vis.summary();
uvw:=vis.getcol("UVW");
spw:=table("3C273XC1.MS/SPECTRAL_WINDOW", readonly=T);
freq:=spw.getcell("REFERENCE_FREQUENCY", 1);
uvw*:=(1.420E9/freq);
vis.putcol("UVW", uvw);
vis.close();

\end{verbatim}

\end{ahexample}
\begin{ahseealso}
\ahlink{tablerow}{tablerow.label}
\ahlink{tableiterator}{tableiterator.label}
\end{ahseealso}

\ahobjs{}
\ahfuncs{}

.... Lots of stuff deleted

\end{ahmodule}