Package pyraf :: Module irafpar :: Class IrafParList
[hide private]
[frames] | no frames]

Class IrafParList

source code

List of Iraf parameters

Instance Methods [hide private]
 
__init__(self, taskname, filename="", parlist=None)
Create a parameter list for task taskname
source code
 
Update(self)
Check to make sure this list is in sync with parameter file
source code
 
setFilename(self, filename)
Change filename and create ParCache object
source code
 
__addPsetParams(self)
Merge pset parameters into the parameter lists
source code
 
addParam(self, p)
Add a parameter to the list
source code
 
isConsistent(self, other)
Compare two IrafParLists for consistency
source code
 
_getConsistentList(self)
Return simplified parameter dictionary used for consistency check
source code
 
clearFlags(self)
Clear all status flags for all parameters
source code
 
setAllFlags(self)
Set all status flags to indicate parameters were set on cmdline
source code
 
__getattr__(self, name) source code
 
__setattr__(self, name, value) source code
 
__len__(self) source code
 
hasPar(self, param)
Test existence of parameter named param
source code
 
getFilename(self) source code
 
getParList(self, docopy=0) source code
 
getParDict(self) source code
 
getParObject(self, param) source code
 
getAllMatches(self, param)
Return list of all parameter names that may match param
source code
 
getValue(self, param, native=0, prompt=1, mode="h")
Return value for task parameter 'param' (with min-match)
source code
 
setParam(self, param, value)
Set task parameter 'param' to value (with minimum-matching)
source code
 
setParList(self, *args, **kw)
Set value of multiple parameters from list
source code
 
eParam(self) source code
 
tParam(self) source code
 
lParam(self, verbose=0)
List the task parameters
source code
 
dParam(self, taskname="", cl=1)
Dump the task parameters in executable form
source code
 
saveParList(self, filename=None)
Write .par file data to filename (string or filehandle)
source code
 
__getinitargs__(self)
Return parameters for __init__ call in pickle
source code
 
__getstate__(self)
Return additional state for pickle
source code
 
__setstate__(self, state)
Restore additional state from pickle
source code
 
__str__(self) source code
 
getDefaultParList(self) source code
 
getName(self) source code
 
getPkgname(self) source code
 
run(self, *args, **kw) source code
Method Details [hide private]

__init__(self, taskname, filename="", parlist=None)
(Constructor)

source code 

Create a parameter list for task taskname

If parlist is specified, uses it as a list of IrafPar objects. Else if filename is specified, reads a .par file. If neither is specified, generates a default list.

setFilename(self, filename)

source code 

Change filename and create ParCache object

Retains current parameter values until an unlearn is done

isConsistent(self, other)

source code 

Compare two IrafParLists for consistency

Returns true if lists are consistent, false if inconsistent. Only checks immutable param characteristics (name & type). Allows hidden parameters to be in any order, but requires non-hidden parameters to be in identical order.

_getConsistentList(self)

source code 

Return simplified parameter dictionary used for consistency check

Dictionary is keyed by param name, with value of type and (for non-hidden parameters) sequence number.

getValue(self, param, native=0, prompt=1, mode="h")

source code 

Return value for task parameter 'param' (with min-match)

If native is non-zero, returns native format for value. Default is to return a string. If prompt is zero, does not prompt for parameter. Default is to prompt for query parameters.

dParam(self, taskname="", cl=1)

source code 

Dump the task parameters in executable form

Default is to write CL version of code; if cl parameter is false, writes Python executable code instead.