Changeset 953 for trunk/doc


Ignore:
Timestamp:
03/30/06 17:24:19 (19 years ago)
Author:
Chris Phillips
Message:

Initial Update for v2

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/cookbook.tex

    r794 r953  
    3939package.
    4040
    41 %\section{Documentation Standards}
    42 
    43 %In most of the examples in this document, it has been assumed that the
     41This useeguide is currently being updated for the ASAP 2.0 release
     42which has a number of significant changes which affect the user
     43interface. Please report any mistakes you find in this userguide.
    4444
    4545\section{Installation and Running}
     
    5858\begin{verbatim}
    5959  > cd /my/data/directory
    60   > asap
     60  > asap2
    6161\end{verbatim}
    6262
     
    8888  \item[\cmd{scantable}] The data container (actual spectra and header
    8989    information)
     90  \item[\cmd{selector}] Allows the user to select a subsection of the
     91    data, such as a specified or ramge of beam numbers, IFs, etc.
     92  \item[\cmd{plotter}] A tool used to plot the spectral line data
    9093  \item[\cmd{fitter}] A tool used to fit functions to the spectral data
    91   \item[\cmd{plotter}] A tool used to plot the spectral line data
    9294  \item[\cmd{reader}] A tool which can be used to read data from disks
    9395    into a scantable object.
     
    121123
    122124\begin{verbatim}
    123   ASAP> av = scans(msk,weight='tsys')
    124   ASAP> av = scans(mask=msk,weight='tsys')
    125   ASAP> av = scans(msk,tsys)
     125  ASAP> av = scans.average_time(msk,weight='tsys')
     126  ASAP> av = scans.average_time(mask=msk,weight='tsys')
     127  ASAP> av = scans.average_time(msk,tsys)
    126128  ASAP> scans.polybaseline(mask=msk, order=0, insitu=True)
    127129  ASAP> scans.polybaseline(msk,0,True)
     
    190192  ASAP> pwd
    191193  ASAP> ls
     194  ASAP> cd /my/data/directory
    192195  ASAP> ! mozilla&
    193196\end{verbatim}
     
    241244
    242245  # default output format when saving scantable
    243   scantable.save             : 'ASAP'
     246  scantable.save             : ASAP
    244247
    245248  # default frequency frame to set when function
    246249  # scantable.set_freqframe is called
    247   scantable.freqframe        : 'LSRK'
     250  scantable.freqframe        : LSRK
    248251
    249252  # auto averaging on read
     
    251254\end{verbatim}
    252255
    253 For a complete list of \cmd{.asaprc} values, see the appendix.
     256For a complete list of \cmd{.asaprc} values, see the Appendix.
    254257
    255258\section{Scantables}
     
    262265scantables.  A scantable holds your data, and also provides functions
    263266to operate upon it.
     267
     268{\bf [MALTE: Could you please reword this??]}
    264269
    265270The building block of a scantable is an integration, which is a single
     
    284289
    285290\index{Scantable!contents}A scantable has header information and data
    286 (a scantable is actually an AIPS++ Table and it is stored in Memory
    287 when you are manipulating it with ASAP.  You can store it to disk and
    288 then browse it with the AIPS++ Table browser if you know how to do
    289 that !).
     291(a scantable is actually an AIPS++ Table and it is generally stored in
     292memory when you are manipulating it with ASAP.  You can save it to
     293disk and then browse it with the AIPS++ Table browser if you know how
     294to do that !).
    290295
    291296The data are stored in columns (the length of a column is the number of
    292297rows/integrations of course).
     298
     299{\bf [MALTE: Is this outdated??]}
    293300
    294301Two important columns are those that describe the frequency setup.  We mention
     
    304311the flags, the Tsys, the source names and so on, but those are a little
    305312more transparently handled.
    306 
    307 \subsection{Management}
    308 
    309 \index{Scantable!management}During processing it is possible to create
    310 a large number of scan tables. These all consume memory, so it is best
    311 to periodically remove unneeded scan tables. Use \cmd{list\_scans} to
    312 print a list of all scantables and \cmd{del} to remove unneeded ones.
    313 
    314 Example:
    315 
    316 \begin{verbatim}
    317   ASAP> list_scans()
    318   The user created scantables are:
    319   ['s', 'scans', 'av', 's2', 'ss']
    320 
    321   ASAP> del s2
    322   ASAP> del ss
    323 \end{verbatim}
    324313
    325314There is also a function \cmd{summary} to list a summary of the scantable.
     
    349338refer, is always listed.
    350339
     340\subsection{Data Selection}
     341\label{sec:selection}
     342
     343CHRIS TOFILL IN
     344
    351345%You can copy one scantable to another with the \cmd{copy} function.
    352346
     
    404398from the RPFITS file when reading the data. The values stored in the
    405399RPFITS file are not always correct and so there is a function
    406 \cmd{set\_restfreq} to set the rest frequencies.
     400\cmd{set\_restfreq} to set the rest frequencies for the currently
     401selected data.
    407402
    408403For each integration, there is a rest-frequency per IF (the rest
     
    410405There are a few ways to set the rest frequencies with this function.
    411406
    412 If you specify just one rest frequency, then it is selected for the
    413 specified source and IF and added to the list of rest frequencies.
    414 
    415 \begin{verbatim}
    416   # Select for specified source/IF
    417   ASAP> scans.set_restfreqs(freqs=1.667359e9, source='NGC253', theif=0)
    418 
    419   # Select for all sources and IFs
     407If you specify just one rest frequency, then it is set for all IF.
     408
     409\begin{verbatim}
     410  # Set all IFs
    420411  ASAP> scans.set_restfreqs(freqs=1.667359e9)
    421412\end{verbatim}
    422413
    423 
    424 If you specify a list of frequencies, then it must be of length the
    425 number of IFs.  Regardless of the source, the rest frequency will be set
    426 for each IF to the corresponding value in the provided list.  The
    427 internally stored list of rest frequencies will be replaced by this
    428 list.
    429 
     414If set a rest frequency for each IF, specify a list of frequencies (of
     415length the number of IFs).  Regardless of the source, the rest
     416frequency will be set for each IF to the corresponding value in the
     417provided list.
    430418
    431419\begin{verbatim}
     
    435423\end{verbatim}
    436424
     425{\em Currently this is not implemented}
     426
    437427In both of the above modes, you can also specify the rest frequencies via
    438428names in a known list rather than by their values.
     
    441431
    442432\begin{verbatim}
    443   ASAP> scans.lines()                 # Print list of known lines
    444   ASAP> scans.set_restfreqs(lines=['OH1665','OH1667'])
    445 \end{verbatim}
    446 
    447 
    448 \subsection{Data Selection}
    449 
    450 \index{Scantable!data selection}Data selection is currently fairly limited. This
    451 will be improved in the future.
    452 
    453 
    454 \subsubsection{Cursor}
    455 
    456 \index{Scantable!cursor}Generally the user will want to run functions
    457 on all rows in a scantable. This allows very fast reduction of
    458 data. There are situations when functions should only operate on
    459 specific elements of the spectra. This is handled by the scantable
    460 cursor, which allows the user to select a single beam, IF and
    461 polarisation combination.
    462 
    463 Example :
    464 
    465 \begin{verbatim}
    466   ASAP> scans.set_cursor(0,2,1)      # beam, IF, pol
    467   ASAP> scans.smooth(allaxes=F)      # in situ by default or .aipsrc
    468 \end{verbatim}
    469 
    470 \subsubsection{Row number}
    471 
    472 \index{Scantable!row selection}Most functions work on all rows of a
    473 scan table. Exceptions are the fitter and plotter. If you wish to only
    474 operate on a selected set of scantable rows, use the \cmd{get\_scan}
    475 function to copy the rows into a new scantable.
    476 
    477 \subsubsection{Allaxes}
    478 
    479 \index{allaxes}\index{Scantable!allaxes}Many functions have an
    480 \cmd{allaxes} option which controls whether the function will operate
    481 on all elements within a scantable row, or just those selected with
    482 the current cursor. The default is taken from the users {\tt .asaprc}
    483 file.
     433  ASAP> scans.set_restfreqs(freqs=['OH1665','OH1667'])
     434\end{verbatim}
     435
    484436
    485437\subsubsection{Masks}
     
    547499
    548500
     501\subsection{Management}
     502
     503\index{Scantable!management}During processing it is possible to create
     504a large number of scan tables. These all consume memory, so it is best
     505to periodically remove unneeded scan tables. Use \cmd{list\_scans} to
     506print a list of all scantables and \cmd{del} to remove unneeded ones.
     507
     508Example:
     509
     510\begin{verbatim}
     511  ASAP> list_scans()
     512  The user created scantables are:
     513  ['s', 'scans', 'av', 's2', 'ss']
     514
     515  ASAP> del s2
     516  ASAP> del ss
     517\end{verbatim}
     518
    549519\section{Data Input}
    550520
     
    576546\index{Reader object}\index{Scantable!reader object}For more control
    577547when reading data into ASAP, the reader object should be used.  This
    578 has the option of only reading in a range of integrations and does not
    579 perform any scan averaging of the data, allowing analysis of the
    580 individual integrations.  Note that due to limitation of the RPFITS
    581 library, only one reader object can be open at one time reading RPFITS
    582 files.  To read multiple RPFITS files, the old reader must be
    583 destroyed before the new file is opened.  However, multiple readers
    584 can be created and attached to SDFITS files.
     548has the option of only reading in a range of integrations, only a
     549specified beam or IF and does not perform any scan averaging of the
     550data, allowing analysis of the individual integrations.  Note that due
     551to limitation of the RPFITS library, only one reader object can be
     552open at one time reading RPFITS files.  To read multiple RPFITS files,
     553the old reader must be destroyed before the new file is opened.
     554However, multiple readers can be created and attached to SDFITS files.
    585555
    586556
     
    602572default value from \cmd{True}.
    603573
    604 %\subsection{Editing}
    605 
    606 %How and when?
    607574\subsection{Auto quotient}
    608575\index{Auto quotient}Quotients can be computed ``automatically''. This
     
    616583\end{verbatim}
    617584
    618 If this is not sufficient the following alternative method can be used.
    619 
    620 \subsection{Separate reference and source observations}
    621 
    622 \index{Quotient spectra}Most data from ATNF observatories
    623 distinguishes on and off source data using the file name. This makes
    624 it easy to create two scantables with the source and reference
    625 data. As long as there was exactly one reference observation for each
    626 on source observation for following method will work.
    627 
    628 For Mopra and Parkes data:
    629 \begin{verbatim}
    630   ASAP> r = scans.get_scan('*_R')
    631   ASAP> s = scans.get_scan('*_S')
    632 \end{verbatim}
    633 
    634 For Tidbinbilla data
    635 \begin{verbatim}
    636   ASAP> r = scans.get_scan('*_[ew]')
    637   ASAP> s = scans.get_scan('*_[^ew]')
    638 \end{verbatim}
    639 
    640 \subsection{Make the quotient spectra}
    641 
    642 Use the quotient function
    643 
    644 \begin{verbatim}
    645   ASAP> q = s.quotient(r)
    646 \end{verbatim}
    647 
    648 This uses the rows in scantable \cmd{r} as reference spectra for the
    649 rows in scantable \cmd{s}. Scantable \cmd{r} must have either 1 row
    650 (which is applied to all rows in \cmd{s}) or both scantables must have
    651 the same number of rows. By default the quotient spectra is calculated
    652 to preserve continuum emission. If you wish to remove the continuum
    653 contribution, use the \cmd{preserve} argument:
    654 
    655 \begin{verbatim}
    656   ASAP> q = s.quotient(r, preserve=True)
    657 \end{verbatim}
     585%If this is not sufficient the following alternative method can be used.
     586%
     587%\subsection{Separate reference and source observations}
     588%
     589%\index{Quotient spectra}Most data from ATNF observatories
     590%distinguishes on and off source data using the file name. This makes
     591%it easy to create two scantables with the source and reference
     592%data. As long as there was exactly one reference observation for each
     593%on source observation for following method will work.
     594%
     595%For Mopra and Parkes data:
     596%\begin{verbatim}
     597%  ASAP> r = scans.get_scan('*_R')
     598%  ASAP> s = scans.get_scan('*_S')
     599%\end{verbatim}
     600%
     601%For Tidbinbilla data
     602%\begin{verbatim}
     603%  ASAP> r = scans.get_scan('*_[ew]')
     604%  ASAP> s = scans.get_scan('*_[^ew]')
     605%\end{verbatim}
     606%
     607%\subsection{Make the quotient spectra}
     608%
     609%Use the quotient function
     610%
     611%\begin{verbatim}
     612%  ASAP> q = s.quotient(r)
     613%\end{verbatim}
     614%
     615%This uses the rows in scantable \cmd{r} as reference spectra for the
     616%rows in scantable \cmd{s}. Scantable \cmd{r} must have either 1 row
     617%(which is applied to all rows in \cmd{s}) or both scantables must have
     618%the same number of rows. By default the quotient spectra is calculated
     619%to preserve continuum emission. If you wish to remove the continuum
     620%contribution, use the \cmd{preserve} argument:
     621%
     622%\begin{verbatim}
     623%  ASAP> q = s.quotient(r, preserve=True)
     624%\end{verbatim}
    658625
    659626\subsection{Time average separate scans}
     
    664631
    665632\begin{verbatim}
    666  ASAP> av = average_time(q)
     633 ASAP> av = q.average_time()
    667634\end{verbatim}
    668635
     
    689656\end{verbatim}
    690657
    691 Note that, if needed, you should run \cmd{freq\_align}, \cmd{gain\_el}
    692 and \cmd{opacity} before you average the data in time (\S
    693 \ref{sec:gainel} \& \ref{sec:freqalign}).
     658If you have not observed your data with Doppler tracking (or run
     659\cmd{freq\_align} explicitally) you should align the data in frequency
     660before averaging.
     661
     662\begin{verbatim}
     663 ASAP> av = scans.average_time(align=True)
     664\end{verbatim}
     665
     666Note that, if needed, you should run \cmd{gain\_el} and \cmd{opacity}
     667before you average the data in time (\S \ref{sec:gainel} \&
     668\ref{sec:freqalign}).
    694669
    695670\subsection{Baseline fitting}
     
    863838\end{verbatim}
    864839
    865 \cmd{freq\_align} has two modes of operations controlled by the
    866 \cmd{perif} argument. By default it will align each source and freqid
    867 separately. This is needed for scan tables containing multiple
    868 sources. However if scan-based Doppler tracking has been made at the
    869 observatory, each row will have a different freqid. In these cases run
    870 with \cmd{perif=True} and all rows of a source will be aligned to the
    871 same frame. In general \cmd{perif=True} will be needed for most
    872 observations as Doppler tracking of some form is made at Parkes, Tid
    873 and Mopra.
    874 
    875 \begin{verbatim}
    876   ASAP> scans.freq_align(perif=True)
    877 \end{verbatim}
     840{\em A Global freq\_align command will be made eventually}
    878841
    879842To average together data taken on different days, which are in
     
    897860new scantable with a selection of scans from a scantable. The
    898861selection can either be on the source name, with simple wildcard
    899 matching or set of scan ids.
     862matching or set of scan ids. Internally this uses the selector object,
     863so for more complicated selection the selector should be used directly
     864instead.
    900865
    901866For example:
     
    912877  ASAP> r = scans.get_scan('*_R') # Get all reference sources (Parkes/Mopra)
    913878  ASAP> s = scans.get_scan('*_S') # Get all program sources (Parkes/Mopra)
    914   ASAP> r = scans.get_scan('*_[ew]')  # Get all reference sources (Tid)
    915   ASAP> s = scans.get_scan('*_[^ew]') # Get all program sources (Tid)
     879  ASAP> r = scans.get_scan('*[ew]')  # Get all reference sources (Tid)
     880  ASAP> s = scans.get_scan('*[^ew]') # Get all program sources (Tid)
    916881
    917882\end{verbatim}
     
    936901variety of formats, suitable for reading into other packages. The
    937902formats are:
     903
     904{\em Currently only raw ASAP output is available. Other formats will be added soon}
    938905
    939906\begin{itemize}
     
    1022989stacked spectra per panel. If you have data larger than this (or for
    1023990your own sanity) you need to select a subset of this data. This is
    1024 particularly true for multibeam or multi IF data. The plotter
    1025 \cmd{set\_cursor} function is used to select a subset of the data. The
    1026 arguments \cmd{row}, \cmd{beam} and \cmd{IF} all accept a vector of
    1027 indices corresponding to row, beam or IF selection. Only the selected
    1028 data will be plotted.  To select on polarisation, see
    1029 section~\ref{sec:polplot}.
     991particularly true for multibeam or multi IF data. The selector object
     992should be used for this purpose. Selection can either be applide to
     993the scantable or directly to the plotter, the end result is the same.
    1030994
    1031995Examples:
    1032996
    1033997\begin{verbatim}
     998  ASAP> selection = selector()
    1034999  # Select second IF
    1035   ASAP> plotter.set_cursor(IF=[1])
     1000  ASAP> selection.set_if(1)
     1001  ASAP> plotter.set_selection(selection)
    10361002
    10371003  # Select first 4 beams
    1038   ASAP> plotter.set_cursor(beam=[0,1,2,3])
    1039 
    1040   # Select a few rows
    1041   ASAP> plotter.set_cursor(row=[2,4,6,10])
     1004  ASAP> selection.set_beam([0,1,2,3])
     1005  ASAP> plotter.set_selection(selection)
     1006
     1007  # Select a few scans
     1008  ASAP> selection.set_scans([2,4,6,10])
     1009  ASAP> plotter.set_selection(selection)
    10421010
    10431011  # Multiple selection
    1044   ASAP> plotter.set_cursor(IF=[1], beam=[0,2], row=range(10))
    1045 \end{verbatim}
    1046 
    1047 Note that the plotter cursor selection is independent of the scantable
    1048 cursor.
     1012  ASAP> selection.set_if(1)
     1013  ASAP> selection.set_scans([2,4,6,10])
     1014  ASAP> plotter.set_selection(selection)
     1015
     1016\end{verbatim}
    10491017
    10501018\subsection{Plot Control}
     
    10651033
    10661034\item[Pan] (The Cross) This sets the cursor to pan, or scroll mode
    1067        allowing you to shift the plot within the window. Useful when
    1068        zoomed in on a feature.
     1035  allowing you to shift the plot within the window. Useful when
     1036  zoomed in on a feature.
    10691037
    10701038\item[Zoom] (the letter with the magnifying glass) lets you draw a
    1071        rectangle around a region of interest then zooms in on that
    1072        region. Use the plot history to unzoom again.
     1039  rectangle around a region of interest then zooms in on that
     1040  region. Use the plot history to unzoom again.
     1041
     1042\item[Adjust] (rectangle with 4 arrows) adjust subplot paramaters
     1043  (space at edge of plots)
    10731044
    10741045\item[Save] (floppy disk). Save the plot as a postscript or .png file
     
    12091180\subsection{Simple Calibration}
    12101181
    1211 {\em Currently the receiver position angle is not read from the RPFITS
    1212 file and a position angle of zero is assumed. This severely hampers
    1213 correct handling of polarimetry. In the future we aim to define a
    1214 general framework and populate the RPFITS files with the data required
    1215 for transparent polarimetric calibration.}
    1216 
    12171182\index{Polarisation!calibration}It is possible that there is a phase
    12181183offset between polarisation which will effect the phase of the cross
     
    12301195
    12311196A correction for the receiver parallactic angle may need to be made,
    1232 either because of how it is mounted or if parallactifiying had to track
    1233 at 90 degrees rather than 0. Use \cmd{rotate\_linpolphase} to correct
    1234 the position angle. Running this function twice results in the sum of
    1235 the corrections being applied because it is applied in-situ.
    1236 
    1237 \begin{verbatim}
    1238   ASAP> scans.rotate_linpolphase(-20) # Degrees; correct for receiver mounting
    1239 
    1240   # Receiver was tracking 90 degrees rather than 0
    1241   ASAP> scans.rotate_linpolphase(90)
     1197generally because of how it is mounted. Use \cmd{rotate\_linpolphase}
     1198to correct the position angle. Running this function twice results in
     1199the sum of the corrections being applied because it is applied
     1200in-situ.
     1201
     1202\begin{verbatim}
     1203  ASAP> scans.rotate_linpolphase(-45) # Degrees; correct for receiver mounting
     1204\end{verbatim}
     1205
     1206If the sign of the complex correlation is wrong (this can happen
     1207depending on the correlator configuration), use \cmd{invert\_phase} to
     1208change take the complex conjugate of the complex correlation
     1209term. This is always performed in-situ.
     1210
     1211\begin{verbatim}
     1212  ASAP> scans.invert_phase()
     1213\end{verbatim}
     1214
     1215Depending on how the correlator is configured, ``BA'' may be
     1216correlated insead of ``AB''. Use \cmd{swap\_linears} to correct for
     1217this problem:
     1218
     1219\begin{verbatim}
     1220  ASAP> scans.swap_linears()
    12421221\end{verbatim}
    12431222
     
    12451224\label{sec:polplot}
    12461225
    1247 \index{Polarisation!plotting}To plot Stokes values, the plotter
    1248 \cmd{set\_cursor} function should be called first using the \cmd{pol}
    1249 argument. The values which can be plotted include a selection of
    1250 [I,Q,U,V], [I, Plinear, Pangle, V], [RR, LL] or [XX, YY, Real(XY),
     1226\index{Polarisation!plotting}To plot Stokes values, a selector object
     1227must be created and the set\_polarisation function used to select the
     1228desired polarisation products.
     1229
     1230The values which can be plotted include a selection of [I,Q,U,V], [I,
     1231Plinear, Pangle, V], [RR, LL] or [XX, YY, Real(XY),
    12511232Imaginary(XY)]. (Plinear and Pangle are the percentage and position
    12521233angle of linear polarisation). Conversion to circular polarisations
     
    12561237
    12571238\begin{verbatim}
    1258   ASAP> plotter.set_cursor(pol=``I Q'')
    1259   ASAP> plotter.set_cursor(pol=``RR LL'')
    1260   ASAP> plotter.set_cursor(pol=``XX YY'')
    1261   ASAP> plotter.set_cursor(pol=``I Plinear'')
    1262 \end{verbatim}
    1263 
    1264 Row, beam and IF selection are also available in \cmd{set\_cursor} as
    1265 describe in section~\ref{sec:plotter_cursor}.
     1239  ASAP> selection = selector()
     1240 
     1241  ASAP> selection.set_polarisations([``I'', ``Q'', ``U'', ``V''])
     1242  ASAP  plotter.set_selection(selection);              # Select I, Q, U \& V
     1243
     1244  ASAP> selection.set_polarisations([``I'', ``Q'')
     1245  ASAP  plotter.set_selection(selection);              # Select just I \& Q
     1246
     1247  ASAP> selection.set_polarisations([``RR'', ``LL'')
     1248  ASAP  plotter.set_selection(selection);              # Select just RR \& LL
     1249
     1250  ASAP> selection.set_polarisations([``XX'', ``YY'')
     1251  ASAP  plotter.set_selection(selection);              # Select linears
     1252
     1253  ASAP> selection.set_polarisations([``I'', ``Plinear'')
     1254  ASAP  plotter.set_selection(selection);              # Select linears
     1255
     1256\end{verbatim}
     1257
     1258Scan, beam and IF selection are also available in the selector object as
     1259describe in section~\ref{sec:selection}.
    12661260
    12671261\subsection{Saving}
     
    13031297
    13041298\hspace{1cm} http://www.atnf.csiro.au/computing/software/asap/tutorials
     1299
    13051300\hspace{1cm} http://www.python.org/doc/Introduction.html
    13061301
     
    15281523plotter.plot(a1,a2)
    15291524plotter.set_mode('i','s')
    1530 x = raw_input()
    15311525
    15321526a1.auto_poly_baseline()
     
    16901684\end{verbatim}
    16911685
     1686\subsection{ASCII output format}
     1687
     1688\subsection{.asaprc settings}
     1689\index{.asaprc}
     1690\asaprc{verbose}{{\bf True}/False}{Print verbose output}
     1691
     1692\asaprc{insitu}{{\bf True}/False}{Apply operations on the input
     1693scantable or return new one}
     1694
     1695% plotting
     1696
     1697\asaprc{useplotter}{{\bf True}/False}{Preload a default plotter}
     1698
     1699\asaprc{plotter.gui}{{\bf True}/False}{Do we want a GUI or plot to a
     1700file}
     1701
     1702\asaprc{plotter.stacking}{{\bf Pol} Beam IF Scan Time}{Default mode for
     1703colour stacking}
     1704
     1705\asaprc{plotter.panelling}{Pol Beam IF {\bf Scan} Time}{Default mode
     1706for panelling}
     1707
     1708\asaprc{plotter.ganged}{{\bf True}/False}{Push panels together, to
     1709share axislabels}
     1710
     1711\asaprc{plotter.decimate}{True/{\bf False}}{Decimate the number of
     1712points plotted by a factor of nchan/1024}
     1713
     1714% default colours/linestyles
     1715%\asaprc{plotter.colours}{.}{.}
     1716%\asaprc{plotter.linestyles{.}{.}
     1717
     1718% scantable
     1719\asaprc{scantable.save}{{\bf ASAP} SDFITS FITS ASCII MS2}{Default output
     1720format when saving}
     1721
     1722\asaprc{scantable.autoaverage}{{\bf True}/False}{Auto averaging on
     1723read}
     1724
     1725\asaprc{scantable.freqframe}{{\bf LSRK} TOPO BARY etc}{default
     1726frequency frame to set when function scantable.set\_freqframe is
     1727called}
     1728
     1729\asaprc{scantable.allaxes}{{\bf True}/False}{Apply action to all axes
     1730not just the cursor location}
     1731
     1732\asaprc{scantable.plotter}{{\bf True}/False}{Use internal plotter}
     1733
     1734\asaprc{scantable.verbosesummary}{True/{\bf False}}{Control the level
     1735of information printed by summary}
     1736
    16921737\subsection{Installation}
    16931738
     
    17071752Of the dependencies, AIPS++ is the most complex to install.
    17081753
    1709 \subsection{ASCII output format}
    1710 
    1711 \subsection{.asaprc settings}
    1712 \index{.asaprc}
    1713 \asaprc{verbose}{{\bf True}/False}{Print verbose output}
    1714 
    1715 \asaprc{insitu}{{\bf True}/False}{Apply operations on the input
    1716 scantable or return new one}
    1717 
    1718 % plotting
    1719 
    1720 \asaprc{useplotter}{{\bf True}/False}{Preload a default plotter}
    1721 
    1722 \asaprc{plotter.gui}{{\bf True}/False}{Do we want a GUI or plot to a
    1723 file}
    1724 
    1725 \asaprc{plotter.stacking}{{\bf Pol} Beam IF Scan Time}{Default mode for
    1726 colour stacking}
    1727 
    1728 \asaprc{plotter.panelling}{Pol Beam IF {\bf Scan} Time}{Default mode
    1729 for panelling}
    1730 
    1731 \asaprc{plotter.ganged}{{\bf True}/False}{Push panels together, to
    1732 share axislabels}
    1733 
    1734 \asaprc{plotter.decimate}{True/{\bf False}}{Decimate the number of
    1735 points plotted by a factor of nchan/1024}
    1736 
    1737 % default colours/linestyles
    1738 %\asaprc{plotter.colours}{.}{.}
    1739 %\asaprc{plotter.linestyles{.}{.}
    1740 
    1741 % scantable
    1742 \asaprc{scantable.save}{{\bf ASAP} SDFITS FITS ASCII MS2}{Default output
    1743 format when saving}
    1744 
    1745 \asaprc{scantable.autoaverage}{{\bf True}/False}{Auto averaging on
    1746 read}
    1747 
    1748 \asaprc{scantable.freqframe}{{\bf LSRK} TOPO BARY etc}{default
    1749 frequency frame to set when function scantable.set\_freqframe is
    1750 called}
    1751 
    1752 \asaprc{scantable.allaxes}{{\bf True}/False}{Apply action to all axes
    1753 not just the cursor location}
    1754 
    1755 \asaprc{scantable.plotter}{{\bf True}/False}{Use internal plotter}
    1756 
    1757 \asaprc{scantable.verbosesummary}{True/{\bf False}}{Control the level
    1758 of information printed by summary}
    1759 
    17601754\printindex
    17611755
Note: See TracChangeset for help on using the changeset viewer.