asap

Package asap

[show private | hide private]

Package asap

This is the ATNF Single Dish Analysis package.

Submodules

Submodules
`asapfit` `asapfitter` `asaplinefind` `asaplot`: ASAP plotting class based on matplotlib. `asaplotbase`: ASAP plotting class based on matplotlib. `asaplotgui`: ASAP plotting class based on matplotlib. `asaplotgui_gtk`: ASAP plotting class based on matplotlib. `asapmath` `asapplotter` `asapreader` `linecatalog`: A representation of a spectra line catalog. `scantable` `selector`

asapfit
asapfitter
asaplinefind
asaplot: ASAP plotting class based on matplotlib.
asaplotbase: ASAP plotting class based on matplotlib.
asaplotgui: ASAP plotting class based on matplotlib.
asaplotgui_gtk: ASAP plotting class based on matplotlib.
asapmath
asapplotter
asapreader
linecatalog: A representation of a spectra line catalog.
scantable
selector

Function Summary
	`is_ipython()`
	`list_files(path, suffix)` Return a list files readable by asap, such as rpf, sdfits, mbf, asap...
	`list_rcparameters()`
	`mask_and(a, b)`
	`mask_not(a)`
	`mask_or(a, b)`
	`print_log()`
	`rc(group, **kwargs)` Set the current rc params.
	`rc_params()` Return the default params updated from the values in the rc file
	`rcdefaults()` Restore the default rc params - the ones that were created at asap load time
	`unique(x)` Return the unique values in a list...
	`welcome()`
	`_asap_fname()` Return the path to the rc file...
	`_is_sequence_or_number(param, ptype)`
	`_n_bools(n, val)`
	`_to_list(param, ptype)`
	`_validate_bool(b)` Convert b to a boolean or raise
	`_validate_int(s)` convert s to int or raise

Variable Summary
`str`	`__date__` = `'2007-05-02'`
`str`	`__version__` = `'2.2.0'`
`Log`	`asaplog` = `<asap._asap.Log object at 0x401fe3c4>`
`dict`	`defaultParams` = `{'scantable.verbosesummary': [False, <fu...`
`str`	`plf` = `'linux_gnu'`
`dict`	`rcParams` = `{'scantable.verbosesummary': False, 'scantabl...`

Function Details

list_files(path='.', suffix='rpf')

Return a list files readable by asap, such as rpf, sdfits, mbf, asap
Parameters:
    path:     The directory to list (default '.')
    suffix:   The file extension (default rpf)
Example:
    files = list_files("data/","sdfits")
    print files
    ['data/2001-09-01_0332_P363.sdfits',
    'data/2003-04-04_131152_t0002.sdfits',
    'data/Sgr_86p262_best_SPC.sdfits']

rc(group, **kwargs)

Set the current rc params.  Group is the grouping for the rc, eg
for scantable.save the group is 'scantable', for plotter.stacking, the
group is 'plotter', and so on.  kwargs is a list of attribute
name/value pairs, eg

  rc('scantable', save='SDFITS')

sets the current rc params and is equivalent to

  rcParams['scantable.save'] = 'SDFITS'

Use rcdefaults to restore the default rc params after changes.

rc_params()

Return the default params updated from the values in the rc file

rcdefaults()

Restore the default rc params - the ones that were created at asap load time

unique(x)

Return the unique values in a list
Parameters:
    x:      the list to reduce
Examples:
    x = [1,2,3,3,4]
    print unique(x)
    [1,2,3,4]

_asap_fname()

Return the path to the rc file

Search order:

 * current working dir
 * environ var ASAPRC
 * HOME/.asaprc

_validate_bool(b)

Convert b to a boolean or raise

_validate_int(s)

convert s to int or raise

Variable Details

date

Type:: str
Value:: '2007-05-02'

version

Type:: str
Value:: '2.2.0'

asaplog

Type:: Log
Value:: <asap._asap.Log object at 0x401fe3c4>

defaultParams

Type:: dict
Value:: {'insitu': [True, <function _validate_bool at 0x401f74fc>], 'plotter.colours': ['', <type 'str'>], 'plotter.decimate': [False, <function _validate_bool at 0x401f74fc>], 'plotter.ganged': [True, <function _validate_bool at 0x401f74fc>], 'plotter.gui': [True, <function _validate_bool at 0x401f74fc>], 'plotter.histogram': [False, <function _validate_bool at 0x401f74fc>]\ , 'plotter.linestyles': ['', <type 'str'>], ...

plf

Type:: str
Value:: 'linux_gnu'

rcParams

Type:: dict
Value:: {'insitu': True, 'plotter.colours': '', 'plotter.decimate': False, 'plotter.ganged': True, 'plotter.gui': True, 'plotter.histogram': False, 'plotter.linestyles': '', 'plotter.panelling': 's', ...

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

http://epydoc.sf.net