Ignore:
Timestamp:
04/27/06 14:08:06 (18 years ago)
Author:
mar637
Message:

Web doc update for usage of ASAP v2

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/web/commands.html

    r794 r1040  
    4141<h1><a href="index.html">ASAP</a> 'commands'</h1>
    4242<pre class="commands">
    43 ASAP> commands
    44 ----> commands()
     43ASAP> commands()
    4544
    4645    [The scan container]
     
    5049            get_scan        - gets a specific scan out of a scantable
    5150                              (by name or number)
     51            set_selection   - set a new subselection of the data
     52            get_selection   - get the current selection object
    5253            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
    5654            stats           - get specified statistic of the spectra in
    5755                              the scantable
     
    6462            get_elevation   - get the elevation of the scans
    6563            get_parangle    - get the parallactic angle of the scans
    66             get_unit        - get the currnt unit
     64            get_unit        - get the current unit
    6765            set_unit        - set the abcissa unit to be used from this
    6866                              point on
     
    7270                              (e.g. 'LSRK')
    7371            set_doppler     - set the doppler to be used from this point on
     72            set_dirframe    - set the frame for the direction on the sky
    7473            set_instrument  - set the instrument name
    7574            get_fluxunit    - get the brightness flux unit
     
    8079            get_restfreqs   - get the current list of rest frequencies
    8180            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
     81            flag            - flag selected channels in the data
    8482            save            - save the scantable to disk as either 'ASAP'
    8583                              or 'SDFITS'
    8684            nbeam,nif,nchan,npol - the number of beams/IFs/Pols/Chans
    8785            nscan           - the number of scans in the scantable
    88             nrow            - te number of integrations in the scantable
     86            nrow            - te number of spectra in the scantable
    8987            history         - print the history of the scantable
    9088            get_fit         - get a fit which has been stored witnh the data
     
    9593                              all polarisations will contain the
    9694                              averaged spectrum.
     95            convert_pol     - convert to a different polarisation type
    9796            auto_quotient   - return the on/off quotient with
    9897                              automatic detection of the on/off scans
    9998                              (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
     99            scale, *, /     - return a scan scaled by a given factor
     100            add, +, -       - return a scan with given value added
    103101            bin             - return a scan with binned channels
    104102            resample        - return a scan with resampled channels
     
    113111                              units
    114112            freq_align      - align spectra in frequency frame
     113            invert_phase    - Invert the phase of the cross-correlation
     114            swap_linears    - Swap XX and YY
    115115            rotate_xyphase  - rotate XY phase of cross correlation
    116116            rotate_linpolphase - rotate the phase of the complex
     
    121121            stddev          - Determine the standard deviation of the current
    122122                              beam/if/pol
     123     [Selection]
     124         selector              - a selection object to set a subset of a scantable
     125            set_scans          - set (a list of) scans by index
     126            set_cycles         - set (a list of) cycles by index
     127            set_beams          - set (a list of) beamss by index
     128            set_ifs            - set (a list of) ifs by index
     129            set_polarisations  - set (a list of) polarisations by name
     130                                 or by index
     131            set_names          - set a selection by name (wildcards allowed)
     132            set_tsys           - set a selection by tsys thresholds
     133            reset              - unset all selections
     134            +                  - merge to selections
    123135
    124136     [Math] Mainly functions which operate on more than one scantable
     
    136148                              commited.
    137149            fit             - execute the actual fitting process
    138             store_fit       - store the fit paramaters in the data (scantable)
     150            store_fit       - store the fit parameters in the data (scantable)
    139151            get_chi2        - get the Chi^2
    140152            set_scan        - set the scantable to be fit
     
    150162        asapplotter         - a plotter for asap, default plotter is
    151163                              called 'plotter'
    152             plot            - plot a (list of) scantable
     164            plot            - plot a scantable
    153165            save            - save the plot to a file ('png' ,'ps' or 'eps')
    154166            set_mode        - set the state of the plotter, i.e.
    155167                              what is to be plotted 'colour stacked'
    156168                              and what 'panelled'
    157             set_cursor      - only plot a selected part of the data
     169            set_selection   - only plot a selected part of the data
    158170            set_range       - set a 'zoom' window [xmin,xmax,ymin,ymax]
    159171            set_legend      - specify user labels for the legend indeces
     
    165177            set_linestyles  - specify a set of linestyles to use if only
    166178                              using one color
     179            set_histrogra,  - plot in historam style
    167180            set_mask        - set a plotting mask for a specific polarization
    168181
    169182    [Reading files]
    170183        reader              - access rpfits/sdfits files
     184            open            - attach reader to a file
     185            close           - detach reader from file
    171186            read            - read in integrations
    172187            summary         - list info about all integrations
     
    176191        print               - print details about a variable
    177192        list_scans          - list all scantables created bt the user
     193        list_files          - list all files readable by asap (default rpf)
    178194        del                 - delete the given variable from memory
    179195        range               - create a list of values, e.g.
     
    198214            ASAP> help average_time
    199215
    200 
    201216</pre>
    202217<!-- End Content -->
Note: See TracChangeset for help on using the changeset viewer.