Changeset 1394 for trunk/doc

Timestamp:

08/16/07 10:21:27 (17 years ago)

Author:

Malte Marquarding

Message:

some minor fixes for typos and outdated info

File:

• trunk/doc/userguide.tex (modified) (19 diffs)

trunk/doc/userguide.tex

@@ -13 +13 @@
 \setlength{\parskip}{1ex}
 
-\title{ATNF Spectral Analysis Package\\User Guide v2.1\\DRAFT }
+\title{ATNF Spectral Analysis Package\\User Guide v2.2 }
 \author{Chris Phillips}
 
@@ -48 +48 @@
 package.
 
-This userguide has been updated for the ASAP 2.1. Please report any
+This userguide has been updated for the ASAP 2.2. Please report any
 mistakes you find.
 
@@ -58 +58 @@
 \item Epping - use hosts {\tt draco} or {\tt hydra}
 \item Narrabri - use host {\tt kaputar}
-\item Parkes - use host {\tt bourbon}
-\item Mopra - use host {\tt minos}
+\item Parkes - use host {\tt ?}
+\item Mopra - use host {\tt minos} or {\tt kaputar} if at Narrabri
 \end{itemize}
 
 Or use your own Linux desktop.
 
-{\em Note. ASAP2.1 only runs on ATNF Linux machines which have been
+{\em Note. ASAP2.2 only runs on ATNF Linux machines which have been
 updated to Debian Sarge and are using the ``DEBIANSarge''
 /usr/local. If your favourite machine has not been upgraded, send a
-request to your friendly IT support. At the time of writing asap 2.1
-does not run on hydra, bourbon or kaputar.}
+request to your friendly IT support.}
 
 \index{Running}To start asap log onto one of these Linux hosts and enter
@@ -166 +165 @@
 is un-ambiguous, or a list of possibilities will be
 given. Auto-completion works for the user object names as well as
-function names. It does not work for filenames, nor for function
+function names and even file names It does not work for for function
 arguments.
 
@@ -210 +209 @@
   ASAP>ls
   ASAP>cd /my/data/directory
-  ASAP>! mozilla&
+  ASAP>! firefox&
 \end{verbatim}
 
@@ -352 +351 @@
 
   # Equivalent to brief summary function call
-  ASAP>print scan
+  ASAP>print scans
 \end{verbatim}
 
@@ -422 +421 @@
   ASAP>selection.reset()              # Turn off selection
   ASAP>scans.set_selection(selection) # Apply the reset selection
+  ASAP>scans.set_selection() # alternative to reset selection
 
 \end{verbatim}
@@ -528 +528 @@
 
   # Select channel range for baselining
-  ASAP>scans.set_unit('channels')
+  ASAP>scans.set_unit('channel')
   ASAP>msk = scans.create_mask([100,400],[600,800])
 
@@ -542 +542 @@
 Example :
 \begin{verbatim}
-  ASAP>scans.set_unit('channels')
+  ASAP>scans.set_unit('channel')
   ASAP>msk = scans.create_mask([0,100],[900-1023], invert=True)
 \end{verbatim}
@@ -562 +562 @@
 
 \begin{verbatim}
-  ASAP>scans.set_unit('channels')
+  ASAP>scans.set_unit('channel')
   ASAP>msk1 = q.create_mask([0,100],[511,511],[900,1023],invert=True)
   ASAP>scans.set_unit('km/s')
@@ -614 +614 @@
 
 
-\subsection{Reader object}
-
-\index{Reader object}\index{Scantable!reader object}For more control
-when reading data into ASAP, the reader object should be used.  This
-has the option of only reading in a range of integrations, only a
-specified beam or IF and does not perform any scan averaging of the
-data, allowing analysis of the individual integrations.  Note that due
-to limitation of the RPFITS library, only one reader object can be
-open at one time reading RPFITS files.  To read multiple RPFITS files,
-the old reader must be destroyed before the new file is opened.
-However, multiple readers can be created and attached to SDFITS files.
-
-
-Example usage:
-
-\begin{verbatim}
-  ASAP>r = reader('2003-03-16_082048_t0002.rpf')
-  ASAP>r.summary()
-  ASAP>scan = r.read()
-  ASAP>del r
-\end{verbatim}
+%\subsection{Reader object}
+
+%\index{Reader object}\index{Scantable!reader object}For more control
+%when reading data into ASAP, the reader object should be used.  This
+%has the option of only reading in a range of integrations, only a
+%specified beam or IF and does not perform any scan averaging of the
+%data, allowing analysis of the individual integrations.  Note that due
+%to limitation of the RPFITS library, only one reader object can be
+%open at one time reading RPFITS files.  To read multiple RPFITS files,
+%the old reader must be destroyed before the new file is opened.
+%However, multiple readers can be created and attached to SDFITS files.
+%
+%
+%Example usage:
+%
+%\begin{verbatim}
+%  ASAP>r = reader('2003-03-16_082048_t0002.rpf')
+%  ASAP>r.summary()
+%  ASAP>scan = r.read()
+%  ASAP>del r
+%\end{verbatim}
 
 \section{Basic Processing}
@@ -649 +649 @@
 have a trailing ``\_R'' in the source name for data from Parkes and
 Mopra, and a trailing ``e'' or ``w'' for data from Tidbinbilla.
-This functions has two \cmd{mode}s. \cmd{paired} (the deafault), which assumes
+This functions has two \cmd{mode}s. \cmd{paired} (the default), which assumes
 matching adjacent pairs of source/reference scans and \cmd{time}, which finds
 the closest reference scan in time.
@@ -835 +835 @@
 telescope is wrong due to an incorrect noise diode calibration. This
 can easily be corrected for with the scale function. By default,
-\cmd{scale} only scans the spectra and not the corresponding Tsys.
+\cmd{scale} only scaless the spectra and not the corresponding Tsys.
 
 \begin{verbatim}
@@ -961 +961 @@
 
 \end{verbatim}
+
+One can also apply the inverse of \cmd{get\_scan} \cmd{drop\_scan}
 
 To copy a scantable the following does not work:
@@ -1402 +1404 @@
 \end{verbatim}
 
-For data with many IFs, such as from MOPS, the user it is recommended
-that the user creates their own line cstalog for the data and use this
+For data with many IFs, such as from MOPS, it is recommended
+that users creates their own line catalog table for the data and use this
 to set the rest frequency for each IF.
 
@@ -1658 +1660 @@
 size of the dataset which can be loaded. ASAP can use ``disk based''
 scan tables which cache the bulk of the scantable on disk and require
-significantly less memory usage.
+significantly less memory usage. This should be used for all MOPS data!
 
 To use disk based tables you either need to change the default in your
@@ -1679 +1681 @@
 {\bf NOTE: } Currently a bug in ipython means temporary files are not
 cleaned up properly when you exit ASAP. If you use disk based scan
-tables your directory will be left with 'tabXXXXX\_X' directories. These can
+tables your directory will be left with 'tmpXXXXX\_X' directories. These can
 be safely removed if ASAP is not running.
 
@@ -1692 +1694 @@
 {\em Currently mathematics between two scantables is not available }
 
-%  ASAP>sum = scan1+scan2
 \begin{verbatim}
   ASAP>scan2 = scan1+2.0
   ASAP>scan *= 1.05
+  ASAP>sum = scan1+scan2
 \end{verbatim}
 
@@ -1713 +1715 @@
 
 \hspace{1cm} http://www.python.org/doc/Introduction.html
+
+\hspace{1cm} http:/ipython.scipy.org
 
 \subsection{Running scripts}