[100] | 1 | """ |
---|
| 2 | This is the ATNF Single Dish Analysis package. |
---|
| 3 | |
---|
| 4 | """ |
---|
[1080] | 5 | import os,sys,shutil, platform |
---|
[226] | 6 | |
---|
[1080] | 7 | # Set up AIPSPATH and first time use of asap i.e. ~/.asap/* |
---|
| 8 | plf = None |
---|
| 9 | if sys.platform == "linux2": |
---|
| 10 | if platform.architecture()[0] == '64bit': |
---|
| 11 | plf = 'linux_64b' |
---|
| 12 | else: |
---|
| 13 | plf = 'linux_gnu' |
---|
| 14 | elif sys.platform == 'darwin': |
---|
| 15 | plf = 'darwin' |
---|
| 16 | else: |
---|
| 17 | # Shouldn't happen - default to linux |
---|
| 18 | plf = 'linux' |
---|
| 19 | asapdata = __path__[-1] |
---|
[1171] | 20 | # Allow user defined data location |
---|
| 21 | if os.environ.has_key("ASAPDATA"): |
---|
| 22 | if os.path.exists(os.environ["ASAPDATA"]): |
---|
| 23 | asapdata = os.environ["ASAPDATA"] |
---|
[1080] | 24 | os.environ["AIPSPATH"] = "%s %s somwhere" % ( asapdata, plf) |
---|
[1171] | 25 | # set up user space |
---|
[1080] | 26 | userdir = os.environ["HOME"]+"/.asap" |
---|
| 27 | if not os.path.exists(userdir): |
---|
| 28 | print 'First time ASAP use. Setting up ~/.asap' |
---|
| 29 | os.mkdir(userdir) |
---|
| 30 | shutil.copyfile(asapdata+"/data/ipythonrc-asap", userdir+"/ipythonrc-asap") |
---|
| 31 | f = file(userdir+"/asapuserfuncs.py", "w") |
---|
| 32 | f.close() |
---|
| 33 | f = file(userdir+"/ipythonrc", "w") |
---|
| 34 | f.close() |
---|
[1171] | 35 | # remove from namespace |
---|
[1080] | 36 | del asapdata, userdir, shutil, platform |
---|
| 37 | |
---|
[513] | 38 | def _validate_bool(b): |
---|
[226] | 39 | 'Convert b to a boolean or raise' |
---|
| 40 | bl = b.lower() |
---|
| 41 | if bl in ('f', 'no', 'false', '0', 0): return False |
---|
| 42 | elif bl in ('t', 'yes', 'true', '1', 1): return True |
---|
| 43 | else: |
---|
| 44 | raise ValueError('Could not convert "%s" to boolean' % b) |
---|
| 45 | |
---|
[513] | 46 | def _validate_int(s): |
---|
[226] | 47 | 'convert s to int or raise' |
---|
| 48 | try: return int(s) |
---|
| 49 | except ValueError: |
---|
| 50 | raise ValueError('Could not convert "%s" to int' % s) |
---|
| 51 | |
---|
[513] | 52 | def _asap_fname(): |
---|
[226] | 53 | """ |
---|
| 54 | Return the path to the rc file |
---|
| 55 | |
---|
| 56 | Search order: |
---|
| 57 | |
---|
| 58 | * current working dir |
---|
| 59 | * environ var ASAPRC |
---|
[274] | 60 | * HOME/.asaprc |
---|
[706] | 61 | |
---|
[226] | 62 | """ |
---|
| 63 | |
---|
| 64 | fname = os.path.join( os.getcwd(), '.asaprc') |
---|
| 65 | if os.path.exists(fname): return fname |
---|
| 66 | |
---|
| 67 | if os.environ.has_key('ASAPRC'): |
---|
| 68 | path = os.environ['ASAPRC'] |
---|
| 69 | if os.path.exists(path): |
---|
| 70 | fname = os.path.join(path, '.asaprc') |
---|
| 71 | if os.path.exists(fname): |
---|
| 72 | return fname |
---|
| 73 | |
---|
| 74 | if os.environ.has_key('HOME'): |
---|
| 75 | home = os.environ['HOME'] |
---|
| 76 | fname = os.path.join(home, '.asaprc') |
---|
| 77 | if os.path.exists(fname): |
---|
| 78 | return fname |
---|
| 79 | return None |
---|
| 80 | |
---|
[706] | 81 | |
---|
[226] | 82 | defaultParams = { |
---|
| 83 | # general |
---|
[513] | 84 | 'verbose' : [True, _validate_bool], |
---|
| 85 | 'useplotter' : [True, _validate_bool], |
---|
[542] | 86 | 'insitu' : [True, _validate_bool], |
---|
[706] | 87 | |
---|
[226] | 88 | # plotting |
---|
[706] | 89 | 'plotter.gui' : [True, _validate_bool], |
---|
[226] | 90 | 'plotter.stacking' : ['p', str], |
---|
| 91 | 'plotter.panelling' : ['s', str], |
---|
[700] | 92 | 'plotter.colours' : ['', str], |
---|
| 93 | 'plotter.linestyles' : ['', str], |
---|
[710] | 94 | 'plotter.decimate' : [False, _validate_bool], |
---|
| 95 | 'plotter.ganged' : [True, _validate_bool], |
---|
[1022] | 96 | 'plotter.histogram' : [False, _validate_bool], |
---|
[1097] | 97 | 'plotter.papertype' : ['A4', str], |
---|
[710] | 98 | |
---|
[226] | 99 | # scantable |
---|
| 100 | 'scantable.save' : ['ASAP', str], |
---|
[513] | 101 | 'scantable.autoaverage' : [True, _validate_bool], |
---|
[226] | 102 | 'scantable.freqframe' : ['LSRK', str], #default frequency frame |
---|
[1076] | 103 | 'scantable.verbosesummary' : [False, _validate_bool], |
---|
| 104 | 'scantable.storage' : ['memory', str] |
---|
[226] | 105 | # fitter |
---|
| 106 | } |
---|
| 107 | |
---|
[255] | 108 | def list_rcparameters(): |
---|
[706] | 109 | |
---|
[255] | 110 | print """ |
---|
[737] | 111 | # general |
---|
| 112 | # print verbose output |
---|
| 113 | verbose : True |
---|
[255] | 114 | |
---|
[737] | 115 | # preload a default plotter |
---|
| 116 | useplotter : True |
---|
[255] | 117 | |
---|
[737] | 118 | # apply operations on the input scantable or return new one |
---|
| 119 | insitu : True |
---|
[706] | 120 | |
---|
[737] | 121 | # plotting |
---|
[710] | 122 | |
---|
[737] | 123 | # do we want a GUI or plot to a file |
---|
| 124 | plotter.gui : True |
---|
[710] | 125 | |
---|
[737] | 126 | # default mode for colour stacking |
---|
| 127 | plotter.stacking : Pol |
---|
[255] | 128 | |
---|
[737] | 129 | # default mode for panelling |
---|
| 130 | plotter.panelling : scan |
---|
[255] | 131 | |
---|
[737] | 132 | # push panels together, to share axislabels |
---|
| 133 | plotter.ganged : True |
---|
[710] | 134 | |
---|
[737] | 135 | # decimate the number of points plotted bya afactor of |
---|
| 136 | # nchan/1024 |
---|
| 137 | plotter.decimate : False |
---|
[733] | 138 | |
---|
[737] | 139 | # default colours/linestyles |
---|
| 140 | plotter.colours : |
---|
| 141 | plotter.linestyles : |
---|
[700] | 142 | |
---|
[1022] | 143 | # enable/disable histogram plotting |
---|
| 144 | plotter.histogram : False |
---|
| 145 | |
---|
[1097] | 146 | # ps paper type |
---|
| 147 | plotter.papertype : A4 |
---|
| 148 | |
---|
[737] | 149 | # scantable |
---|
[1076] | 150 | |
---|
[1258] | 151 | # default storage of scantable ('memory'/'disk') |
---|
[1076] | 152 | scantable.storage : memory |
---|
[737] | 153 | # default ouput format when saving |
---|
| 154 | scantable.save : ASAP |
---|
| 155 | # auto averaging on read |
---|
| 156 | scantable.autoaverage : True |
---|
[255] | 157 | |
---|
[737] | 158 | # default frequency frame to set when function |
---|
[1097] | 159 | # scantable.set_freqframe is called |
---|
[737] | 160 | scantable.freqframe : LSRK |
---|
[255] | 161 | |
---|
[737] | 162 | # Control the level of information printed by summary |
---|
| 163 | scantable.verbosesummary : False |
---|
[706] | 164 | |
---|
[737] | 165 | # Fitter |
---|
| 166 | """ |
---|
[706] | 167 | |
---|
[226] | 168 | def rc_params(): |
---|
| 169 | 'Return the default params updated from the values in the rc file' |
---|
[706] | 170 | |
---|
[513] | 171 | fname = _asap_fname() |
---|
[706] | 172 | |
---|
[226] | 173 | if fname is None or not os.path.exists(fname): |
---|
| 174 | message = 'could not find rc file; returning defaults' |
---|
| 175 | ret = dict([ (key, tup[0]) for key, tup in defaultParams.items()]) |
---|
| 176 | #print message |
---|
| 177 | return ret |
---|
[706] | 178 | |
---|
[226] | 179 | cnt = 0 |
---|
| 180 | for line in file(fname): |
---|
| 181 | cnt +=1 |
---|
| 182 | line = line.strip() |
---|
| 183 | if not len(line): continue |
---|
| 184 | if line.startswith('#'): continue |
---|
| 185 | tup = line.split(':',1) |
---|
| 186 | if len(tup) !=2: |
---|
| 187 | print ('Illegal line #%d\n\t%s\n\tin file "%s"' % (cnt, line, fname)) |
---|
| 188 | continue |
---|
[706] | 189 | |
---|
[226] | 190 | key, val = tup |
---|
| 191 | key = key.strip() |
---|
| 192 | if not defaultParams.has_key(key): |
---|
| 193 | print ('Bad key "%s" on line %d in %s' % (key, cnt, fname)) |
---|
| 194 | continue |
---|
[706] | 195 | |
---|
[226] | 196 | default, converter = defaultParams[key] |
---|
| 197 | |
---|
| 198 | ind = val.find('#') |
---|
| 199 | if ind>=0: val = val[:ind] # ignore trailing comments |
---|
| 200 | val = val.strip() |
---|
| 201 | try: cval = converter(val) # try to convert to proper type or raise |
---|
[1080] | 202 | except ValueError, msg: |
---|
[226] | 203 | print ('Bad val "%s" on line #%d\n\t"%s"\n\tin file "%s"\n\t%s' % (val, cnt, line, fname, msg)) |
---|
| 204 | continue |
---|
| 205 | else: |
---|
| 206 | # Alles Klar, update dict |
---|
| 207 | defaultParams[key][0] = cval |
---|
| 208 | |
---|
| 209 | # strip the conveter funcs and return |
---|
| 210 | ret = dict([ (key, tup[0]) for key, tup in defaultParams.items()]) |
---|
[466] | 211 | print ('loaded rc file %s'%fname) |
---|
[226] | 212 | |
---|
| 213 | return ret |
---|
| 214 | |
---|
| 215 | |
---|
| 216 | # this is the instance used by the asap classes |
---|
[706] | 217 | rcParams = rc_params() |
---|
[226] | 218 | |
---|
| 219 | rcParamsDefault = dict(rcParams.items()) # a copy |
---|
| 220 | |
---|
| 221 | def rc(group, **kwargs): |
---|
| 222 | """ |
---|
| 223 | Set the current rc params. Group is the grouping for the rc, eg |
---|
[379] | 224 | for scantable.save the group is 'scantable', for plotter.stacking, the |
---|
| 225 | group is 'plotter', and so on. kwargs is a list of attribute |
---|
[226] | 226 | name/value pairs, eg |
---|
| 227 | |
---|
[379] | 228 | rc('scantable', save='SDFITS') |
---|
[226] | 229 | |
---|
| 230 | sets the current rc params and is equivalent to |
---|
[706] | 231 | |
---|
[379] | 232 | rcParams['scantable.save'] = 'SDFITS' |
---|
[226] | 233 | |
---|
| 234 | Use rcdefaults to restore the default rc params after changes. |
---|
| 235 | """ |
---|
| 236 | |
---|
[379] | 237 | aliases = {} |
---|
[706] | 238 | |
---|
[226] | 239 | for k,v in kwargs.items(): |
---|
| 240 | name = aliases.get(k) or k |
---|
| 241 | key = '%s.%s' % (group, name) |
---|
| 242 | if not rcParams.has_key(key): |
---|
| 243 | raise KeyError('Unrecognized key "%s" for group "%s" and name "%s"' % (key, group, name)) |
---|
[706] | 244 | |
---|
[226] | 245 | rcParams[key] = v |
---|
| 246 | |
---|
| 247 | |
---|
| 248 | def rcdefaults(): |
---|
| 249 | """ |
---|
| 250 | Restore the default rc params - the ones that were created at |
---|
| 251 | asap load time |
---|
| 252 | """ |
---|
| 253 | rcParams.update(rcParamsDefault) |
---|
| 254 | |
---|
[513] | 255 | |
---|
| 256 | def _is_sequence_or_number(param, ptype=int): |
---|
| 257 | if isinstance(param,tuple) or isinstance(param,list): |
---|
[928] | 258 | if len(param) == 0: return True # empty list |
---|
[513] | 259 | out = True |
---|
| 260 | for p in param: |
---|
| 261 | out &= isinstance(p,ptype) |
---|
| 262 | return out |
---|
| 263 | elif isinstance(param, ptype): |
---|
| 264 | return True |
---|
| 265 | return False |
---|
| 266 | |
---|
[928] | 267 | def _to_list(param, ptype=int): |
---|
| 268 | if isinstance(param, ptype): |
---|
| 269 | if ptype is str: return param.split() |
---|
| 270 | else: return [param] |
---|
| 271 | if _is_sequence_or_number(param, ptype): |
---|
| 272 | return param |
---|
| 273 | return None |
---|
[715] | 274 | |
---|
[944] | 275 | def unique(x): |
---|
[992] | 276 | """ |
---|
| 277 | Return the unique values in a list |
---|
| 278 | Parameters: |
---|
| 279 | x: the list to reduce |
---|
| 280 | Examples: |
---|
| 281 | x = [1,2,3,3,4] |
---|
| 282 | print unique(x) |
---|
| 283 | [1,2,3,4] |
---|
| 284 | """ |
---|
[944] | 285 | return dict([ (val, 1) for val in x]).keys() |
---|
| 286 | |
---|
[992] | 287 | def list_files(path=".",suffix="rpf"): |
---|
| 288 | """ |
---|
| 289 | Return a list files readable by asap, such as rpf, sdfits, mbf, asap |
---|
| 290 | Parameters: |
---|
| 291 | path: The directory to list (default '.') |
---|
| 292 | suffix: The file extension (default rpf) |
---|
| 293 | Example: |
---|
| 294 | files = list_files("data/","sdfits") |
---|
| 295 | print files |
---|
| 296 | ['data/2001-09-01_0332_P363.sdfits', |
---|
| 297 | 'data/2003-04-04_131152_t0002.sdfits', |
---|
| 298 | 'data/Sgr_86p262_best_SPC.sdfits'] |
---|
| 299 | """ |
---|
| 300 | import os |
---|
| 301 | if not os.path.isdir(path): |
---|
| 302 | return None |
---|
| 303 | valid = "rpf sdf sdfits mbf asap".split() |
---|
| 304 | if not suffix in valid: |
---|
| 305 | return None |
---|
| 306 | files = [os.path.expanduser(os.path.expandvars(path+"/"+f)) for f in os.listdir(path)] |
---|
| 307 | return filter(lambda x: x.endswith(suffix),files) |
---|
| 308 | |
---|
[715] | 309 | # workaround for ipython, which redirects this if banner=0 in ipythonrc |
---|
| 310 | sys.stdout = sys.__stdout__ |
---|
| 311 | sys.stderr = sys.__stderr__ |
---|
| 312 | |
---|
| 313 | # Logging |
---|
| 314 | from asap._asap import Log as _asaplog |
---|
| 315 | global asaplog |
---|
[710] | 316 | asaplog=_asaplog() |
---|
[715] | 317 | if rcParams['verbose']: |
---|
| 318 | asaplog.enable() |
---|
| 319 | else: |
---|
| 320 | asaplog.disable() |
---|
| 321 | |
---|
| 322 | def print_log(): |
---|
| 323 | log = asaplog.pop() |
---|
| 324 | if len(log) and rcParams['verbose']: print log |
---|
| 325 | return |
---|
| 326 | |
---|
[1134] | 327 | try: |
---|
| 328 | import numpy.core as NUM |
---|
| 329 | except ImportError: |
---|
| 330 | try: |
---|
| 331 | import numarray as NUM |
---|
| 332 | except ImportError: |
---|
| 333 | raise ImportError("You need to have numpy or numarray installed") |
---|
| 334 | |
---|
[1117] | 335 | from asapfitter import fitter |
---|
[895] | 336 | from asapreader import reader |
---|
[944] | 337 | from selector import selector |
---|
[710] | 338 | |
---|
[100] | 339 | from asapmath import * |
---|
[1080] | 340 | from scantable import scantable |
---|
[1097] | 341 | from asaplinefind import linefinder |
---|
[1134] | 342 | from linecatalog import linecatalog |
---|
[285] | 343 | |
---|
[1134] | 344 | mask_and = NUM.logical_and |
---|
| 345 | mask_or = NUM.logical_or |
---|
| 346 | mask_not = NUM.logical_not |
---|
[466] | 347 | |
---|
[928] | 348 | if rcParams['useplotter']: |
---|
[1097] | 349 | from asapplotter import asapplotter |
---|
[928] | 350 | gui = os.environ.has_key('DISPLAY') and rcParams['plotter.gui'] |
---|
[1175] | 351 | if gui: |
---|
| 352 | import pylab as xyplotter |
---|
[928] | 353 | plotter = asapplotter(gui) |
---|
| 354 | del gui |
---|
[285] | 355 | |
---|
[574] | 356 | __date__ = '$Date: 2006-09-11 05:03:57 +0000 (Mon, 11 Sep 2006) $'.split()[1] |
---|
[1258] | 357 | __version__ = '2.1' |
---|
[100] | 358 | |
---|
[1193] | 359 | def is_ipython(): |
---|
[1233] | 360 | return '__IP' in dir(sys.modules["__main__"]) |
---|
[1193] | 361 | if is_ipython(): |
---|
[1014] | 362 | def version(): print "ASAP %s(%s)"% (__version__, __date__) |
---|
[706] | 363 | def list_scans(t = scantable): |
---|
| 364 | import sys, types |
---|
| 365 | globs = sys.modules['__main__'].__dict__.iteritems() |
---|
| 366 | print "The user created scantables are:" |
---|
| 367 | sts = map(lambda x: x[0], filter(lambda x: isinstance(x[1], t), globs)) |
---|
| 368 | print filter(lambda x: not x.startswith('_'), sts) |
---|
| 369 | return |
---|
[100] | 370 | |
---|
[715] | 371 | def commands(): |
---|
| 372 | x = """ |
---|
[113] | 373 | [The scan container] |
---|
| 374 | scantable - a container for integrations/scans |
---|
[182] | 375 | (can open asap/rpfits/sdfits and ms files) |
---|
[113] | 376 | copy - returns a copy of a scan |
---|
| 377 | get_scan - gets a specific scan out of a scantable |
---|
[984] | 378 | (by name or number) |
---|
[1093] | 379 | drop_scan - drops a specific scan out of a scantable |
---|
| 380 | (by number) |
---|
[984] | 381 | set_selection - set a new subselection of the data |
---|
| 382 | get_selection - get the current selection object |
---|
[113] | 383 | summary - print info about the scantable contents |
---|
[182] | 384 | stats - get specified statistic of the spectra in |
---|
| 385 | the scantable |
---|
| 386 | stddev - get the standard deviation of the spectra |
---|
| 387 | in the scantable |
---|
[113] | 388 | get_tsys - get the TSys |
---|
| 389 | get_time - get the timestamps of the integrations |
---|
[733] | 390 | get_sourcename - get the source names of the scans |
---|
[794] | 391 | get_azimuth - get the azimuth of the scans |
---|
| 392 | get_elevation - get the elevation of the scans |
---|
| 393 | get_parangle - get the parallactic angle of the scans |
---|
[876] | 394 | get_unit - get the current unit |
---|
[513] | 395 | set_unit - set the abcissa unit to be used from this |
---|
| 396 | point on |
---|
[255] | 397 | get_abcissa - get the abcissa values and name for a given |
---|
| 398 | row (time) |
---|
[1233] | 399 | get_column_names - get the names of the columns in the scantable |
---|
| 400 | for use with selector.set_query |
---|
[113] | 401 | set_freqframe - set the frame info for the Spectral Axis |
---|
| 402 | (e.g. 'LSRK') |
---|
[276] | 403 | set_doppler - set the doppler to be used from this point on |
---|
[984] | 404 | set_dirframe - set the frame for the direction on the sky |
---|
[240] | 405 | set_instrument - set the instrument name |
---|
[1190] | 406 | set_feedtype - set the feed type |
---|
[255] | 407 | get_fluxunit - get the brightness flux unit |
---|
[240] | 408 | set_fluxunit - set the brightness flux unit |
---|
[188] | 409 | create_mask - return an mask in the current unit |
---|
| 410 | for the given region. The specified regions |
---|
| 411 | are NOT masked |
---|
[255] | 412 | get_restfreqs - get the current list of rest frequencies |
---|
| 413 | set_restfreqs - set a list of rest frequencies |
---|
[1012] | 414 | flag - flag selected channels in the data |
---|
[1192] | 415 | lag_flag - flag specified frequency in the data |
---|
[1151] | 416 | save - save the scantable to disk as either 'ASAP', |
---|
| 417 | 'SDFITS' or 'ASCII' |
---|
[486] | 418 | nbeam,nif,nchan,npol - the number of beams/IFs/Pols/Chans |
---|
[733] | 419 | nscan - the number of scans in the scantable |
---|
[984] | 420 | nrow - te number of spectra in the scantable |
---|
[486] | 421 | history - print the history of the scantable |
---|
[530] | 422 | get_fit - get a fit which has been stored witnh the data |
---|
[706] | 423 | average_time - return the (weighted) time average of a scan |
---|
[513] | 424 | or a list of scans |
---|
| 425 | average_pol - average the polarisations together. |
---|
[1144] | 426 | average_beam - average the beams together. |
---|
[992] | 427 | convert_pol - convert to a different polarisation type |
---|
[690] | 428 | auto_quotient - return the on/off quotient with |
---|
[1069] | 429 | automatic detection of the on/off scans (closest |
---|
| 430 | in time off is selected) |
---|
[1144] | 431 | mx_quotient - Form a quotient using MX data (off beams) |
---|
[1014] | 432 | scale, *, / - return a scan scaled by a given factor |
---|
| 433 | add, +, - - return a scan with given value added |
---|
[513] | 434 | bin - return a scan with binned channels |
---|
| 435 | resample - return a scan with resampled channels |
---|
| 436 | smooth - return the spectrally smoothed scan |
---|
| 437 | poly_baseline - fit a polynomial baseline to all Beams/IFs/Pols |
---|
[706] | 438 | auto_poly_baseline - automatically fit a polynomial baseline |
---|
[780] | 439 | recalc_azel - recalculate azimuth and elevation based on |
---|
| 440 | the pointing |
---|
[513] | 441 | gain_el - apply gain-elevation correction |
---|
| 442 | opacity - apply opacity correction |
---|
| 443 | convert_flux - convert to and from Jy and Kelvin brightness |
---|
[255] | 444 | units |
---|
[513] | 445 | freq_align - align spectra in frequency frame |
---|
[1014] | 446 | invert_phase - Invert the phase of the cross-correlation |
---|
| 447 | swap_linears - Swap XX and YY |
---|
[513] | 448 | rotate_xyphase - rotate XY phase of cross correlation |
---|
| 449 | rotate_linpolphase - rotate the phase of the complex |
---|
| 450 | polarization O=Q+iU correlation |
---|
[733] | 451 | freq_switch - perform frequency switching on the data |
---|
| 452 | stats - Determine the specified statistic, e.g. 'min' |
---|
| 453 | 'max', 'rms' etc. |
---|
| 454 | stddev - Determine the standard deviation of the current |
---|
| 455 | beam/if/pol |
---|
[1014] | 456 | [Selection] |
---|
| 457 | selector - a selection object to set a subset of a scantable |
---|
| 458 | set_scans - set (a list of) scans by index |
---|
| 459 | set_cycles - set (a list of) cycles by index |
---|
| 460 | set_beams - set (a list of) beamss by index |
---|
| 461 | set_ifs - set (a list of) ifs by index |
---|
| 462 | set_polarisations - set (a list of) polarisations by name |
---|
| 463 | or by index |
---|
| 464 | set_names - set a selection by name (wildcards allowed) |
---|
| 465 | set_tsys - set a selection by tsys thresholds |
---|
[1233] | 466 | set_query - set a selection by SQL-like query, e.g. BEAMNO==1 |
---|
[1014] | 467 | reset - unset all selections |
---|
| 468 | + - merge to selections |
---|
[733] | 469 | |
---|
[513] | 470 | [Math] Mainly functions which operate on more than one scantable |
---|
[100] | 471 | |
---|
[706] | 472 | average_time - return the (weighted) time average |
---|
[513] | 473 | of a list of scans |
---|
| 474 | quotient - return the on/off quotient |
---|
| 475 | simple_math - simple mathematical operations on two scantables, |
---|
| 476 | 'add', 'sub', 'mul', 'div' |
---|
[1069] | 477 | quotient - build quotient of the given on and off scans |
---|
| 478 | (matched pairs and 1 off/n on are valid) |
---|
[1117] | 479 | merge - merge a list of scantables |
---|
[1069] | 480 | |
---|
[1151] | 481 | [Line Catalog] |
---|
| 482 | linecatalog - a linecatalog wrapper, taking an ASCII or |
---|
| 483 | internal format table |
---|
| 484 | summary - print a summary of the current selection |
---|
| 485 | set_name - select a subset by name pattern, e.g. '*OH*' |
---|
| 486 | set_strength_limits - select a subset by line strength limits |
---|
| 487 | set_frequency_limits - select a subset by frequency limits |
---|
| 488 | reset - unset all selections |
---|
| 489 | save - save the current subset to a table (internal |
---|
| 490 | format) |
---|
| 491 | get_row - get the name and frequency from a specific |
---|
| 492 | row in the table |
---|
[513] | 493 | [Fitting] |
---|
[113] | 494 | fitter |
---|
| 495 | auto_fit - return a scan where the function is |
---|
| 496 | applied to all Beams/IFs/Pols. |
---|
| 497 | commit - return a new scan where the fits have been |
---|
| 498 | commited. |
---|
| 499 | fit - execute the actual fitting process |
---|
[984] | 500 | store_fit - store the fit parameters in the data (scantable) |
---|
[113] | 501 | get_chi2 - get the Chi^2 |
---|
| 502 | set_scan - set the scantable to be fit |
---|
| 503 | set_function - set the fitting function |
---|
| 504 | set_parameters - set the parameters for the function(s), and |
---|
| 505 | set if they should be held fixed during fitting |
---|
[513] | 506 | set_gauss_parameters - same as above but specialised for individual |
---|
| 507 | gaussian components |
---|
[113] | 508 | get_parameters - get the fitted parameters |
---|
[513] | 509 | plot - plot the resulting fit and/or components and |
---|
| 510 | residual |
---|
[210] | 511 | [Plotter] |
---|
| 512 | asapplotter - a plotter for asap, default plotter is |
---|
| 513 | called 'plotter' |
---|
[984] | 514 | plot - plot a scantable |
---|
[1151] | 515 | plot_lines - plot a linecatalog overlay |
---|
[378] | 516 | save - save the plot to a file ('png' ,'ps' or 'eps') |
---|
[210] | 517 | set_mode - set the state of the plotter, i.e. |
---|
| 518 | what is to be plotted 'colour stacked' |
---|
| 519 | and what 'panelled' |
---|
[984] | 520 | set_selection - only plot a selected part of the data |
---|
[733] | 521 | set_range - set a 'zoom' window [xmin,xmax,ymin,ymax] |
---|
[255] | 522 | set_legend - specify user labels for the legend indeces |
---|
| 523 | set_title - specify user labels for the panel indeces |
---|
[733] | 524 | set_abcissa - specify a user label for the abcissa |
---|
[255] | 525 | set_ordinate - specify a user label for the ordinate |
---|
[378] | 526 | set_layout - specify the multi-panel layout (rows,cols) |
---|
[733] | 527 | set_colors - specify a set of colours to use |
---|
| 528 | set_linestyles - specify a set of linestyles to use if only |
---|
| 529 | using one color |
---|
[1151] | 530 | set_font - set general font properties, e.g. 'family' |
---|
[1054] | 531 | set_histogram - plot in historam style |
---|
[733] | 532 | set_mask - set a plotting mask for a specific polarization |
---|
[1171] | 533 | text - draw text annotations either in data or relative |
---|
| 534 | coordinates |
---|
| 535 | arrow - draw arrow annotations either in data or relative |
---|
| 536 | coordinates |
---|
| 537 | axhline,axvline - draw horizontal/vertical lines |
---|
| 538 | axhspan,axvspan - draw horizontal/vertical regions |
---|
[1175] | 539 | |
---|
| 540 | xyplotter - matplotlib/pylab plotting functions |
---|
| 541 | |
---|
[182] | 542 | [Reading files] |
---|
| 543 | reader - access rpfits/sdfits files |
---|
[984] | 544 | open - attach reader to a file |
---|
| 545 | close - detach reader from file |
---|
[182] | 546 | read - read in integrations |
---|
| 547 | summary - list info about all integrations |
---|
| 548 | |
---|
[113] | 549 | [General] |
---|
| 550 | commands - this command |
---|
| 551 | print - print details about a variable |
---|
| 552 | list_scans - list all scantables created bt the user |
---|
[992] | 553 | list_files - list all files readable by asap (default rpf) |
---|
[113] | 554 | del - delete the given variable from memory |
---|
| 555 | range - create a list of values, e.g. |
---|
| 556 | range(3) = [0,1,2], range(2,5) = [2,3,4] |
---|
| 557 | help - print help for one of the listed functions |
---|
| 558 | execfile - execute an asap script, e.g. execfile('myscript') |
---|
[255] | 559 | list_rcparameters - print out a list of possible values to be |
---|
[274] | 560 | put into $HOME/.asaprc |
---|
[1171] | 561 | rc - set rc parameters from within asap |
---|
[466] | 562 | mask_and,mask_or, |
---|
| 563 | mask_not - boolean operations on masks created with |
---|
| 564 | scantable.create_mask |
---|
[706] | 565 | |
---|
[210] | 566 | Note: |
---|
| 567 | How to use this with help: |
---|
| 568 | # function 'summary' |
---|
| 569 | [xxx] is just a category |
---|
| 570 | Every 'sub-level' in this list should be replaces by a '.' Period when |
---|
[706] | 571 | using help |
---|
[210] | 572 | Example: |
---|
| 573 | ASAP> help scantable # to get info on ths scantable |
---|
| 574 | ASAP> help scantable.summary # to get help on the scantable's |
---|
| 575 | ASAP> help average_time |
---|
| 576 | |
---|
[715] | 577 | """ |
---|
[1151] | 578 | if rcParams['verbose']: |
---|
| 579 | try: |
---|
| 580 | from IPython.genutils import page as pager |
---|
| 581 | except ImportError: |
---|
| 582 | from pydoc import pager |
---|
| 583 | pager(x) |
---|
| 584 | else: |
---|
| 585 | print x |
---|
[715] | 586 | return |
---|
[113] | 587 | |
---|
[706] | 588 | def welcome(): |
---|
| 589 | return """Welcome to ASAP v%s (%s) - the ATNF Spectral Analysis Package |
---|
[100] | 590 | |
---|
[1035] | 591 | Please report any bugs via: |
---|
| 592 | http://sourcecode.atnf.csiro.au/cgi-bin/trac_asap.cgi/newticket |
---|
[100] | 593 | |
---|
[378] | 594 | [IMPORTANT: ASAP is 0-based] |
---|
[706] | 595 | Type commands() to get a list of all available ASAP commands.""" % (__version__, __date__) |
---|