Parameter management

Utility functions to work with Parameter object

pymodaq_gui.parameter.utils.get_param_from_name(parent, name) → Parameter

Get Parameter under parent whose name is name

Parameters:

• parent (Parameter) –

• name (str) –

Return type:

Parameter

pymodaq_gui.parameter.utils.get_param_path(param: Parameter) → List[str]

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_gui.parameter.utils.iter_children(param, childlist=[], filter_type=(), filter_name=(), select_filter=False) → list

Get a list of parameters’ name under a given Parameter (see iter_children_params)

Returns:

The list of the children name from the given node.

Return type:

list

pymodaq_gui.parameter.utils.iter_children_params(param, childlist=[], output_type=None, filter_type=(), filter_name=(), select_filter=False) → list

Get a list of parameters under a given Parameter.

Parameters:

• param (Parameter (pyqtgraph)) – the root node to be coursed

• childlist (list) – the child/output list

• output_type (str) – the attribute of parameter that will be added to the output list

• filter_type (list) – filter children sharing those types

• filter_name (list) – filter children sharing those names

• select_filter (bool) – if True, add filtered parameters to output list. if False (default), add non-filtered parameter to output list.

Returns:

The list of the children from the given node.

Return type:

list