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