source: trunk/web/commands.html@ 791

Last change on this file since 791 was 762, checked in by mar637, 19 years ago

merge from Release12 branch

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 9.6 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<?php include("base.inc"); ?>
5<title>ASAP - ATNF Spectral line Analysis Package</title>
6<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
7<meta name="DC.Creator" lang="en" content="personalName=Marquarding,Malte" />
8<meta name="ATNF.Maintainer" content="contactName=Marquarding,Malte" />
9<meta name="DC.Title" lang="en" content="Homepage of Malte Marquarding" />
10<meta name="DC.Title.alt" lang="en" content="" />
11<meta name="DC.Subject" lang="en" content="spectral line" />
12<meta name="DC.Description" lang="en"
13content="Just some links and conatact details" />
14<meta name="DC.Date.created" scheme="ISO8601" content="2004-11-12" />
15<meta name="ATNF.Site" content="Marsfield" />
16<meta name="ATNF.AccessPermission" content="Public" />
17<meta name="ATNF.MetaVersion" content="1.0" />
18<?php standard_head(); ?>
19<STYLE TYPE="text/css">
20<!--
21B.asap {
22 text-align: center;
23 color: blue;
24}
25B.note {
26 color: red;
27}
28PRE.commands {
29 color: blue;
30 font-size: smaller;
31}
32-->
33</STYLE>
34</head>
35<body bgcolor="#FFFFFF" text="#000000">
36<?php
37title_bar("atnf");
38title_crumbs("/computing/software/");
39?>
40<!-- Start Content -->
41<h1><a href="index.html">ASAP</a> 'commands'</h1>
42<pre class="commands">
43ASAP> commands
44----> commands()
45
46 [The scan container]
47 scantable - a container for integrations/scans
48 (can open asap/rpfits/sdfits and ms files)
49 copy - returns a copy of a scan
50 get_scan - gets a specific scan out of a scantable
51 (by name or number)
52 summary - print info about the scantable contents
53 set_cursor - set a specific Beam/IF/Pol 'cursor' for
54 further use
55 get_cursor - print out the current cursor position
56 stats - get specified statistic of the spectra in
57 the scantable
58 stddev - get the standard deviation of the spectra
59 in the scantable
60 get_tsys - get the TSys
61 get_time - get the timestamps of the integrations
62 get_sourcename - get the source names of the scans
63 get_unit - get the currnt unit
64 set_unit - set the abcissa unit to be used from this
65 point on
66 get_abcissa - get the abcissa values and name for a given
67 row (time)
68 set_freqframe - set the frame info for the Spectral Axis
69 (e.g. 'LSRK')
70 set_doppler - set the doppler to be used from this point on
71 set_instrument - set the instrument name
72 get_fluxunit - get the brightness flux unit
73 set_fluxunit - set the brightness flux unit
74 create_mask - return an mask in the current unit
75 for the given region. The specified regions
76 are NOT masked
77 get_restfreqs - get the current list of rest frequencies
78 set_restfreqs - set a list of rest frequencies
79 lines - print list of known spectral lines
80 flag_spectrum - flag a whole Beam/IF/Pol
81 save - save the scantable to disk as either 'ASAP'
82 or 'SDFITS'
83 nbeam,nif,nchan,npol - the number of beams/IFs/Pols/Chans
84 nscan - the number of scans in the scantable
85 nrow - te number of integrations in the scantable
86 history - print the history of the scantable
87 get_fit - get a fit which has been stored witnh the data
88 average_time - return the (weighted) time average of a scan
89 or a list of scans
90 average_pol - average the polarisations together.
91 The dimension won't be reduced and
92 all polarisations will contain the
93 averaged spectrum.
94 auto_quotient - return the on/off quotient with
95 automatic detection of the on/off scans
96 (matched pairs and 1 off - n on)
97 quotient - return the on/off quotient
98 scale - return a scan scaled by a given factor
99 add - return a scan with given value added
100 bin - return a scan with binned channels
101 resample - return a scan with resampled channels
102 smooth - return the spectrally smoothed scan
103 poly_baseline - fit a polynomial baseline to all Beams/IFs/Pols
104 auto_poly_baseline - automatically fit a polynomial baseline
105 gain_el - apply gain-elevation correction
106 opacity - apply opacity correction
107 convert_flux - convert to and from Jy and Kelvin brightness
108 units
109 freq_align - align spectra in frequency frame
110 rotate_xyphase - rotate XY phase of cross correlation
111 rotate_linpolphase - rotate the phase of the complex
112 polarization O=Q+iU correlation
113 freq_switch - perform frequency switching on the data
114 stats - Determine the specified statistic, e.g. 'min'
115 'max', 'rms' etc.
116 stddev - Determine the standard deviation of the current
117 beam/if/pol
118
119 [Math] Mainly functions which operate on more than one scantable
120
121 average_time - return the (weighted) time average
122 of a list of scans
123 quotient - return the on/off quotient
124 simple_math - simple mathematical operations on two scantables,
125 'add', 'sub', 'mul', 'div'
126 [Fitting]
127 fitter
128 auto_fit - return a scan where the function is
129 applied to all Beams/IFs/Pols.
130 commit - return a new scan where the fits have been
131 commited.
132 fit - execute the actual fitting process
133 store_fit - store the fit paramaters in the data (scantable)
134 get_chi2 - get the Chi^2
135 set_scan - set the scantable to be fit
136 set_function - set the fitting function
137 set_parameters - set the parameters for the function(s), and
138 set if they should be held fixed during fitting
139 set_gauss_parameters - same as above but specialised for individual
140 gaussian components
141 get_parameters - get the fitted parameters
142 plot - plot the resulting fit and/or components and
143 residual
144 [Plotter]
145 asapplotter - a plotter for asap, default plotter is
146 called 'plotter'
147 plot - plot a (list of) scantable
148 save - save the plot to a file ('png' ,'ps' or 'eps')
149 set_mode - set the state of the plotter, i.e.
150 what is to be plotted 'colour stacked'
151 and what 'panelled'
152 set_cursor - only plot a selected part of the data
153 set_range - set a 'zoom' window [xmin,xmax,ymin,ymax]
154 set_legend - specify user labels for the legend indeces
155 set_title - specify user labels for the panel indeces
156 set_abcissa - specify a user label for the abcissa
157 set_ordinate - specify a user label for the ordinate
158 set_layout - specify the multi-panel layout (rows,cols)
159 set_colors - specify a set of colours to use
160 set_linestyles - specify a set of linestyles to use if only
161 using one color
162 set_mask - set a plotting mask for a specific polarization
163
164 [Reading files]
165 reader - access rpfits/sdfits files
166 read - read in integrations
167 summary - list info about all integrations
168
169 [General]
170 commands - this command
171 print - print details about a variable
172 list_scans - list all scantables created bt the user
173 del - delete the given variable from memory
174 range - create a list of values, e.g.
175 range(3) = [0,1,2], range(2,5) = [2,3,4]
176 help - print help for one of the listed functions
177 execfile - execute an asap script, e.g. execfile('myscript')
178 list_rcparameters - print out a list of possible values to be
179 put into $HOME/.asaprc
180 mask_and,mask_or,
181 mask_not - boolean operations on masks created with
182 scantable.create_mask
183
184 Note:
185 How to use this with help:
186 # function 'summary'
187 [xxx] is just a category
188 Every 'sub-level' in this list should be replaces by a '.' Period when
189 using help
190 Example:
191 ASAP> help scantable # to get info on ths scantable
192 ASAP> help scantable.summary # to get help on the scantable's
193 ASAP> help average_time
194
195
196</pre>
197<!-- End Content -->
198<?php footer(); ?>
199</body>
200</html>
Note: See TracBrowser for help on using the repository browser.