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