7.4.8.3. Parameter management

Utility functions to work with Parameter object

pymodaq.utils.parameter.utils.get_param_from_name(parent, name) Parameter[source]

Get Parameter under parent whose name is name

Parameters:
  • parent (Parameter) –

  • name (str) –

Return type:

Parameter

pymodaq.utils.parameter.utils.get_param_path(param: Parameter) List[str][source]

Get the parameter path from its highest parent down to the given parameter including its identifier (name)

Parameters:

param (Parameter) – The parameter object

Returns:

List[str]

Return type:

the path as a list of parameter identifiers

pymodaq.utils.parameter.utils.iter_children(param, childlist=[])[source]

Get a list of parameters name under a given Parameter | Returns all childrens names.

Parameters

Type

Description

param

instance of pyqtgraph parameter

the root node to be coursed

childlist

list

the child list recetion structure

Returns:

childlist – The list of the children from the given node.

Return type:

parameter list

pymodaq.utils.parameter.utils.iter_children_params(param, childlist=[])[source]

Get a list of parameters under a given Parameter