Changeset 1394 for trunk/doc


Ignore:
Timestamp:
08/16/07 10:21:27 (17 years ago)
Author:
Malte Marquarding
Message:

some minor fixes for typos and outdated info

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/userguide.tex

    r1347 r1394  
    1313\setlength{\parskip}{1ex}
    1414
    15 \title{ATNF Spectral Analysis Package\\User Guide v2.1\\DRAFT }
     15\title{ATNF Spectral Analysis Package\\User Guide v2.2 }
    1616\author{Chris Phillips}
    1717
    … …  
    4848package.
    4949
    50 This userguide has been updated for the ASAP 2.1. Please report any
     50This userguide has been updated for the ASAP 2.2. Please report any
    5151mistakes you find.
    5252
    … …  
    5858\item Epping - use hosts {\tt draco} or {\tt hydra}
    5959\item Narrabri - use host {\tt kaputar}
    60 \item Parkes - use host {\tt bourbon}
    61 \item Mopra - use host {\tt minos}
     60\item Parkes - use host {\tt ?}
     61\item Mopra - use host {\tt minos} or {\tt kaputar} if at Narrabri
    6262\end{itemize}
    6363
    6464Or use your own Linux desktop.
    6565
    66 {\em Note. ASAP2.1 only runs on ATNF Linux machines which have been
     66{\em Note. ASAP2.2 only runs on ATNF Linux machines which have been
    6767updated to Debian Sarge and are using the ``DEBIANSarge''
    6868/usr/local. If your favourite machine has not been upgraded, send a
    69 request to your friendly IT support. At the time of writing asap 2.1
    70 does not run on hydra, bourbon or kaputar.}
     69request to your friendly IT support.}
    7170
    7271\index{Running}To start asap log onto one of these Linux hosts and enter
    … …  
    166165is un-ambiguous, or a list of possibilities will be
    167166given. Auto-completion works for the user object names as well as
    168 function names. It does not work for filenames, nor for function
     167function names and even file names It does not work for for function
    169168arguments.
    170169
    … …  
    210209  ASAP>ls
    211210  ASAP>cd /my/data/directory
    212   ASAP>! mozilla&
     211  ASAP>! firefox&
    213212\end{verbatim}
    214213
    … …  
    352351
    353352  # Equivalent to brief summary function call
    354   ASAP>print scan
     353  ASAP>print scans
    355354\end{verbatim}
    356355
    … …  
    422421  ASAP>selection.reset()              # Turn off selection
    423422  ASAP>scans.set_selection(selection) # Apply the reset selection
     423  ASAP>scans.set_selection() # alternative to reset selection
    424424
    425425\end{verbatim}
    … …  
    528528
    529529  # Select channel range for baselining
    530   ASAP>scans.set_unit('channels')
     530  ASAP>scans.set_unit('channel')
    531531  ASAP>msk = scans.create_mask([100,400],[600,800])
    532532
    … …  
    542542Example :
    543543\begin{verbatim}
    544   ASAP>scans.set_unit('channels')
     544  ASAP>scans.set_unit('channel')
    545545  ASAP>msk = scans.create_mask([0,100],[900-1023], invert=True)
    546546\end{verbatim}
    … …  
    562562
    563563\begin{verbatim}
    564   ASAP>scans.set_unit('channels')
     564  ASAP>scans.set_unit('channel')
    565565  ASAP>msk1 = q.create_mask([0,100],[511,511],[900,1023],invert=True)
    566566  ASAP>scans.set_unit('km/s')
    … …  
    614614
    615615
    616 \subsection{Reader object}
    617 
    618 \index{Reader object}\index{Scantable!reader object}For more control
    619 when reading data into ASAP, the reader object should be used.  This
    620 has the option of only reading in a range of integrations, only a
    621 specified beam or IF and does not perform any scan averaging of the
    622 data, allowing analysis of the individual integrations.  Note that due
    623 to limitation of the RPFITS library, only one reader object can be
    624 open at one time reading RPFITS files.  To read multiple RPFITS files,
    625 the old reader must be destroyed before the new file is opened.
    626 However, multiple readers can be created and attached to SDFITS files.
    627 
    628 
    629 Example usage:
    630 
    631 \begin{verbatim}
    632   ASAP>r = reader('2003-03-16_082048_t0002.rpf')
    633   ASAP>r.summary()
    634   ASAP>scan = r.read()
    635   ASAP>del r
    636 \end{verbatim}
     616%\subsection{Reader object}
     617
     618%\index{Reader object}\index{Scantable!reader object}For more control
     619%when reading data into ASAP, the reader object should be used.  This
     620%has the option of only reading in a range of integrations, only a
     621%specified beam or IF and does not perform any scan averaging of the
     622%data, allowing analysis of the individual integrations.  Note that due
     623%to limitation of the RPFITS library, only one reader object can be
     624%open at one time reading RPFITS files.  To read multiple RPFITS files,
     625%the old reader must be destroyed before the new file is opened.
     626%However, multiple readers can be created and attached to SDFITS files.
     627%
     628%
     629%Example usage:
     630%
     631%\begin{verbatim}
     632%  ASAP>r = reader('2003-03-16_082048_t0002.rpf')
     633%  ASAP>r.summary()
     634%  ASAP>scan = r.read()
     635%  ASAP>del r
     636%\end{verbatim}
    637637
    638638\section{Basic Processing}
    … …  
    649649have a trailing ``\_R'' in the source name for data from Parkes and
    650650Mopra, and a trailing ``e'' or ``w'' for data from Tidbinbilla.
    651 This functions has two \cmd{mode}s. \cmd{paired} (the deafault), which assumes
     651This functions has two \cmd{mode}s. \cmd{paired} (the default), which assumes
    652652matching adjacent pairs of source/reference scans and \cmd{time}, which finds
    653653the closest reference scan in time.
    … …  
    835835telescope is wrong due to an incorrect noise diode calibration. This
    836836can easily be corrected for with the scale function. By default,
    837 \cmd{scale} only scans the spectra and not the corresponding Tsys.
     837\cmd{scale} only scaless the spectra and not the corresponding Tsys.
    838838
    839839\begin{verbatim}
    … …  
    961961
    962962\end{verbatim}
     963
     964One can also apply the inverse of \cmd{get\_scan} \cmd{drop\_scan}
    963965
    964966To copy a scantable the following does not work:
    … …  
    14021404\end{verbatim}
    14031405
    1404 For data with many IFs, such as from MOPS, the user it is recommended
    1405 that the user creates their own line cstalog for the data and use this
     1406For data with many IFs, such as from MOPS, it is recommended
     1407that users creates their own line catalog table for the data and use this
    14061408to set the rest frequency for each IF.
    14071409
    … …  
    16581660size of the dataset which can be loaded. ASAP can use ``disk based''
    16591661scan tables which cache the bulk of the scantable on disk and require
    1660 significantly less memory usage.
     1662significantly less memory usage. This should be used for all MOPS data!
    16611663
    16621664To use disk based tables you either need to change the default in your
    … …  
    16791681{\bf NOTE: } Currently a bug in ipython means temporary files are not
    16801682cleaned up properly when you exit ASAP. If you use disk based scan
    1681 tables your directory will be left with 'tabXXXXX\_X' directories. These can
     1683tables your directory will be left with 'tmpXXXXX\_X' directories. These can
    16821684be safely removed if ASAP is not running.
    16831685
    … …  
    16921694{\em Currently mathematics between two scantables is not available }
    16931695
    1694 %  ASAP>sum = scan1+scan2
    16951696\begin{verbatim}
    16961697  ASAP>scan2 = scan1+2.0
    16971698  ASAP>scan *= 1.05
     1699  ASAP>sum = scan1+scan2
    16981700\end{verbatim}
    16991701
    … …  
    17131715
    17141716\hspace{1cm} http://www.python.org/doc/Introduction.html
     1717
     1718\hspace{1cm} http:/ipython.scipy.org
    17151719
    17161720\subsection{Running scripts}
Note: See TracChangeset for help on using the changeset viewer.