asap.parameters Namespace Reference

Functions
def	_validate_bool
def	_validate_int
def	_asap_fname
def	list_rcparameters
def	rc_params
def	rc
def	rcdefaults
Variables
list	__all__
dictionary	defaultParams
tuple	rcParams
tuple	rcParamsDefault

---

Detailed Description

This module provides functions to set up resource parameters (rc).
These can be set in a file .asaprc or using functions.

---

Function Documentation

def asap.parameters._asap_fname

(

)

[private]

Return the path to the rc file

Search order:

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

Definition at line 22 of file parameters.py.

Referenced by asap.parameters.rc_params().

def asap.parameters._validate_bool

(

b

)

[private]

Definition at line 8 of file parameters.py.

def asap.parameters._validate_int

(

s

)

[private]

Definition at line 16 of file parameters.py.

def asap.parameters.list_rcparameters

(

)

Definition at line 83 of file parameters.py.

def asap.parameters.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.

Definition at line 217 of file parameters.py.

def asap.parameters.rc_params

(

)

Definition at line 159 of file parameters.py.

References asap.parameters._asap_fname(), and sdtpimaging_regression.file.

def asap.parameters.rcdefaults

(

)

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

Definition at line 247 of file parameters.py.

---

Variable Documentation

list asap.parameters.__all__

Definition at line 4 of file parameters.py.

dictionary asap.parameters.defaultParams

Definition at line 51 of file parameters.py.

tuple asap.parameters.rcParams

Definition at line 213 of file parameters.py.

tuple asap.parameters.rcParamsDefault

Definition at line 215 of file parameters.py.