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" |
---|
13 | content="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 | <!-- |
---|
21 | B.asap { |
---|
22 | text-align: center; |
---|
23 | color: blue; |
---|
24 | } |
---|
25 | B.note { |
---|
26 | color: red; |
---|
27 | } |
---|
28 | PRE.commands { |
---|
29 | color: blue; |
---|
30 | font-size: smaller; |
---|
31 | } |
---|
32 | --> |
---|
33 | </STYLE> |
---|
34 | </head> |
---|
35 | <body bgcolor="#FFFFFF" text="#000000"> |
---|
36 | <?php |
---|
37 | title_bar("atnf"); |
---|
38 | title_crumbs("/computing/software/"); |
---|
39 | ?> |
---|
40 | <!-- Start Content --> |
---|
41 | <h1>ASAP 'commands'</h1> |
---|
42 | <pre class="commands"> |
---|
43 | ASAP> commands() |
---|
44 | [The scan container] |
---|
45 | scantable - a container for integrations/scans |
---|
46 | (can open asap/rpfits/sdfits and ms files) |
---|
47 | copy - returns a copy of a scan |
---|
48 | get_scan - gets a specific scan out of a scantable |
---|
49 | (by name or number) |
---|
50 | drop_scan - drops a specific scan out of a scantable |
---|
51 | (by number) |
---|
52 | set_selection - set a new subselection of the data |
---|
53 | get_selection - get the current selection object |
---|
54 | summary - print info about the scantable contents |
---|
55 | stats - get specified statistic of the spectra in |
---|
56 | the scantable |
---|
57 | stddev - get the standard deviation of the spectra |
---|
58 | in the scantable |
---|
59 | get_tsys - get the TSys |
---|
60 | get_time - get the timestamps of the integrations |
---|
61 | get_sourcename - get the source names of the scans |
---|
62 | get_azimuth - get the azimuth of the scans |
---|
63 | get_elevation - get the elevation of the scans |
---|
64 | get_parangle - get the parallactic angle of the scans |
---|
65 | get_unit - get the current unit |
---|
66 | set_unit - set the abcissa unit to be used from this |
---|
67 | point on |
---|
68 | get_abcissa - get the abcissa values and name for a given |
---|
69 | row (time) |
---|
70 | get_column_names - get the names of the columns in the scantable |
---|
71 | for use with selector.set_query |
---|
72 | set_freqframe - set the frame info for the Spectral Axis |
---|
73 | (e.g. 'LSRK') |
---|
74 | set_doppler - set the doppler to be used from this point on |
---|
75 | set_dirframe - set the frame for the direction on the sky |
---|
76 | set_instrument - set the instrument name |
---|
77 | set_feedtype - set the feed type |
---|
78 | get_fluxunit - get the brightness flux unit |
---|
79 | set_fluxunit - set the brightness flux unit |
---|
80 | create_mask - return an mask in the current unit |
---|
81 | for the given region. The specified regions |
---|
82 | are NOT masked |
---|
83 | get_restfreqs - get the current list of rest frequencies |
---|
84 | set_restfreqs - set a list of rest frequencies |
---|
85 | flag - flag selected channels in the data |
---|
86 | lag_flag - flag specified frequency in the data |
---|
87 | save - save the scantable to disk as either 'ASAP', |
---|
88 | 'SDFITS' or 'ASCII' |
---|
89 | nbeam,nif,nchan,npol - the number of beams/IFs/Pols/Chans |
---|
90 | nscan - the number of scans in the scantable |
---|
91 | nrow - te number of spectra in the scantable |
---|
92 | history - print the history of the scantable |
---|
93 | get_fit - get a fit which has been stored witnh the data |
---|
94 | average_time - return the (weighted) time average of a scan |
---|
95 | or a list of scans |
---|
96 | average_pol - average the polarisations together. |
---|
97 | average_beam - average the beams together. |
---|
98 | convert_pol - convert to a different polarisation type |
---|
99 | auto_quotient - return the on/off quotient with |
---|
100 | automatic detection of the on/off scans (closest |
---|
101 | in time off is selected) |
---|
102 | mx_quotient - Form a quotient using MX data (off beams) |
---|
103 | scale, *, / - return a scan scaled by a given factor |
---|
104 | add, +, - - return a scan with given value added |
---|
105 | bin - return a scan with binned channels |
---|
106 | resample - return a scan with resampled channels |
---|
107 | smooth - return the spectrally smoothed scan |
---|
108 | poly_baseline - fit a polynomial baseline to all Beams/IFs/Pols |
---|
109 | auto_poly_baseline - automatically fit a polynomial baseline |
---|
110 | recalc_azel - recalculate azimuth and elevation based on |
---|
111 | the pointing |
---|
112 | gain_el - apply gain-elevation correction |
---|
113 | opacity - apply opacity correction |
---|
114 | convert_flux - convert to and from Jy and Kelvin brightness |
---|
115 | units |
---|
116 | freq_align - align spectra in frequency frame |
---|
117 | invert_phase - Invert the phase of the cross-correlation |
---|
118 | swap_linears - Swap XX and YY |
---|
119 | rotate_xyphase - rotate XY phase of cross correlation |
---|
120 | rotate_linpolphase - rotate the phase of the complex |
---|
121 | polarization O=Q+iU correlation |
---|
122 | freq_switch - perform frequency switching on the data |
---|
123 | stats - Determine the specified statistic, e.g. 'min' |
---|
124 | 'max', 'rms' etc. |
---|
125 | stddev - Determine the standard deviation of the current |
---|
126 | beam/if/pol |
---|
127 | [Selection] |
---|
128 | selector - a selection object to set a subset of a scantable |
---|
129 | set_scans - set (a list of) scans by index |
---|
130 | set_cycles - set (a list of) cycles by index |
---|
131 | set_beams - set (a list of) beamss by index |
---|
132 | set_ifs - set (a list of) ifs by index |
---|
133 | set_polarisations - set (a list of) polarisations by name |
---|
134 | or by index |
---|
135 | set_names - set a selection by name (wildcards allowed) |
---|
136 | set_tsys - set a selection by tsys thresholds |
---|
137 | set_query - set a selection by SQL-like query, e.g. BEAMNO==1 |
---|
138 | reset - unset all selections |
---|
139 | + - merge to selections |
---|
140 | |
---|
141 | [Math] Mainly functions which operate on more than one scantable |
---|
142 | |
---|
143 | average_time - return the (weighted) time average |
---|
144 | of a list of scans |
---|
145 | quotient - return the on/off quotient |
---|
146 | simple_math - simple mathematical operations on two scantables, |
---|
147 | 'add', 'sub', 'mul', 'div' |
---|
148 | quotient - build quotient of the given on and off scans |
---|
149 | (matched pairs and 1 off/n on are valid) |
---|
150 | merge - merge a list of scantables |
---|
151 | |
---|
152 | [Line Catalog] |
---|
153 | linecatalog - a linecatalog wrapper, taking an ASCII or |
---|
154 | internal format table |
---|
155 | summary - print a summary of the current selection |
---|
156 | set_name - select a subset by name pattern, e.g. '*OH*' |
---|
157 | set_strength_limits - select a subset by line strength limits |
---|
158 | set_frequency_limits - select a subset by frequency limits |
---|
159 | reset - unset all selections |
---|
160 | save - save the current subset to a table (internal |
---|
161 | format) |
---|
162 | get_row - get the name and frequency from a specific |
---|
163 | row in the table |
---|
164 | [Fitting] |
---|
165 | fitter |
---|
166 | auto_fit - return a scan where the function is |
---|
167 | applied to all Beams/IFs/Pols. |
---|
168 | commit - return a new scan where the fits have been |
---|
169 | commited. |
---|
170 | fit - execute the actual fitting process |
---|
171 | store_fit - store the fit parameters in the data (scantable) |
---|
172 | get_chi2 - get the Chi^2 |
---|
173 | set_scan - set the scantable to be fit |
---|
174 | set_function - set the fitting function |
---|
175 | set_parameters - set the parameters for the function(s), and |
---|
176 | set if they should be held fixed during fitting |
---|
177 | set_gauss_parameters - same as above but specialised for individual |
---|
178 | gaussian components |
---|
179 | get_parameters - get the fitted parameters |
---|
180 | plot - plot the resulting fit and/or components and |
---|
181 | residual |
---|
182 | [Plotter] |
---|
183 | asapplotter - a plotter for asap, default plotter is |
---|
184 | called 'plotter' |
---|
185 | plot - plot a scantable |
---|
186 | plot_lines - plot a linecatalog overlay |
---|
187 | save - save the plot to a file ('png' ,'ps' or 'eps') |
---|
188 | set_mode - set the state of the plotter, i.e. |
---|
189 | what is to be plotted 'colour stacked' |
---|
190 | and what 'panelled' |
---|
191 | set_selection - only plot a selected part of the data |
---|
192 | set_range - set a 'zoom' window [xmin,xmax,ymin,ymax] |
---|
193 | set_legend - specify user labels for the legend indeces |
---|
194 | set_title - specify user labels for the panel indeces |
---|
195 | set_abcissa - specify a user label for the abcissa |
---|
196 | set_ordinate - specify a user label for the ordinate |
---|
197 | set_layout - specify the multi-panel layout (rows,cols) |
---|
198 | set_colors - specify a set of colours to use |
---|
199 | set_linestyles - specify a set of linestyles to use if only |
---|
200 | using one color |
---|
201 | set_font - set general font properties, e.g. 'family' |
---|
202 | set_histogram - plot in historam style |
---|
203 | set_mask - set a plotting mask for a specific polarization |
---|
204 | text - draw text annotations either in data or relative |
---|
205 | coordinates |
---|
206 | arrow - draw arrow annotations either in data or relative |
---|
207 | coordinates |
---|
208 | axhline,axvline - draw horizontal/vertical lines |
---|
209 | axhspan,axvspan - draw horizontal/vertical regions |
---|
210 | |
---|
211 | xyplotter - matplotlib/pylab plotting functions |
---|
212 | |
---|
213 | [Reading files] |
---|
214 | reader - access rpfits/sdfits files |
---|
215 | open - attach reader to a file |
---|
216 | close - detach reader from file |
---|
217 | read - read in integrations |
---|
218 | summary - list info about all integrations |
---|
219 | |
---|
220 | [General] |
---|
221 | commands - this command |
---|
222 | print - print details about a variable |
---|
223 | list_scans - list all scantables created bt the user |
---|
224 | list_files - list all files readable by asap (default rpf) |
---|
225 | del - delete the given variable from memory |
---|
226 | range - create a list of values, e.g. |
---|
227 | range(3) = [0,1,2], range(2,5) = [2,3,4] |
---|
228 | help - print help for one of the listed functions |
---|
229 | execfile - execute an asap script, e.g. execfile('myscript') |
---|
230 | list_rcparameters - print out a list of possible values to be |
---|
231 | put into $HOME/.asaprc |
---|
232 | rc - set rc parameters from within asap |
---|
233 | mask_and,mask_or, |
---|
234 | mask_not - boolean operations on masks created with |
---|
235 | scantable.create_mask |
---|
236 | |
---|
237 | Note: |
---|
238 | How to use this with help: |
---|
239 | # function 'summary' |
---|
240 | [xxx] is just a category |
---|
241 | Every 'sub-level' in this list should be replaces by a '.' Period when |
---|
242 | using help |
---|
243 | Example: |
---|
244 | ASAP> help scantable # to get info on ths scantable |
---|
245 | ASAP> help scantable.summary # to get help on the scantable's |
---|
246 | ASAP> help average_time |
---|
247 | |
---|
248 | </pre> |
---|
249 | <!-- End Content --> |
---|
250 | <?php footer(); ?> |
---|
251 | </body> |
---|
252 | </html> |
---|