| 1 | from scantable import scantable |
|---|
| 2 | from asap import rcParams |
|---|
| 3 | from asap import print_log |
|---|
| 4 | |
|---|
| 5 | def average_time(*args, **kwargs): |
|---|
| 6 | """ |
|---|
| 7 | Return the (time) average of a scan or list of scans. [in channels only] |
|---|
| 8 | The cursor of the output scan is set to 0 |
|---|
| 9 | Parameters: |
|---|
| 10 | one scan or comma separated scans |
|---|
| 11 | mask: an optional mask (only used for 'var' and 'tsys' weighting) |
|---|
| 12 | scanav: True averages each scan separately. |
|---|
| 13 | False (default) averages all scans together, |
|---|
| 14 | weight: Weighting scheme. 'none, 'var' (1/var(spec) |
|---|
| 15 | weighted), 'tsys' (1/Tsys**2 weighted), 'tint' |
|---|
| 16 | (integration time weighted) or 'tintsys' (Tsys |
|---|
| 17 | and tint). The default is 'tint' |
|---|
| 18 | align: align the spectra in velocity before averaging. It takes |
|---|
| 19 | the time of the first spectrum in the first scantable |
|---|
| 20 | as reference time. |
|---|
| 21 | Example: |
|---|
| 22 | # return a time averaged scan from scana and scanb |
|---|
| 23 | # without using a mask |
|---|
| 24 | scanav = average_time(scana,scanb) |
|---|
| 25 | # return the (time) averaged scan, i.e. the average of |
|---|
| 26 | # all correlator cycles |
|---|
| 27 | scanav = average_time(scan, scanav=True) |
|---|
| 28 | """ |
|---|
| 29 | scanav = False |
|---|
| 30 | if kwargs.has_key('scanav'): |
|---|
| 31 | scanav = kwargs.get('scanav') |
|---|
| 32 | weight = 'tint' |
|---|
| 33 | if kwargs.has_key('weight'): |
|---|
| 34 | weight = kwargs.get('weight') |
|---|
| 35 | mask = () |
|---|
| 36 | if kwargs.has_key('mask'): |
|---|
| 37 | mask = kwargs.get('mask') |
|---|
| 38 | align = False |
|---|
| 39 | if kwargs.has_key('align'): |
|---|
| 40 | align = kwargs.get('align') |
|---|
| 41 | varlist = vars() |
|---|
| 42 | if isinstance(args[0],list): |
|---|
| 43 | lst = tuple(args[0]) |
|---|
| 44 | elif isinstance(args[0],tuple): |
|---|
| 45 | lst = args[0] |
|---|
| 46 | else: |
|---|
| 47 | lst = tuple(args) |
|---|
| 48 | |
|---|
| 49 | del varlist["kwargs"] |
|---|
| 50 | varlist["args"] = "%d scantables" % len(lst) |
|---|
| 51 | # need special formatting her for history... |
|---|
| 52 | |
|---|
| 53 | from asap._asap import stmath |
|---|
| 54 | stm = stmath() |
|---|
| 55 | for s in lst: |
|---|
| 56 | if not isinstance(s,scantable): |
|---|
| 57 | msg = "Please give a list of scantables" |
|---|
| 58 | if rcParams['verbose']: |
|---|
| 59 | print msg |
|---|
| 60 | return |
|---|
| 61 | else: |
|---|
| 62 | raise TypeError(msg) |
|---|
| 63 | if scanav: scanav = "SCAN" |
|---|
| 64 | else: scanav = "NONE" |
|---|
| 65 | s = scantable(stm._average(lst, mask, weight, scanav, align)) |
|---|
| 66 | s._add_history("average_time",varlist) |
|---|
| 67 | print_log() |
|---|
| 68 | return s |
|---|
| 69 | |
|---|
| 70 | # def quotient(source, reference, preserve=True): |
|---|
| 71 | # """ |
|---|
| 72 | # Return the quotient of a 'source' (signal) scan and a 'reference' scan. |
|---|
| 73 | # The reference can have just one row, even if the signal has many. Otherwise |
|---|
| 74 | # they must have the same number of rows. |
|---|
| 75 | # The cursor of the output scan is set to 0 |
|---|
| 76 | # Parameters: |
|---|
| 77 | # source: the 'on' scan |
|---|
| 78 | # reference: the 'off' scan |
|---|
| 79 | # preserve: you can preserve (default) the continuum or |
|---|
| 80 | # remove it. The equations used are |
|---|
| 81 | # preserve: Output = Toff * (on/off) - Toff |
|---|
| 82 | # remove: Output = Toff * (on/off) - Ton |
|---|
| 83 | # """ |
|---|
| 84 | # varlist = vars() |
|---|
| 85 | # from asap._asap import quotient as _quot |
|---|
| 86 | # s = scantable(_quot(source, reference, preserve)) |
|---|
| 87 | # s._add_history("quotient",varlist) |
|---|
| 88 | # print_log() |
|---|
| 89 | # return s |
|---|
| 90 | |
|---|
| 91 | def simple_math(left, right, op='add', tsys=True): |
|---|
| 92 | """ |
|---|
| 93 | Apply simple mathematical binary operations to two |
|---|
| 94 | scan tables, returning the result in a new scan table. |
|---|
| 95 | The operation is applied to both the correlations and the TSys data |
|---|
| 96 | The cursor of the output scan is set to 0 |
|---|
| 97 | Parameters: |
|---|
| 98 | left: the 'left' scan |
|---|
| 99 | right: the 'right' scan |
|---|
| 100 | op: the operation: 'add' (default), 'sub', 'mul', 'div' |
|---|
| 101 | tsys: if True (default) then apply the operation to Tsys |
|---|
| 102 | as well as the data |
|---|
| 103 | """ |
|---|
| 104 | varlist = vars() |
|---|
| 105 | print "Not yet available in asap" |
|---|
| 106 | return |
|---|
| 107 | if not isinstance(left,scantable) and not isinstance(right,scantable): |
|---|
| 108 | msg = "Please provide two scantables as input" |
|---|
| 109 | if rcParams['verbose']: |
|---|
| 110 | print msg |
|---|
| 111 | return |
|---|
| 112 | else: |
|---|
| 113 | raise TypeError(msg) |
|---|
| 114 | s = scantable(stm._bop(left, right, op, tsys)) |
|---|
| 115 | s._add_history("simple_math", varlist) |
|---|
| 116 | print_log() |
|---|
| 117 | return s |
|---|
| 118 | |
|---|
| 119 | def merge(*args): |
|---|
| 120 | """ |
|---|
| 121 | """ |
|---|
| 122 | varlist = vars() |
|---|
| 123 | if isinstance(args[0],list): |
|---|
| 124 | lst = tuple(args[0]) |
|---|
| 125 | elif isinstance(args[0],tuple): |
|---|
| 126 | lst = args[0] |
|---|
| 127 | else: |
|---|
| 128 | lst = tuple(args) |
|---|
| 129 | varlist["args"] = "%d scantables" % len(lst) |
|---|
| 130 | # need special formatting her for history... |
|---|
| 131 | from asap._asap import stmath |
|---|
| 132 | stm = stmath() |
|---|
| 133 | for s in lst: |
|---|
| 134 | if not isinstance(s,scantable): |
|---|
| 135 | msg = "Please give a list of scantables" |
|---|
| 136 | if rcParams['verbose']: |
|---|
| 137 | print msg |
|---|
| 138 | return |
|---|
| 139 | else: |
|---|
| 140 | raise TypeError(msg) |
|---|
| 141 | s = scantable(stm._merge(lst)) |
|---|
| 142 | s._add_history("merge", varlist) |
|---|
| 143 | print_log() |
|---|
| 144 | return s |
|---|
