asap.asapmath

Package asap :: Module asapmath

[show private | hide private]

Module asap.asapmath

Function Summary
	`average_time(args, *kwargs)` Return the (time) average of a scan or list of scans.
	`merge(*args)` Merge a list of scanatables, or comma-sperated scantables into one scnatble.
	`quotient(source, reference, preserve)` Return the quotient of a 'source' (signal) scan and a 'reference' scan.
	`simple_math(left, right, op, tsys)` Apply simple mathematical binary operations to two scan tables, returning the result in a new scan table.

Function Details

average_time(*args, **kwargs)

Return the (time) average of a scan or list of scans. [in channels only]
The cursor of the output scan is set to 0
Parameters:
    one scan or comma separated  scans or a list of scans
    mask:     an optional mask (only used for 'var' and 'tsys' weighting)
    scanav:   True averages each scan separately.
              False (default) averages all scans together,
    weight:   Weighting scheme.
                'none'     (mean no weight)
                'var'      (1/var(spec) weighted)
                'tsys'     (1/Tsys**2 weighted)
                'tint'     (integration time weighted)
                'tintsys'  (Tint/Tsys**2)
                'median'   ( median averaging)
    align:    align the spectra in velocity before averaging. It takes
              the time of the first spectrum in the first scantable
              as reference time.
Example:
    # return a time averaged scan from scana and scanb
    # without using a mask
    scanav = average_time(scana,scanb)
    # or equivalent
    # scanav = average_time([scana, scanb])
    # return the (time) averaged scan, i.e. the average of
    # all correlator cycles
    scanav = average_time(scan, scanav=True)

merge(*args)

Merge a list of scanatables, or comma-sperated scantables into one
scnatble.
Parameters:
    A list [scan1, scan2] or scan1, scan2.
Example:
    myscans = [scan1, scan2]
    allscans = merge(myscans)
    # or equivalent
    sameallscans = merge(scan1, scan2)

quotient(source, reference, preserve=True)

Return the quotient of a 'source' (signal) scan and a 'reference' scan.
The reference can have just one scan, even if the signal has many. Otherwise
they must have the same number of scans.
The cursor of the output scan is set to 0
Parameters:
    source:        the 'on' scan
    reference:     the 'off' scan
    preserve:      you can preserve (default) the continuum or
                   remove it.  The equations used are
                   preserve:  Output = Toff * (on/off) - Toff
                   remove:    Output = Toff * (on/off) - Ton

simple_math(left, right, op='add', tsys=True)

Apply simple mathematical binary operations to two
scan tables,  returning the result in a new scan table.
The operation is applied to both the correlations and the TSys data
The cursor of the output scan is set to 0
Parameters:
    left:          the 'left' scan
    right:         the 'right' scan
    op:            the operation: 'add' (default), 'sub', 'mul', 'div'
    tsys:          if True (default) then apply the operation to Tsys
                   as well as the data

Generated by Epydoc 2.1 on Wed May 2 14:24:33 2007

http://epydoc.sf.net