source: branches/Release12/web/commands.html@ 2849

Last change on this file since 2849 was 793, checked in by mar637, 19 years ago

added new functions

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 9.9 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_azimuth - get the azimuth of the scans
64 get_elevation - get the elevation of the scans
65 get_parangle - get the parallactic angle of the scans
66 get_unit - get the currnt unit
67 set_unit - set the abcissa unit to be used from this
68 point on
69 get_abcissa - get the abcissa values and name for a given
70 row (time)
71 set_freqframe - set the frame info for the Spectral Axis
72 (e.g. 'LSRK')
73 set_doppler - set the doppler to be used from this point on
74 set_instrument - set the instrument name
75 get_fluxunit - get the brightness flux unit
76 set_fluxunit - set the brightness flux unit
77 create_mask - return an mask in the current unit
78 for the given region. The specified regions
79 are NOT masked
80 get_restfreqs - get the current list of rest frequencies
81 set_restfreqs - set a list of rest frequencies
82 lines - print list of known spectral lines
83 flag_spectrum - flag a whole Beam/IF/Pol
84 save - save the scantable to disk as either 'ASAP'
85 or 'SDFITS'
86 nbeam,nif,nchan,npol - the number of beams/IFs/Pols/Chans
87 nscan - the number of scans in the scantable
88 nrow - te number of integrations in the scantable
89 history - print the history of the scantable
90 get_fit - get a fit which has been stored witnh the data
91 average_time - return the (weighted) time average of a scan
92 or a list of scans
93 average_pol - average the polarisations together.
94 The dimension won't be reduced and
95 all polarisations will contain the
96 averaged spectrum.
97 auto_quotient - return the on/off quotient with
98 automatic detection of the on/off scans
99 (matched pairs and 1 off - n on)
100 quotient - return the on/off quotient
101 scale - return a scan scaled by a given factor
102 add - return a scan with given value added
103 bin - return a scan with binned channels
104 resample - return a scan with resampled channels
105 smooth - return the spectrally smoothed scan
106 poly_baseline - fit a polynomial baseline to all Beams/IFs/Pols
107 auto_poly_baseline - automatically fit a polynomial baseline
108 recalc_azel - recalculate azimuth and elevation based on
109 the pointing
110 gain_el - apply gain-elevation correction
111 opacity - apply opacity correction
112 convert_flux - convert to and from Jy and Kelvin brightness
113 units
114 freq_align - align spectra in frequency frame
115 rotate_xyphase - rotate XY phase of cross correlation
116 rotate_linpolphase - rotate the phase of the complex
117 polarization O=Q+iU correlation
118 freq_switch - perform frequency switching on the data
119 stats - Determine the specified statistic, e.g. 'min'
120 'max', 'rms' etc.
121 stddev - Determine the standard deviation of the current
122 beam/if/pol
123
124 [Math] Mainly functions which operate on more than one scantable
125
126 average_time - return the (weighted) time average
127 of a list of scans
128 quotient - return the on/off quotient
129 simple_math - simple mathematical operations on two scantables,
130 'add', 'sub', 'mul', 'div'
131 [Fitting]
132 fitter
133 auto_fit - return a scan where the function is
134 applied to all Beams/IFs/Pols.
135 commit - return a new scan where the fits have been
136 commited.
137 fit - execute the actual fitting process
138 store_fit - store the fit paramaters in the data (scantable)
139 get_chi2 - get the Chi^2
140 set_scan - set the scantable to be fit
141 set_function - set the fitting function
142 set_parameters - set the parameters for the function(s), and
143 set if they should be held fixed during fitting
144 set_gauss_parameters - same as above but specialised for individual
145 gaussian components
146 get_parameters - get the fitted parameters
147 plot - plot the resulting fit and/or components and
148 residual
149 [Plotter]
150 asapplotter - a plotter for asap, default plotter is
151 called 'plotter'
152 plot - plot a (list of) scantable
153 save - save the plot to a file ('png' ,'ps' or 'eps')
154 set_mode - set the state of the plotter, i.e.
155 what is to be plotted 'colour stacked'
156 and what 'panelled'
157 set_cursor - only plot a selected part of the data
158 set_range - set a 'zoom' window [xmin,xmax,ymin,ymax]
159 set_legend - specify user labels for the legend indeces
160 set_title - specify user labels for the panel indeces
161 set_abcissa - specify a user label for the abcissa
162 set_ordinate - specify a user label for the ordinate
163 set_layout - specify the multi-panel layout (rows,cols)
164 set_colors - specify a set of colours to use
165 set_linestyles - specify a set of linestyles to use if only
166 using one color
167 set_mask - set a plotting mask for a specific polarization
168
169 [Reading files]
170 reader - access rpfits/sdfits files
171 read - read in integrations
172 summary - list info about all integrations
173
174 [General]
175 commands - this command
176 print - print details about a variable
177 list_scans - list all scantables created bt the user
178 del - delete the given variable from memory
179 range - create a list of values, e.g.
180 range(3) = [0,1,2], range(2,5) = [2,3,4]
181 help - print help for one of the listed functions
182 execfile - execute an asap script, e.g. execfile('myscript')
183 list_rcparameters - print out a list of possible values to be
184 put into $HOME/.asaprc
185 mask_and,mask_or,
186 mask_not - boolean operations on masks created with
187 scantable.create_mask
188
189 Note:
190 How to use this with help:
191 # function 'summary'
192 [xxx] is just a category
193 Every 'sub-level' in this list should be replaces by a '.' Period when
194 using help
195 Example:
196 ASAP> help scantable # to get info on ths scantable
197 ASAP> help scantable.summary # to get help on the scantable's
198 ASAP> help average_time
199
200
201</pre>
202<!-- End Content -->
203<?php footer(); ?>
204</body>
205</html>
Note: See TracBrowser for help on using the repository browser.