Module azcam.parameters

Parameter handling tool for azcam.

There is one main paramater dictionary with multiple subdicts. A default subdict can be specified.

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

Inherited from: Tools.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

Inherited from: Tools.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, subdict=None) ‑> Any

Return the current value of a parameter in the parameters dictionary. If subdict is not specified then the default subdict is used.

Args

parameter : str
name of the parameter
subdict : str
name of the subdict containing the parameter

Returns

value (Any): value of the 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

Inherited from: Tools.reset

Reset the tool.

def restore_imagepars(self, imagepars: dict) ‑> None

Restore image parameters from dictionary.

Args

imagepars
dictionary set with save_imagepars().
def save_imagepars(self, imagepars={}) ‑> None

Save current image parameters. imagepars is a dictionary.

Args

imagepars
dict of azcam.db.imageparnames names to save
def save_pars(self) ‑> None

Writes the par_dict to the par_file using current values.

def set_par(self, parameter: str, value: Any = 'None', subdict=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.
subdict
subdict in which to set paramater

Returns

None

def update_par_dict(self, par_dictname: str = None) ‑> None

Set par_dict values from current attributes.

def update_pars(self, par_dictname: str = None) ‑> None

Set current attributes from par_dict values.

def write_parfile(self, parfilename: str = None) ‑> None

Writes par_dict to the par file. Does nto update any values.

Args

parfilename : str, optional
Name of parameter file. Defaults to None. None indicates use self.par_file

Raises

FileNotFoundError
if parfilename not found