Changeset 767 for branches/Release12

Timestamp:

12/01/05 14:21:49 (18 years ago)

Author:

phi196

Message:

Small typos and Tid example

File:

• branches/Release12/doc/cookbook.tex (modified) (9 diffs)

branches/Release12/doc/cookbook.tex

@@ -12 +12 @@
 \setlength{\parskip}{1ex}
 
-
 \title{ATNF Spectral Analysis Package\\User Guide }
 \author{Chris Phillips}
-
 
 \newcommand{\cmd}[1]{{\tt #1}}
@@ -170 +168 @@
 syntax, specifically they cannot contain ``special'' characters such
 as \@ \$ etc and cannot start with a number (but can contain numbers).
+Variable (and function) names are case sensitive.
 
 \subsubsection{Unix Interaction}
@@ -355 +354 @@
 
 Examples are the selection of beam, IF and polarisation,  spectral unit
-(e.g. km/s) frequency reference frame (e.g. BARY) and velocity Doppler
+(e.g. km/s), frequency reference frame (e.g. BARY) and velocity Doppler
 type (e.g. RADIO).
 
@@ -594 +593 @@
 Quotients can be computed ``automatically''. This requires the data to
 have matching source/reference pairs or one reference for multiple
-sources.
+sources. Auto quotient assumes reference scans have a trailing ``\_R''
+in the source name for data from Parkes and Mopra, and a trailing
+``e'' or ``w'' for data fro, Tidbinbilla.
 
 \begin{verbatim}
@@ -658 +659 @@
 
 The default is to use integration time weighting. The alternative is
-to use none, variance , Tsys weighting or Tsys \& integration time.
+to use none, variance, Tsys weighting or Tsys \& integration time.
 
 \begin{verbatim}
@@ -688 +689 @@
 
 The function \cmd{auto\_poly\_baseline} can be used to automatically
-baseline your data with out having to specify channel ranges for
-the line free data. It automatically figures out the line-free
-emission and fits a polynomial baseline to that data. The user can use
-masks to fix the range of channels or velocity range for the fit as
-well as mark the band edge as invalid.
+baseline your data without having to specify channel ranges for the
+line free data. It automatically figures out the line-free emission
+and fits a polynomial baseline to that data. The user can use masks to
+fix the range of channels or velocity range for the fit as well as
+mark the band edge as invalid.
 
 Simple example
@@ -740 +741 @@
 \subsubsection{Brightness Units}
 
-RPFITS files to not contain any information as to whether the telescope
+RPFITS files do not contain any information as to whether the telescope
 calibration was in units of Kelvin or Janskys.  On reading the data a
 default value is set depending on the telescope and frequency of
@@ -1381 +1382 @@
 
 \subsection{Tidbinbilla}
+
+The following example is processing of some Tidbinbilla observations
+of NH$_3$ at 12~mm. Tidbinbilla has (at the time of observations) a
+single polarisation, but can process two IFs simultaneously. In the
+example, the first half of the observation was observing the (1,1) and
+(2,2) transitions simultaneously). The second half observed only the
+(4,4) transition due to bandwidth limitations. The data is position
+switched, observing first an reference to the west, then the source
+twice and finally reference to the east.
+
+\begin{verbatim}
+
+# Load the rpfits file and inspect
+d = scantable('2003-03-16_082048_t0002.rpf')
+print d
+
+# Make the quotient spectra
+q = d.auto_quotient()
+print q
+
+# Plot/select in velocity
+q.set_freqframe('LSRK')
+q.set_unit('km/s')
+
+# Seperate data from the (1,1)&(2,2) and (4,4) transitions
+g1 = q.get_scan(range(6))     # Rows 0..5
+g2 = q.get_scan(range(6,12))  # Rows 6..11
+
+# Align data in velocity 
+g1.freq_align(perif=True)
+g2.freq_align(perif=True)
+
+# Average individual scans
+a1 = g1.average_time()
+a2 = g2.average_time()
+
+# Rpfits file only contrains a single rest frequency. Set both
+a1.set_restfreqs(freqs= [23694.4700e6,23722.6336e6])
+
+plotter.plot(a1,a2)
+plotter.set_mode('i','s')
+x = raw_input()
+
+a1.auto_poly_baseline()
+a2.auto_poly_baseline()
+
+plotter.plot()
+
+a1.smooth('gauss',5)
+a2.smooth('gauss',5)
+plotter.plot()
+
+\end{verbatim}
 
 \newpage
@@ -1594 +1648 @@
 
 \end{document}
+