8.4.7.3. Parameter management

Utility functions to work with Parameter object

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

Get Parameter under parent whose name is name

Parameters:

• parent (Parameter)

• name (str)

Returns:

The first parameter found (depth first), None if there is none

Return type:

Optional[Parameter]

pymodaq_gui.parameter.utils.get_param_path(param)

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:

List[str]

pymodaq_gui.parameter.utils.iter_children(param, childlist=None, filter_type=(), filter_name=(), select_filter=False)

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=None, output_type=None, filter_type=(), filter_name=(), select_filter=False)

Get a list of parameters under a given Parameter.

Parameters:

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

• childlist (Optional[list]) – the child/output list, the results are appended to it. A new list is used if None

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

• filter_type (Iterable[str]) – filter children sharing those types

• filter_name (Iterable[str]) – 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