Changeset 1040


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

Web doc update for usage of ASAP v2

Location:
trunk/web
Files:
5 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 -->
  • trunk/web/index.html

    r796 r1040  
    4747
    4848<h2>Current Release</h2>
    49 ASAP latest stable version 1.2.1 was released on December, 6<sup>th</sup> 2005. It can be obtained in the <a href="#download">Download</a> section.
     49ASAP latest stable version 2.0 was released on April, 27<sup>th</sup> 2006. It can be obtained in the <a href="#download">Download</a> section.
    5050
    5151<h2>Screenshots</h2>
     
    5656<pre style="color: blue">
    5757Loading ASAP...
    58 Welcome to ASAP v1.2.1 (2005/12/06) - the ATNF Spectral Analysis Package
     58Welcome to ASAP v2.0 (2006/04/27) - the ATNF Spectral Analysis Package
    5959
    60 Please report any bugs to:
    61 asap@atnf.csiro.au
     60Please report any bugs via:
     61http://sourcecode.atnf.csiro.au/cgi-bin/trac_asap.cgi/newticket
    6262
    6363[IMPORTANT: ASAP is 0-based]
  • trunk/web/intro.html

    r664 r1040  
    4444It has been developed in the last nine months and has been released to
    4545ATNF users.
     46ASAP v2.0 underwent a major re-design to support varying numbers of channels per IF (or Beam). It also allows much more flexible data selection via the <b>seletcor</b> object.
    4647Currently, the package has only been tested on linux (debian) system,
    4748other linux and OSX binaries are going to be avaliable soon.
  • trunk/web/tutorials/tutorial.html

    r680 r1040  
    6767plotter.plot(s) # plot s
    6868</pre></div>
    69 Now we can build the quotient. This applies the quotient to both IFs. We are taking all scans ending in "_S" to be "on" source and all "_R" to be "off".
     69Now we can build the quotient. This applies the quotient to both IFs.
    7070<div class=code><pre>
    71 q = quotient(s.get_scan("*_S"),s.get_scan("*_R"))
     71q = auto_quotient()
    7272plotter.plot(q) # plot q
    7373</pre></div>
     
    7777q.set_restfreqs(restfreqs,"GHz") # set the restfrequencies, as not in data
    7878q.set_unit("km/s")               # set the unit to be used from now on
    79 q.set_freqframe("LSRK")          # set frequency frame 
    80 plotter.plot()                   # replot, should show velocity now 
     79q.set_freqframe("LSRK")          # set frequency frame
     80plotter.plot()                   # replot, should show velocity now
    8181</pre></div>
    82 Now we can subtract a baseline. ASAP can do this automatically if ther is good S/N and the lines aren't too broad. 
     82Now we can subtract a baseline. ASAP can do this automatically if ther is good S/N and the lines aren't too broad.
    8383<div class=code><pre>
    8484q.auto_poly_baseline() # determine and subtract a poly baseline automatically
     
    115115<div class=code><pre>
    116116f = fitter()
     117</pre></div>
     118We start with the first spectrum (IF=0) bys setting the selection. We want to fit two gaussian components.
     119<div class=code><pre>
     120sel = selector()
     121sel.set_ifs(0)
     122q.set_selection(sel)
    117123f.set_scan(q)
    118 </pre></div>
    119 We start with the first spectrum (IF=0) bys setting the cursor. We want to fits to gaussian components.
    120 <div class=code><pre>
    121 q.set_cursor(IF=0)
    122124f.set_function(gauss=2) # fit two gaussians
    123125f.fit()
     
    126128The second IFs spectrum is more complex. We select it and fit seven gaussians to it. Here we also plot residuals, the individual components and the fit parameters.
    127129<div class=code><pre>
    128 q.set_cursor(IF=1)
     130sel.set_ifs(1)
     131q.set_selection(sel)
    129132f.set_function(gauss=7)
    130133f.fit()
  • trunk/web/tutorials/tutorial2.html

    r680 r1040  
    8888quotients = []                        # to hold the quotient scantables
    8989for scan in vec:                      # loop over input scantables
    90    on = scan.get_source("*_S")       
    91    off = scan.get_source("*_R")
    92    quotients.append(quotient(on,off)) # add this quotient to the vector
     90   quotients.append(scan.auto_quotient()) # add this quotient to the vector
    9391</pre></div>
    9492Let's have a look at the vector, and subtract a baseline
     
    9694for q in quotients:
    9795   print q
    98    q.auto_poly_baseline(order=1,insitu=True) 
     96   q.auto_poly_baseline(order=1,insitu=True)
    9997</pre></div>
    10098Now we average the lot together:
Note: See TracChangeset for help on using the changeset viewer.