Module azcam.tools.parameters
Parameter handling tool for azcam.
Classes
class Parameters (default_dictname: str = None)
-
Main class for parameters tool.
Creates parameters tool, optionally setting default parameter dictionary name.
Ancestors
Instance variables
var description
-
Inherited from:
Tools
.description
descriptive tool name
var enabled
-
1 when tool is enabled
var initialized
-
Inherited from:
Tools
.initialized
1 when tool has been initialized
var is_reset
-
Inherited from:
Tools
.is_reset
1 when tool has been reset
var tool_id
-
name used to reference the tool ("controller", "display", …)
var verbosity
-
Inherited from:
Tools
.verbosity
verbosity for debug, >0 is more verbose
Methods
def get_par(self, parameter: str) ‑> Any
-
Return the value of a parameter in the parameters dictionary.
Args
parameter
:str
- name of the parameter
Returns
value (Any): value of the parameter
def get_script_par(self, par_dict_id: Dict, attribute: Any, value: Any = 'default', prompt_string: str = '', default: Any = None) ‑> Any
-
Return a parameter from the par_dict database, or prompt as needed. The new value is saved in the database.
:param str par_dict_id: Parameter dictionary name of in parameters.par_dict :param str attribute: Name of attribute, used as dictionary key :param str value: "default" or "prompt" or a value :param str prompt: Prompt message :param str default: Default value to be used :return str: parameter
def initialize(self) ‑> None
-
Inherited from:
Tools
.initialize
Initialize the tool.
def read_parfile(self, parfilename: str = None) ‑> None
-
Read a parameter file and create sub-dictionaries for saving parameters between sessions.
Args
parfilename
- Name of parameter file
def reset(self) ‑> None
-
Reset the tool.
def save_pars(self) ‑> None
-
Save the current parameter set.
def set_par(self, parameter: str, value: Any = None) ‑> None
-
Set the value of a parameter in the parameters dictionary.
Args
parameter
:str
- name of the parameter
value
:Any
- value of the parameter. Defaults to None.
Returns
None
def set_script_par(self, par_dict_id, attribute, value) ‑> None
-
Set a parameter from the par_dict database.
:param str par_dict_id: Parameter dictionary :param str attribute: Name of attribute, used as dictionary key :param str value: "default" or "prompt" or a value :return: None
def update_pars(self, write, par_dictname: str = None) ‑> None
-
Update azcam parameters to/from a config dictionary. write True => write values into dictionary. write False => set values from dictionary.
def write_parfile(self, parfilename: str = None) ‑> None
-
Update a parameter file with current values.
Args
parfilename
:str
, optional- Name of parameter file. Defaults to None. None indicates use self.par_file
Raises
FileNotFoundError
- if parfilename not found