source: trunk/web/commands.html@ 678

Last change on this file since 678 was 664, checked in by mar637, 19 years ago

* empty log message *

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